v0.7.2

Nelson-numerical-software · Nelson-numerical-software · commit 3cca73ed1194 · 2023-02-27T19:55:58.000+01:00
diff --git a/en/README.md b/en/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.7.1.0
+### Nelson 0.7.2.0
 
 This is an pre-release of Nelson.
 
diff --git a/en/changelogs/CHANGELOG.md b/en/changelogs/CHANGELOG.md
@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## 0.7.2 (2023-02-27)
+
+### Changed
+
+- cmake project reworked. It should be easier to package Nelson on linux platforms (Thanks to @JohanMabille)
+- Debian package generated (beta - feedback welcome).
+- `modulepath` reworked and extended.
+- C++ API: `IsCellOfStrings(ArrayOf)` replaced by `ArrayOf::isCellArrayOfCharacterVectors()`
+- C++ API: header `CheckHelpers.hpp` replaced by `InputOutputArgumentsCheckers.hpp`
+- C++ API: `ToCellStringAsColumn` replaced by `ArrayOf::toCellArrayOfCharacterColumnVectors`
+- `api_nelson` methods moved to type modules
+- Remove internal circular dependency about error and warning.
+- Exports minimum headers in package.
+
+### Fixed
+
+- `disp`, `display` did no more support overloading.
+- `image` did not save all values for `XData` and `YData`.
+- Github CI Monterey and Ubuntu 22.04 (dependencies install) fixed.
+- some warnings.
+
 ## 0.7.1 (2023-01-29)
 
 ### Added
diff --git a/en/core/sha256.md b/en/core/sha256.md
@@ -38,15 +38,15 @@ R = sha256(["Hello"; "World"])
 ```
 
 ```matlab
-R = sha256([modulepath('matio'), '/tests/mat/test_char_array_unicode_7.4_GLNX86.mat'])
+R = sha256([modulepath('matio', 'tests'), '/mat/test_char_array_unicode_7.4_GLNX86.mat'])
 ```
 
 ```matlab
-R = sha256([modulepath('matio'), '/tests/mat/test_char_array_unicode_7.4_GLNX86.mat'], '-file')
+R = sha256([modulepath('matio', 'tests'), '/mat/test_char_array_unicode_7.4_GLNX86.mat'], '-file')
 ```
 
 ```matlab
-R = sha256([modulepath('matio'), '/tests/mat/test_char_array_unicode_7.4_GLNX86.mat'], '-string')
+R = sha256([modulepath('matio', 'tests'), '/mat/test_char_array_unicode_7.4_GLNX86.mat'], '-string')
 ```
 
 ## History
diff --git a/en/dynamic_link/dlcall.md b/en/dynamic_link/dlcall.md
@@ -23,7 +23,7 @@ C or Fortran Foreign function call.
 ## Examples
 
 ```matlab
-lib = dlopen([modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()]);
+lib = dlopen([modulepath('nelson', 'builtin'), '/libnlsDynamic_link', getdynlibext()]);
 V = double([1 2;3 4]);
 % C prototype:
 % int dynlibTestMultiplyDoubleArrayWithReturn(double *x, int size)
diff --git a/en/dynamic_link/dlclose.md b/en/dynamic_link/dlclose.md
@@ -20,7 +20,7 @@ Removes dllib object.
 ## Example
 
 ```matlab
-path_ref = [modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()];
+path_ref = modulepath('dynamic_link', 'builtin');
 lib = dlopen(path_ref)
 isvalid(lib)
 dlclose(lib); // or delete(lib)
diff --git a/en/dynamic_link/dllibinfo.md b/en/dynamic_link/dllibinfo.md
@@ -21,7 +21,7 @@ Returns list of available symbols in an shared library.
 ## Example
 
 ```matlab
-lib = dlopen([modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()])
+lib = dlopen(modulepath('dynamic_link', 'builtin'))
 c = dllibinfo(lib)
 ```
 
diff --git a/en/dynamic_link/dllibisloaded.md b/en/dynamic_link/dllibisloaded.md
@@ -23,7 +23,7 @@ Checks if shared library is loaded.
 ## Example
 
 ```matlab
-path_1 = [modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()];
+path_1 = modulepath('dynamic_link', 'builtin');
 r = dllibisloaded(path_1)
 lib1 = dlopen(path_1);
 [r, lib2] = dllibisloaded(path_1)
