help files 0.5.6

Author: Nelson-numerical-software

en/README.md

@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.5.5.0
+### Nelson 0.5.6.0
 
 This is an pre-release of Nelson.
 

en/SUMMARY.md

@@ -42,7 +42,9 @@
     * [maxNumCompThreads](./core/maxNumCompThreads.md)
     * [namelengthmax](./core/namelengthmax.md)
     * [nargin](./core/nargin.md)
+    * [narginchk](./core/narginchk.md)
     * [nargout](./core/nargout.md)
+    * [nargoutchk](./core/nargoutchk.md)
     * [nelsonroot](./core/nelsonroot.md)
     * [nfilename](./core/nfilename.md)
     * [pause](./core/pause.md)
@@ -191,7 +193,6 @@
     * [isequalto](./elementary_functions/isequalto.md)
     * [isfinite](./elementary_functions/isfinite.md)
     * [isinf](./elementary_functions/isinf.md)
-    * [ismissing](./elementary_functions/ismissing.md)
     * [isnan](./elementary_functions/isnan.md)
     * [istril](./elementary_functions/istril.md)
     * [istriu](./elementary_functions/istriu.md)
@@ -204,30 +205,34 @@
     * [log2](./elementary_functions/log2.md)
     * [logspace](./elementary_functions/logspace.md)
     * [magic](./elementary_functions/magic.md)
-    * [max](./elementary_functions/max.md)
-    * [min](./elementary_functions/min.md)
     * [minus](./elementary_functions/minus.md)
     * [mod](./elementary_functions/mod.md)
     * [ndims](./elementary_functions/ndims.md)
     * [norm](./elementary_functions/norm.md)
     * [num2bin](./elementary_functions/num2bin.md)
     * [numel](./elementary_functions/numel.md)
-    * [prod](./elementary_functions/prod.md)
     * [real](./elementary_functions/real.md)
     * [rem](./elementary_functions/rem.md)
     * [repmat](./elementary_functions/repmat.md)
     * [reshape](./elementary_functions/reshape.md)
     * [round](./elementary_functions/round.md)
     * [sign](./elementary_functions/sign.md)
     * [size](./elementary_functions/size.md)
-    * [sort](./elementary_functions/sort.md)
     * [sqrt](./elementary_functions/sqrt.md)
-    * [sum](./elementary_functions/sum.md)
     * [swapbytes](./elementary_functions/swapbytes.md)
     * [tril](./elementary_functions/tril.md)
     * [triu](./elementary_functions/triu.md)
 
 
+* [data_analysis](./data_analysis/README.md)
+    * [ismissing](./data_analysis/ismissing.md)
+    * [max](./data_analysis/max.md)
+    * [min](./data_analysis/min.md)
+    * [prod](./data_analysis/prod.md)
+    * [sort](./data_analysis/sort.md)
+    * [sum](./data_analysis/sum.md)
+
+
 * [special_functions](./special_functions/README.md)
     * [betainc](./special_functions/betainc.md)
     * [gamma](./special_functions/gamma.md)

en/changelogs/CHANGELOG-0.2.x.md

@@ -212,14 +212,14 @@ HDF5 high-level functions:
 
     - dlgeneratemake: generates a makefile for building a dynamic library.
     - dlgeneratecleaner: generates cleaner.nls file for C++ gateway.
-    - dlgenerateloader: generates loader.nls file for C++ gateway.
-    - dlgenerateunloader: generates unloader.nls file for C++ gateway.
+    - dlgenerateloader: generates loader.m file for C++ gateway.
+    - dlgenerateunloader: generates unloader.m file for C++ gateway.
     - dlgenerategateway: generates C++ gateway.
     - findcmake: find CMake path.
     - cmake function: call CMake tool.
     - dlmake: call make or nmake tool.
 
-  - detect and configure C/C++ compilers on Windows, Linux, MacosX:
+  - detect and configure C/C++ compilers on Windows, Linux, MacOS:
 
     - On Windows:
 

en/changelogs/CHANGELOG-0.3.x.md

@@ -269,7 +269,7 @@
 - Licensing change: Nelson is now released under the terms of the GNU Lesser General Public License (LGPL) v2.1.
   It is still also available under the terms of the GNU General Public License (GPL) v2.0.
 
