help files 0.5.7

Nelson-numerical-software · Nelson-numerical-software · commit deea15e329c1 · 2021-07-25T08:17:26.000+02:00
diff --git a/en/README.md b/en/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.5.6.0
+### Nelson 0.5.7.0
 
 This is an pre-release of Nelson.
 
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -62,6 +62,7 @@
     * [feval](./functions_manager/feval.md)
     * [isbuiltin](./functions_manager/isbuiltin.md)
     * [ismacro](./functions_manager/ismacro.md)
+    * [ismex](./functions_manager/ismex.md)
     * [macroargs](./functions_manager/macroargs.md)
     * [path](./functions_manager/path.md)
     * [rehash](./functions_manager/rehash.md)
@@ -225,6 +226,8 @@
 
 
 * [data_analysis](./data_analysis/README.md)
+    * [conv](./data_analysis/conv.md)
+    * [conv2](./data_analysis/conv2.md)
     * [ismissing](./data_analysis/ismissing.md)
     * [max](./data_analysis/max.md)
     * [min](./data_analysis/min.md)
@@ -836,6 +839,7 @@
     * [mexAtExit](./mex/mexAtExit.md)
     * [mexCallMATLAB](./mex/mexCallMATLAB.md)
     * [mexCallMATLABWithTrap](./mex/mexCallMATLABWithTrap.md)
+    * [mexext](./mex/mexext.md)
 
 
 * [graphics](./graphics/README.md)