diff --git a/en/dynamic_link/dlopen.md b/en/dynamic_link/dlopen.md
@@ -25,7 +25,7 @@ Loads an dynamic library.
 ## Example
 
 ```matlab
-path_1 = [modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()];
+path_1 = modulepath('dynamic_link', 'builtin');
 lib1 = dlopen(path_1)
 isvalid(lib1)
 dlclose(lib1)
diff --git a/en/dynamic_link/dlsym.md b/en/dynamic_link/dlsym.md
@@ -53,7 +53,7 @@ Loads a C/Fortran symbol for an dynamic library.
 ## Examples
 
 ```matlab
-lib = dlopen([modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()]);
+lib = dlopen(modulepath('dynamic_link', 'builtin'));
 V = double([1 2;3 4]);
 % C prototype:
 % int dynlibTestMultiplyDoubleArrayWithReturn(double *x, int size)
diff --git a/en/dynamic_link/libpointer.md b/en/dynamic_link/libpointer.md
@@ -42,7 +42,7 @@ NLSDYNAMIC_LINK_IMPEXP double *multiplicationDoubleByReference(double *x)
 ```matlab
 x = 133.3;
 xPtr = libpointer('doublePtr', x);
-path_ref = [modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()];
+path_ref = modulepath('dynamic_link', 'builtin');
 lib = dlopen(path_ref);
 f = dlsym(lib, 'multiplicationDoubleByReference', 'libpointer', {'doublePtr'});
 [r1, r2] = dlcall(f, xPtr);
diff --git a/en/hdf5/h5read.md b/en/hdf5/h5read.md
@@ -22,7 +22,7 @@ Read HDF5 data set.
 ## Example
 
 ```matlab
-h5_directory = [modulepath('hdf5'), '/tests/h5'];
+h5_directory = [modulepath('hdf5','tests'), '/h5'];
 double_data = [h5_directory, '/h5ex_t_float.h5'];
 R = h5read(double_data,'/DS1')
 ```
diff --git a/en/mex/engClose.md b/en/mex/engClose.md
@@ -22,7 +22,7 @@ Close Nelson engine session
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/engGetVariable.md b/en/mex/engGetVariable.md
@@ -24,7 +24,7 @@ Copy variable from Nelson engine workspace
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/engGetVisible.md b/en/mex/engGetVisible.md
@@ -23,7 +23,7 @@ Determine visibility of Nelson engine session
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/engOpen.md b/en/mex/engOpen.md
@@ -20,7 +20,7 @@ Start Nelson process
   <p><b>engOpen</b> starts a Nelson process for using Nelson as a computational engine.</p>
   <p>Libraries path need to contain nelson path to find Nelson's libraries at runtime.</p>
   <p>Set the value to the path returned by the following Nelson command:</p>
-  <p><b>res</b> = modulepath(nelsonroot(),'core','bin')</p>
+  <p><b>res</b> = modulepath('nelson', 'builtin')</p>
   <p>on linux: export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<b>res</b></p>
   <p>export PATH=$PATH:<b>res</b></p>
   <p>on macos: export DYLIB_LIBRARY_PATH=$DYLIB_LIBRARY_PATH:<b>res</b></p>
@@ -30,7 +30,7 @@ Start Nelson process
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/engOpenSingleUse.md b/en/mex/engOpenSingleUse.md
@@ -24,7 +24,7 @@ Start Nelson engine session for single and nonshared use.
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/engPutVariable.md b/en/mex/engPutVariable.md
@@ -24,7 +24,7 @@ Put variable into Nelson engine workspace
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/engSetVisible.md b/en/mex/engSetVisible.md
@@ -23,7 +23,7 @@ Show or hide Nelson engine session
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.c'])
+edit([modulepath('mex', 'tests'), '/test_engine.c'])
 ```
 
 ## See also
diff --git a/en/mex/mex.md b/en/mex/mex.md
@@ -45,7 +45,7 @@ Build MEX function
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_engine.m'])
+edit([modulepath('mex', 'tests'), '/test_engine.m'])
 ```
 
 ## See also
diff --git a/en/mex/mexAtExit.md b/en/mex/mexAtExit.md
@@ -23,7 +23,7 @@ Register a function to be called when the MEX-file is cleared or when Nelson exi
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_mexAtExit.m'])
+edit([modulepath('mex', 'tests'), '/test_mexAtExit.m'])
 ```
 
 ## See also
diff --git a/en/mex/mexCallMATLAB.md b/en/mex/mexCallMATLAB.md
@@ -27,7 +27,7 @@ Call a NELSON function
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_mexCallMATLAB.m'])
+edit([modulepath('mex', 'tests'), '/test_mexCallMATLAB.m'])
 ```
 
 ## See also
diff --git a/en/mex/mexCallMATLABWithTrap.md b/en/mex/mexCallMATLABWithTrap.md
@@ -27,7 +27,7 @@ Call a NELSON function and capture error.
 ## Example
 
 ```matlab