-  You can build Nelson under LGPL v2.1 license on Unix/MacosX with
+  You can build Nelson under LGPL v2.1 license on Unix/MacOS with
 
   ```bash
   cd nelson

en/changelogs/CHANGELOG.md

@@ -1,3 +1,43 @@
+# 0.5.6 (2021-06-27)
+
+BREAKING CHANGE:
+
+## Features:
+
+- `function ... endfunction` and `function ... end` are equivalent (increase compatibility ;).
+
+- file extension `.m` is managed by Nelson.
+
+  - About compatibility: scripts and functions developed with Nelson should work with other tools managing .m files. The reciprocal is not necessarily true.
+
+  - `.m` is default and alone file extension.
+
+- module skeleton updated to use to `.m` extension (Please update your code)
+
+- `run` builtin can also evaluate a macro function.
+
+- macro functions also searched in current directory.
+
+- parser cleaned and generated with Bison 3.7.4
+
+- `narginchk` builtin: checks number of input arguments.
+
+- `nargoutchk` builtin: checks number of outnput arguments.
+
+- [#448](http://github.com/Nelson-numerical-software/nelson/issues/448): data analysis module (Code refactoring).
+
+## Bug Fixes:
+
+- `nmm('install', existing_module_directory)` did not work as expected.
+
+- [#451](http://github.com/Nelson-numerical-software/nelson/issues/451): var() returns an unexpected error.
+
+## Compilation:
+
+- [#455](http://github.com/Nelson-numerical-software/nelson/issues/455): M1 macOS apple native support. It works but some gui features can crash due to young Qt support on M1.
+
+- Update fmt library to 8.0.
+
 # 0.5.5 (2021-05-24)
 
 ## Features:

en/core/README.md

@@ -21,13 +21,15 @@ core functions
 * [maxNumCompThreads](maxNumCompThreads.md) - Set/Get maximum number of computional threads.
 * [namelengthmax](namelengthmax.md) - Return the maximum variable name length.
 * [nargin](nargin.md) - Returns the number of input arguments.
+* [narginchk](narginchk.md) - Checks the number of input arguments.
 * [nargout](nargout.md) - Returns the number of output arguments.
+* [nargoutchk](nargoutchk.md) - Checks the number of output arguments.
 * [nelsonroot](nelsonroot.md) - Returns Nelson's root folder.
 * [nfilename](nfilename.md) - Returns the name of the currently executing file.
 * [pause](pause.md) - Pauses script execution.
 * [prefdir](prefdir.md) - Return the preferences directory used by Nelson.
 * [quit](quit.md) - Terminate Nelson application
-* [run](run.md) - Executes a script file (.nls).
+* [run](run.md) - Executes a script file (.m).
 * [sha256](sha256.md) - Get sha256 checksum.
 * [version](version.md) - Return the version of Nelson.
 

en/core/SUMMARY.md

@@ -12,7 +12,9 @@
     * [maxNumCompThreads](maxNumCompThreads.md)
     * [namelengthmax](namelengthmax.md)
     * [nargin](nargin.md)
+    * [narginchk](narginchk.md)
     * [nargout](nargout.md)
+    * [nargoutchk](nargoutchk.md)
     * [nelsonroot](nelsonroot.md)
     * [nfilename](nfilename.md)
     * [pause](pause.md)

en/core/narginchk.md

@@ -0,0 +1,44 @@
+
+
+# narginchk
+
+Checks the number of input arguments.
+
+## Syntax
+
+- narginchk(minArgs, maxArgs)
+
+## Input argument
+
+ - minArgs - minimum number of accepted inputs (scalar integer value).
+ - maxArgs - maximum number of accepted inputs (scalar integer value).
+
+## Description
+
+
+  <p><b>narginchk</b> checks the number of input arguments of an function.</p>
+
+
+## Example
+
+With an macro function:
+```matlab
+narginchk(1, 2)
+```
+
+## See also
+
+[nargin](nargin.md), [nargoutchk](nargoutchk.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+

en/core/nargoutchk.md

@@ -0,0 +1,53 @@
+
+
+# nargoutchk
+
+Checks the number of output arguments.
+
+## Syntax
+
+- nargoutchk(minArgs, maxArgs)
+- msg = nargoutchk(minArgs, maxArgs, numArgs)
+- st = nargoutchk(minArgs, maxArgs, numArgs, 'struct')
+
+## Input argument
+
+ - minArgs - minimum number of accepted outputs (scalar integer value).
+ - maxArgs - maximum number of accepted outputs (scalar integer value).
+ - numArgs - number of function outputs (scalar integer value).
+
+## Output argument
+
+ - msg - a string: error message.
+ - st - a struct with error message and identifier.
+
+## Description
+
+
+  <p><b>nargoutchk</b> checks the number of output arguments of an function.</p>
+
+
+## Example
+
+With an macro function:
+```matlab
+nargoutchk(1, 2, 3)
+nargoutchk(1, 2, 3, 'struct')
+```
+
+## See also
+
+[nargout](nargin.md), [narginchk](nargoutchk.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+

en/core/nfilename.md

@@ -2,6 +2,8 @@
 
 # nfilename
 
+# mfilename
+
 Returns the name of the currently executing file.
 
 ## Syntax
@@ -21,6 +23,7 @@ Returns the name of the currently executing file.
   <p><b>nfilename()</b> called from outside an nlf file returns an empty string.</p>
   <p>With the input argument 'fullpathext', the string includes the directory part of the macro filename, and the filename extension.</p>
   <p>With the input argument 'fullpath', the string includes the directory part of the macro filename, but not the extension.</p>
+  <p><b>mfilename</b> is an alias on <b>nfilename</b> added for basic script compatibility.</p>
 
 
 ## See also