diff --git a/en/changelogs/CHANGELOG.md b/en/changelogs/CHANGELOG.md
@@ -1,3 +1,37 @@
+# 0.5.7 (2021-07-24)
+
+## Features:
+
+- macros in memory reworked to support also MEX.
+
+- C MEX compatibility, load and build fully compatible with other softwares.
+
+- `inmem` builtin returns names of functions, MEX-files in memory.
+
+- `mexext` builtin returns binary MEX file-name extension.
+
+- main function in .m no more require to be the first in file.
+
+- checks in the .m function that other local function names are not duplicated.
+
+- .m timestamp checked if `addpath(...,'-frozen')` is not enabled.
+
+- function_handle reworked to have an compatible behavior.
+
+- `struct` behavior with `function_handle`.
+
+- `clear` reworked to support mex in memory.
+
+- `nargin`, `nargout` behavior with mex updated.
+
+- [#474](http://github.com/Nelson-numerical-software/nelson/issues/474): `exist`: extended to manage mex function.
+
+- [#449](http://github.com/Nelson-numerical-software/nelson/issues/449): `conv2`: 2-D convolution and `conv`: Convolution and polynomial multiplication.
+
+## Bug Fixes:
+
+- [#468](http://github.com/Nelson-numerical-software/nelson/issues/468): A(':') = [] was not managed.
+
 # 0.5.6 (2021-06-27)
 
 BREAKING CHANGE:
diff --git a/en/core/exist.md b/en/core/exist.md
@@ -26,6 +26,7 @@ Check for the existence.
   <p><b>0</b> does not exist</p>
   <p><b>1</b> is an variable</p>
   <p><b>2</b> is a file</p>
+  <p><b>3</b> is a mex function</p>
   <p><b>5</b> is a builtin or function</p>
   <p><b>7</b> is a directory</p>
 
diff --git a/en/data_analysis/README.md b/en/data_analysis/README.md
@@ -8,6 +8,8 @@ data analysis
 data analysis
 
 
+* [conv](conv.md) - Convolution and polynomial multiplication.
+* [conv2](conv2.md) - 2-D convolution.
 * [ismissing](ismissing.md) - Check for missing values.
 * [max](max.md) - Maximum elements of an array.
 * [min](min.md) - Minimum elements of an array.
diff --git a/en/data_analysis/SUMMARY.md b/en/data_analysis/SUMMARY.md
@@ -1,4 +1,6 @@
 * [data_analysis](README.md)
+    * [conv](conv.md)
+    * [conv2](conv2.md)
     * [ismissing](ismissing.md)
     * [max](max.md)
     * [min](min.md)
diff --git a/en/data_analysis/conv.md b/en/data_analysis/conv.md
@@ -0,0 +1,51 @@
+
+
+# conv
+
+Convolution and polynomial multiplication.
+
+## Syntax
+
+- C = conv(u, v)
+- C = conv(u, v, shape)
+
+## Input argument
+
+ - u - input vectors, specified as either row or column vectors.
+ - v - input vectors, specified as either row or column vectors.
+ - shape - subsection of convolution: 'full' (default: full 2-D convolution), 'same' (central part of the convolution) or 'valid' (parts of the convolution that are computed without zero-padded edges).
+
+## Output argument
+
+ - C - convolution, returned as a vector or matrix.
+
+## Description
+
+
+  <p><b>conv</b> returns the convolution of vectors <b>u</b> and <b>v</b>.</p>
+
+
+## Example
+
+```matlab
+U = [-1 2 3 -2 0 1 2];
+V = [2 4 -1 1];
+R = conv(U, V, 'same')
+```
+
+## See also
+
+[conv](conv.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/data_analysis/conv2.md b/en/data_analysis/conv2.md
@@ -0,0 +1,55 @@
+
+
+# conv2
+
+2-D convolution.
+
+## Syntax
+
+- C = conv2(A, B)
+- C = conv2(u, v, A)
+- C = conv2(A, B, shape)
+- C = conv2(u, v, A, shape)
+
+## Input argument
+
+ - A - vector or matrix.
+ - B - vector or matrix.
+ - u - row or column vector.
+ - v - row or column vector.
+ - shape - subsection of convolution: 'full' (default: full 2-D convolution), 'same' (central part of the convolution) or 'valid' (parts of the convolution that are computed without zero-padded edges).
+
+## Output argument
+
+ - C - 2-D convolution, returned as a vector or matrix.
+
+## Description
+
+
+  <p><b>conv2</b> returns the two-dimensional convolution.</p>
+
+
+## Example
+
+```matlab
+A = magic(3);
+B = magic(4);
+R = conv2(A, B, 'same')
+```
+
+## See also
+
+[conv](conv.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/functions_manager/README.md b/en/functions_manager/README.md
@@ -14,6 +14,7 @@ functions manager
 * [feval](feval.md) - Evaluates function.
 * [isbuiltin](isbuiltin.md) - Check for the existence of a builtin.
 * [ismacro](ismacro.md) - Check for the existence of a macro (function).
+* [ismex](ismex.md) - Check for the existence of a mex function.
 * [macroargs](macroargs.md) - Returns variables names of a function.
 * [path](path.md) - Modify or display Nelson’s load path.
 * [rehash](rehash.md) - Reinitialize Nelson’s search path directory cache.
diff --git a/en/functions_manager/SUMMARY.md b/en/functions_manager/SUMMARY.md
@@ -5,6 +5,7 @@
     * [feval](feval.md)
     * [isbuiltin](isbuiltin.md)
     * [ismacro](ismacro.md)
+    * [ismex](ismex.md)
     * [macroargs](macroargs.md)
     * [path](path.md)
     * [rehash](rehash.md)
diff --git a/en/functions_manager/ismex.md b/en/functions_manager/ismex.md
@@ -0,0 +1,48 @@
+
+
+# ismex
+
+Check for the existence of a mex function.
+
+## Syntax
+
+- tf = ismex(name)
+
+## Input argument
+
+ - name - a string: mex function name.
+
+## Output argument
+
+ - tf - a logical: true if mex exists.
+
+## Description
+
+
+  <p><b>ismex</b> checks for the existence of a mex function.</p>
+
+
+## Example
+
+```matlab
+ismex('isbuiltin')
+ismex('exist')
+ismex('exist')
+```
+
+## See also
+
+[isbuiltin](isbuiltin.md), [ismacro](ismacro.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/mex/README.md b/en/mex/README.md
@@ -22,6 +22,7 @@ MEX C API is allow to access Nelson, GNU Octave and commercial software function
 * [mexAtExit](mexAtExit.md) - Register a function to be called when the MEX-file is cleared or when Nelson exits
 * [mexCallMATLAB](mexCallMATLAB.md) - Call a NELSON function
 * [mexCallMATLABWithTrap](mexCallMATLABWithTrap.md) - Call a NELSON function and capture error.
+* [mexext](mexext.md) - Binary MEX file-name extension
 
 
 
diff --git a/en/mex/SUMMARY.md b/en/mex/SUMMARY.md
@@ -13,4 +13,5 @@
     * [mexAtExit](mexAtExit.md)
     * [mexCallMATLAB](mexCallMATLAB.md)
     * [mexCallMATLABWithTrap](mexCallMATLABWithTrap.md)
+    * [mexext](mexext.md)
 
diff --git a/en/mex/mexext.md b/en/mex/mexext.md
@@ -0,0 +1,46 @@
+
+
+# mexext
+
+Binary MEX file-name extension
+
+## Syntax
+
+- ext = mexext()
+- extlist = mexext('all')
+
+## Description
+
+
+  <p><b>ext = mexext()</b> returns the filename extension for the current platform.</p>
+  <p><b>extlist = mexext('all')</b> returns the extensions for all platforms.</p>
+  <p>A mex file is a type of computer file that provides an interface between Octave or the reference commercial software and functions written in C, C++.</p>
+  <p>Nelson have also his own C++ API to manage more easily internal nelson's objects.</p>
+  <p/>
+  <p>Nelson cannot load mex generated by others software, <b>BUT</b> you can easily rebuild it for each software target.</p>
+  <p>Mex generated by Nelson have a file extension beginning by <b>.nex</b></p>
+
+
+## Example
+
+```matlab
+ext = mexext()
+extlist = mexext('all')
+```
+
+## See also
+
+[mex](mex.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.5.6.0
+### Nelson 0.5.7.0
 
 Ceci est une version alpha de Nelson.
 
diff --git a/fr/changelogs/CHANGELOG.md b/fr/changelogs/CHANGELOG.md
@@ -1,3 +1,37 @@
+# 0.5.7 (2021-07-24)
+
+## Features:
+
+- macros in memory reworked to support also MEX.
+
+- C MEX compatibility, load and build fully compatible with other softwares.
+
+- `inmem` builtin returns names of functions, MEX-files in memory.
+
+- `mexext` builtin returns binary MEX file-name extension.
+
+- main function in .m no more require to be the first in file.
+
+- checks in the .m function that other local function names are not duplicated.
+
+- .m timestamp checked if `addpath(...,'-frozen')` is not enabled.
+
+- function_handle reworked to have an compatible behavior.
+
+- `struct` behavior with `function_handle`.
+
+- `clear` reworked to support mex in memory.
+
+- `nargin`, `nargout` behavior with mex updated.
+
+- [#474](http://github.com/Nelson-numerical-software/nelson/issues/474): `exist`: extended to manage mex function.
+
+- [#449](http://github.com/Nelson-numerical-software/nelson/issues/449): `conv2`: 2-D convolution and `conv`: Convolution and polynomial multiplication.
+
+## Bug Fixes:
+
+- [#468](http://github.com/Nelson-numerical-software/nelson/issues/468): A(':') = [] was not managed.
+
 # 0.5.6 (2021-06-27)
 
 BREAKING CHANGE:
