v0.3.4

Nelson-numerical-software · Nelson-numerical-software · commit f61987e25d9e · 2019-04-26T20:32:37.000+02:00
diff --git a/en/README.md b/en/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.3.3.0
+### Nelson 0.3.4.0
 
 This is an pre-release of Nelson.
 
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -72,6 +72,11 @@
     * [dbstack](./debugger/dbstack.md)
 
 
+* [profiler](./profiler/README.md)
+    * [profile](./profiler/profile.md)
+    * [profsave](./profiler/profsave.md)
+
+
 * [error_manager](./error_manager/README.md)
     * [error](./error_manager/error.md)
     * [lasterror](./error_manager/lasterror.md)
@@ -216,6 +221,7 @@
 
 
 * [string](./string/README.md)
+    * [blanks](./string/blanks.md)
     * [char](./string/char.md)
     * [contains](./string/contains.md)
     * [convertCharsToStrings](./string/convertCharsToStrings.md)
@@ -298,7 +304,7 @@
 * [function_handle](./function_handle/README.md)
     * [func2str](./function_handle/func2str.md)
     * [isfunction_handle](./function_handle/isfunction_handle.md)
-    * [func2str](./function_handle/str2func.md)
+    * [str2func](./function_handle/str2func.md)
 
 
 * [handle](./handle/README.md)