-edit([modulepath('mex'), '/tests/test_mexCallMATLABWithTrap.m'])
+edit([modulepath('mex', 'tests'), '/test_mexCallMATLABWithTrap.m'])
 ```
 
 ## See also
diff --git a/en/modules_manager/addgateway.md b/en/modules_manager/addgateway.md
@@ -21,7 +21,7 @@ Adds dynamically builtin at runtime.
 Add gateway for string module:
 
 ```matlab
-addgateway(modulepath(nelsonroot(), 'time', 'builtin'))
+addgateway(modulepath('time', 'builtin'))
 ```
 
 ## See also
diff --git a/en/modules_manager/gatewayinfo.md b/en/modules_manager/gatewayinfo.md
@@ -24,7 +24,7 @@ Returns information about an gateway.
 ## Example
 
 ```matlab
-[gateway_name, builtin_list] = gatewayinfo(modulepath(nelsonroot(), 'time', 'builtin'))
+[gateway_name, builtin_list] = gatewayinfo(modulepath('time', 'builtin'))
 ```
 
 ## See also
diff --git a/en/modules_manager/modulepath.md b/en/modules_manager/modulepath.md
@@ -5,13 +5,12 @@ Returns path of a module.
 ## Syntax
 
 - p = modulepath(module_short_name)
-- p = modulepath(module_path, module_short_name, option)
+- p = modulepath(module_short_name, option)
 
 ## Input argument
 
-- module_path - a string: existing path.
-- module_short_name - a string: short module's name.
-- option - a string: 'etc', 'bin', 'root', 'builtin'.
+- module_short_name or 'nelson' - a string: short module's name. module must exist in nelson session.
+- option - a string: 'etc', 'bin', 'root', 'builtin', 'tests'.
 
 ## Output argument
 
@@ -20,15 +19,22 @@ Returns path of a module.
 ## Description
 
   <p><b>modulepath</b> is an helper's function to return module root path or a subdirectory.</p>
+  <p><b>modulepath('nelson')</b> is equivalent to <b>modulepath('nelson', 'root')</b></p>
+  <p><b>modulepath('nelson', 'bin')</b> return path of nelson's executables.</p>
+  <p><b>modulepath('nelson', 'builtin')</b> returns path of nelson's dynamic libraries.</p>
 
 ## Example
 
 ```matlab
 modulepath('core')
-modulepath(nelsonroot(),'core','etc')
-modulepath(nelsonroot(),'core','bin')
-modulepath(nelsonroot(),'core','root')
-modulepath(nelsonroot(),'core','builtin')
+modulepath('core', 'root')
+modulepath('core', 'etc')
+modulepath('core', 'bin')
+modulepath('core', 'builtin')
+modulepath('core', 'tests')
+modulepath('nelson', 'root')
+modulepath('nelson', 'bin')
+modulepath('nelson', 'builtin')
 ```
 
 ## See also
diff --git a/en/modules_manager/removegateway.md b/en/modules_manager/removegateway.md
@@ -22,7 +22,7 @@ removes time builtin
 
 ```matlab
 calendar
-removegateway(modulepath(nelsonroot(), 'time', 'builtin'))
+removegateway(modulepath('time', 'builtin'))
 calendar
 ```
 
diff --git a/fr/README.md b/fr/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.7.1.0
+### Nelson 0.7.2.0
 
 Ceci est une version alpha de Nelson.
 
diff --git a/fr/changelogs/CHANGELOG.md b/fr/changelogs/CHANGELOG.md
@@ -4,6 +4,27 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## 0.7.2 (2023-02-27)
+
+### Changed
+
+- cmake project reworked. It should be easier to package Nelson on linux platforms (Thanks to @JohanMabille)
+- Debian package generated (beta - feedback welcome).
+- `modulepath` reworked and extended.
+- C++ API: `IsCellOfStrings(ArrayOf)` replaced by `ArrayOf::isCellArrayOfCharacterVectors()`
+- C++ API: header `CheckHelpers.hpp` replaced by `InputOutputArgumentsCheckers.hpp`
+- C++ API: `ToCellStringAsColumn` replaced by `ArrayOf::toCellArrayOfCharacterColumnVectors`
+- `api_nelson` methods moved to type modules
+- Remove internal circular dependency about error and warning.
+- Exports minimum headers in package.
+
+### Fixed
+
+- `disp`, `display` did no more support overloading.
+- `image` did not save all values for `XData` and `YData`.
+- Github CI Monterey and Ubuntu 22.04 (dependencies install) fixed.
+- some warnings.
+
 ## 0.7.1 (2023-01-29)
 
 ### Added