diff --git a/en/changelogs/CHANGELOG.md b/en/changelogs/CHANGELOG.md
@@ -1,3 +1,42 @@
+# 0.3.4  (2019-04-27)
+
+Features:
+---------
+
+* Coverage and Profiling Tools for Nelson's language:
+
+  - profile function: Profile execution time for functions
+  - profsave function: Save profile report in HTML format
+
+* blanks builtin: creates an string of blank characters.
+
+* .nh5 files have an header to identify it easily.
+
+* isnh5file, ismatfile extended to return header string.
+
+Bug Fixes:
+---------
+
+  * [#193](http://github.com/Nelson-numerical-software/nelson/issues/193): func2str help was wrong.
+
+
+Compilation:
+------------
+
+* MATIO 1.5.15
+
+  Thanks to MAT file I/O library (MATIO) to provide an easy support for MAT-file.
+
+* more 100 warnings fixed (Thanks to PVS-Studio analyzer and also Cppcheck).
+
+* .editorconfig file added.
+
+* Visual studio 15.9.11
+
+* Qt 5.12.2 on Windows
+
+
+
 # 0.3.3  (2019-03-21)
 
 Features:
diff --git a/en/function_handle/README.md b/en/function_handle/README.md
@@ -10,7 +10,7 @@ function_handle functions
 
 * [func2str](func2str.md) - Return a function handle constructed from a string.
 * [isfunction_handle](isfunction_handle.md) - Checks if value is a function handle.
-* [func2str](str2func.md) - Returns a string from function handle.
+* [str2func](str2func.md) - Returns a function handle from a string.
 
 
 
diff --git a/en/function_handle/SUMMARY.md b/en/function_handle/SUMMARY.md
@@ -1,5 +1,5 @@
 * [function_handle](README.md)
     * [func2str](func2str.md)
     * [isfunction_handle](isfunction_handle.md)
-    * [func2str](str2func.md)
+    * [str2func](str2func.md)
 
diff --git a/en/function_handle/str2func.md b/en/function_handle/str2func.md
@@ -1,25 +1,25 @@
 
 
-# func2str
+# str2func
 
-Returns a string from function handle.
+Returns a function handle from a string.
 
 ## Syntax
 
-- str = func2str(func_handle)
+- func_handle = str2func(str)
 
 ## Input argument
 
- - func_handle - a function handle.
+ - str - a string
 
 ## Output argument
 
- - str - a string
+ - func_handle - a function handle.
 
 ## Description
 
 
-  <p><b>str = func2str(function_handle)</b> returns a string <b>str</b> that holds the name of the function to which the function handle is associated.</p>
+  <p><b>function_handle = str2func(str)</b> returns a function handle <b>function_handle</b> for the function named in the string <b>str</b></p>
 
 
 ## Example
@@ -31,7 +31,7 @@ str = func2str(fh)
 
 ## See also
 
-[str2func](str2func.md), [isfunction_handle](isfunction_handle.md).
+[func2str](func2str.md), [isfunction_handle](isfunction_handle.md).
 ## History
 
 |Version|Description|
diff --git a/en/hdf5/isnh5file.md b/en/hdf5/isnh5file.md
@@ -7,6 +7,7 @@ Checks if filename a valid .nh5 file
 ## Syntax
 
 - tf = isnh5file(filename)
+- [tf, version, header] = isnh5file(filename)
 
 ## Input argument
 
@@ -15,6 +16,8 @@ Checks if filename a valid .nh5 file
 ## Output argument
 
  - tf - a logical: true if it is a valid .nh5 file.
+ - version - a string array: "-v1" or "" if it is undefined.
+ - header - a string array: header of nh5 file (date created).
 
 ## Description
 
@@ -29,7 +32,7 @@ A = ones(3, 4);
 savemat([tempdir(), '/example_isnh5.mat'], 'A')
 R = isnh5file([tempdir(), '/example_isnh5.mat'])
 h5save([tempdir(), '/example_isnh5.nh5'], 'A')
-R = isnh5file([tempdir(), '/example_isnh5.nh5'])
+[R, VER, HE] = isnh5file([tempdir(), '/example_isnh5.nh5'])
 ```
 
 ## See also
diff --git a/en/matio/ismatfile.md b/en/matio/ismatfile.md
@@ -6,7 +6,7 @@ Checks if filename a valid .mat file
 
 ## Syntax
 
-- [tf, ver] = ismatfile(filename)
+- [tf, ver, header] = ismatfile(filename)
 
 ## Input argument
 
@@ -15,7 +15,8 @@ Checks if filename a valid .mat file
 ## Output argument
 
  - tf - a logical: true if it is a valid .mat file.
- - ver - a string: version of .mat file ("-v7.3", "-v7" or "-v6").
+ - ver - a string array: version of .mat file ("-v7.3", "-v7" or "-v6").
+ - header - a string array: header of .mat file (date).
 
 ## Description
 
@@ -37,7 +38,7 @@ savemat([tempdir(), '/example_loadmat-v6.mat'], 'A', '-v6')
 [tf, ver] = ismatfile([tempdir(), '/example_loadmat-v7.3.mat']) 
 [tf, ver] = ismatfile([tempdir(), '/example_loadmat-v7.mat']) 
 [tf, ver] = ismatfile([tempdir(), '/example_loadmat-v6.mat']) 
-[tf, ver] = ismatfile([tempdir(), '/example_not_existing.mat'])
+[tf, ver, header] = ismatfile([tempdir(), '/example_not_existing.mat'])
 ```
 
 ## See also
diff --git a/en/profiler/README.md b/en/profiler/README.md
@@ -0,0 +1,15 @@
+
+
+# Profiling tools
+
+Profiling tools
+
+## Description
+Profile to Improve Performance
+
+
+* [profile](profile.md) - Profile execution time for Macro functions.
+* [profsave](profsave.md) - Save profile result to HTML format.
+
+
+
diff --git a/en/profiler/SUMMARY.md b/en/profiler/SUMMARY.md
@@ -0,0 +1,4 @@
+* [profiler](README.md)
+    * [profile](profile.md)
+    * [profsave](profsave.md)
+
diff --git a/en/profiler/profile.md b/en/profiler/profile.md
@@ -0,0 +1,68 @@
+
+
+# profile
+
+Profile execution time for Macro functions.
+
+## Syntax
+
+- profile on
+- profile off
+- profile resume
+- profile clear
+- status = profile('status')
+- p = profile('info')
+- profile('show', sortOption)
+- profile('show', sortOption, nbLines)
+
+## Input argument
+
+ - sortOption - a string: 'nfl' by name file line, 'line' by line, 'percalls', 'totaltime', 'filename', 'function' or 'nbcalls'.
+ - nbLines - a integer value: number of lines to display.
+
+## Description
+
+
+  <p>Profiling is a way to measure where Macro function spend times.</p>
+  <p><b>s = profile('status')</b> returns a structure with the current status of the profiler.</p>
+  <p><b>p = profile('info')</b> returns a structure with collected profiling data.</p>
+  <p><b>profile('on')</b> starts profiler.</p>
+  <p><b>profile('off')</b> stops profiler. Collected profiling data will be retrieved later with <b>p = profile ('info')</b>.</p>
+  <p><b>profile('clear')</b> clears collected profiling data.</p>
+  <p><b>profile('resume')</b> restarts and continue and extends collected profiling data.</p>
+
+
+## Examples
+
+```matlab
+profile on
+sind(5)
+profile off
+profile('show')
+profile('show', 'totaltime')
+profile('show', 'totaltime', 4)
+```
+```matlab
+profile on
+sind(5)
+profile off
+profsave(profile('info'), [tempdir(), '/profile_results'])
+unix([tempdir(), '/profile_results/index.html'])
+```
+
+## See also
+
+[profsave](profsave.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/profiler/profsave.md b/en/profiler/profsave.md
@@ -0,0 +1,51 @@
+
+
+# profsave
+
+Save profile result to HTML format.
+
+## Syntax
+
+- profsave
+- profsave(profile_info)
+- profsave(profile_info, dirname)
+
+## Input argument
+
+ - profile_info - a struct: result of profile('info')
+ - dirname - a string: output directory destination.
+
+## Description
+
+
+  <p><b>profsave</b> exports the profiling data into a series of HTML files.</p>
+  <p>The input profile_info is the structure returned by profile('info').</p>
+  <p>If unspecified, <b>profsave</b> will use the current profile.</p>
+
+
+## Example
+
+```matlab
+profile on
+sind(5)
+profile off
+profsave(profile('info'), [tempdir(), '/profile_results'])
+unix([tempdir(), '/profile_results/index.html'])
+```
+
+## See also
+
+[profile](profile.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/string/README.md b/en/string/README.md
@@ -8,6 +8,7 @@ string type
 string type functions
 
 
+* [blanks](blanks.md) - creates an string of blank characters.
 * [char](char.md) - Converts to a character array.
 * [contains](contains.md) - checks if string contains with pattern.
 * [convertCharsToStrings](convertCharsToStrings.md) - Convert chars arrays to string arrays.
diff --git a/en/string/SUMMARY.md b/en/string/SUMMARY.md
@@ -1,4 +1,5 @@
 * [string](README.md)
+    * [blanks](blanks.md)
     * [char](char.md)
     * [contains](contains.md)
     * [convertCharsToStrings](convertCharsToStrings.md)
diff --git a/en/string/blanks.md b/en/string/blanks.md
@@ -0,0 +1,44 @@
+
+
+# blanks
+
+creates an string of blank characters.
+
+## Syntax
+
+- r = blanks(n)
+
+## Input argument
+
+ - n - an value integer, number of blanks.
+
+## Output argument
+
+ - r - a character array with n blanks
+
+## Description
+
+<b>blanks</b> creates an string of blank characters.
+
+## Example
+
+```matlab
+blanks(4)
+```
+
+## See also
+
+[char](char.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/fr/README.md b/fr/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.3.3.0
+### Nelson 0.3.4.0
 
 Ceci est une version alpha de Nelson. 
 
diff --git a/fr/changelogs/CHANGELOG.md b/fr/changelogs/CHANGELOG.md
