help v0.6.6

Nelson-numerical-software · Nelson-numerical-software · commit 7f469bbf495f · 2022-06-27T19:05:32.000+02:00
diff --git a/en/README.md b/en/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.6.5.0
+### Nelson 0.6.6.0
 
 This is an pre-release of Nelson.
 
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -483,6 +483,7 @@
     * [isdir](./files_folders_functions/isdir.md)
     * [isfile](./files_folders_functions/isfile.md)
     * [isfolder](./files_folders_functions/isfolder.md)
+    * [ls](./files_folders_functions/ls.md)
     * [mkdir](./files_folders_functions/mkdir.md)
     * [pathsep](./files_folders_functions/pathsep.md)
     * [pwd](./files_folders_functions/pwd.md)
@@ -937,3 +938,9 @@
     * [polyval](./polynomial_functions/polyval.md)
     * [polyvalm](./polynomial_functions/polyvalm.md)
     * [roots](./polynomial_functions/roots.md)
+
+
+* [parallel](./parallel/README.md)
+    * [backgroundPool](./parallel/backgroundPool.md)
+    * [fetchOutputs](./parallel/fetchOutputs.md)
+    * [parfeval](./parallel/parfeval.md)
diff --git a/en/changelogs/CHANGELOG.md b/en/changelogs/CHANGELOG.md
@@ -4,6 +4,36 @@ 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.6.6 (2022-06-27)
+
+### Added
+
+- Parallel functions (part 1):
+
+  - `parfeval`: Run function on parallel background thread pool worker.
+  - `backgroundPool`: Environment for running code in the background.
+  - `fetchOutputs`: Retrieve results from function running in the background.
+
+- [#666](http://github.com/Nelson-numerical-software/nelson/issues/666): `ls` function: List folder contents.
+
+- [#655](http://github.com/Nelson-numerical-software/nelson/issues/655): help viewer embedded (available on all platforms).
+
+### Changed
+
+- LGTM replaced by CodeQL (Thanks to Github for their support)
+
+- [#662](http://github.com/Nelson-numerical-software/nelson/issues/662): Snap uses Core22 and Qt6 (all dependencies are up-to-date).
+
+- [#668](http://github.com/Nelson-numerical-software/nelson/issues/668): `maxNumCompThreads` detects numbers of physical cores on Windows.
+
+- matrix of handles supported.
+
+### Fixed
+
+- [#659](http://github.com/Nelson-numerical-software/nelson/issues/659): qhelpgenerator on macOs after brew Qt6.3.0 update.
+
+- [#661](http://github.com/Nelson-numerical-software/nelson/issues/661): CodeQL warnings.
+
 ## 0.6.5 (2022-05-26)
 
 ### Added
diff --git a/en/core/maxNumCompThreads.md b/en/core/maxNumCompThreads.md
@@ -24,7 +24,7 @@ Set/Get maximum number of computional threads.
 
   <p><b>maxNumCompThreads</b> returns the number of threads used by Nelson for computations.</p>
   <p><b>maxNumCompThreads(T)</b> sets the maximum number of computational threads. This modification is only available for current session.</p>
-  <p>By default, maxNumCompThreads uses OMP_NUM_THREADS environment variable or numbers of detected cores.</p>
+  <p>By default, maxNumCompThreads uses OMP_NUM_THREADS environment variable or numbers of detected physical cores on Windows and logical cores on others platforms.</p>
 
 
 ## Example
diff --git a/en/files_folders_functions/README.md b/en/files_folders_functions/README.md
@@ -19,6 +19,7 @@ files, folders and paths functions
 * [isdir](isdir.md) - Returns true is the input argument is an directory.
 * [isfile](isfile.md) - Returns true is the input argument is a file.
 * [isfolder](isfolder.md) - Returns true is the input argument is an directory.
+* [ls](ls.md) - List folder contents.
 * [mkdir](mkdir.md) - Creates a new directory.
 * [pathsep](pathsep.md) - Return the search path separator character for the current platform.
 * [pwd](pwd.md) - Returns current directory.
diff --git a/en/files_folders_functions/SUMMARY.md b/en/files_folders_functions/SUMMARY.md
@@ -10,6 +10,7 @@
     * [isdir](isdir.md)
     * [isfile](isfile.md)
     * [isfolder](isfolder.md)
+    * [ls](ls.md)
     * [mkdir](mkdir.md)
     * [pathsep](pathsep.md)
     * [pwd](pwd.md)
diff --git a/en/files_folders_functions/dir.md b/en/files_folders_functions/dir.md
@@ -38,7 +38,7 @@ res = dir(nelsonroot(), '-s')
 
 ## See also
 
-[isdir](isdir.md), [isfile](isfile.md).
+[ls](ls.md), [isdir](isdir.md), [isfile](isfile.md).
 ## History
 
 |Version|Description|
diff --git a/en/files_folders_functions/ls.md b/en/files_folders_functions/ls.md
@@ -0,0 +1,53 @@
+
+
+# ls
+
+List folder contents.
+
+## Syntax
+
+- ls
+- ls(name)
+- res = ls()
+- res = ls(options)
+
+## Input argument
+
+ - name - a string: file or directory name.
+ - options - vary from system to system.
+
+## Output argument
+
+ - res - On Windows, res is an m-by-n character array of names. m is the number of names and n is the number of characters in the longest name. On Unix plaftorms is a character vector of names separated by tab and space characters.
+
+## Description
+
+
+  <p><b>ls</b> is implemented by calling the native operating system's directory listing command—available options will vary from system to system.</p>
+
+
+## Example
+
+```matlab
+res = ls(nelsonroot())
+if ~ispc()
+  res = ls(nelsonroot(), '-l')
+end
+```
+
+## See also
+
+[dir](dir.md), [isdir](isdir.md), [isfile](isfile.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/parallel/README.md b/en/parallel/README.md
@@ -0,0 +1,16 @@
+
+
+# parallel
+
+parallel
+
+## Description
+parallel functions
+
+
+* [backgroundPool](backgroundPool.md) - Environment for running nelson's code in the background.
+* [fetchOutputs](fetchOutputs.md) - Retrieve results from function running in the background pool.
+* [parfeval](parfeval.md) - Run function in background.
+
+
+
diff --git a/en/parallel/SUMMARY.md b/en/parallel/SUMMARY.md
@@ -0,0 +1,5 @@
+* [parallel](README.md)
+    * [backgroundPool](backgroundPool.md)
+    * [fetchOutputs](fetchOutputs.md)
+    * [parfeval](parfeval.md)
+
diff --git a/en/parallel/backgroundPool.md b/en/parallel/backgroundPool.md
@@ -0,0 +1,50 @@
+
+
+# backgroundPool
+
+Environment for running nelson's code in the background.
+
+## Syntax
+
+- pool = backgroundPool()
+
+## Output argument
+
+ - pool - backgroundPool object.
+
+## Description
+
+
+  <p><b>pool = backgroundPool()</b> returns the background pool.</p>
+  <p>This allows to run other code in your Nelson's session at the same time.</p>
+  <p/>
+  <p>Properties of backgroundPool object:</p>
+  <p>'FevalQueue': Queue of FevalFuture objects to run on the background pool (read only).</p>
+  <p>'NumWorkers': Number of workers (read only).</p>
+  <p>'Busy': Flag that indicates whether the background pool is busy, logical (read only).</p>
+
+
+## Example
+
+```matlab
+b = backgroundPool()
+fptr = str2func('magic');
+f = parfeval(b, fptr, 1, 9);
+```
+
+## See also
+
+[parfeval](parfeval.md), [fetchOutputs](fetchOutputs.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/parallel/fetchOutputs.md b/en/parallel/fetchOutputs.md
@@ -0,0 +1,69 @@
+
+
+# fetchOutputs
+
+Retrieve results from function running in the background pool.
+
+## Syntax
+
+- [y1, ... , ym] = fetchOutputs(f)
+
+## Input argument
+
+ - f - FevalFuture object
+
+## Output argument
+
+ - y1, ... , ym - outputs
+
+## Description
+
+
+  <p><b>[y1, ... , ym] = fetchOutputs(f)</b> retrieves m results from a <b>Future</b> array <b>f</b>.</p>
+  <p/>
+  <p><b>fetchOutputs</b> waits for the function associated to <b>f</b> to finish before retrieving results.</p>
+  <p>If <b>fetchOutputs</b> is called, Read property of each element in <b>f</b> is set to true.</p>
+
+
+## Examples
+
+sequantial version
+```matlab
+tic()
+R1 = magic(5000);
+R2 = magic(5000);
+toc()
+size(R1)
+```
+Parallel version
+```matlab
+b = backgroundPool()
+tic()
+fptr = str2func('magic');
+f1 = parfeval(b, fptr, 1, 5000);
+f2 = parfeval(b, fptr, 1, 5000);
+b
+r1 = fetchOutputs(f1);
+r2 = fetchOutputs(f2);
+toc()
+size(r1)
+f1
+f2
+```
+
+## See also
+
+[parfeval](parfeval.md), [backgroundPool](backgroundPool.md).
+## History
+
+|Version|Description|
+|------|------|
+|1.0.0|initial version|
+
+
+## Author
+
+Allan CORNET
+
+
+
diff --git a/en/parallel/parfeval.md b/en/parallel/parfeval.md
@@ -0,0 +1,54 @@
+
+
+# parfeval
+
+Run function in background.
+
+## Syntax
+
+- f = parfeval(bPool, fptr, n, x1, ..., xm)
+
+## Input argument
+
+ - bPool - backgroundPool object returned by backgroundPool().
+ - fptr - Function handle: Function to run.
+ - n - Number of output arguments.
+ - x1, ..., xm - Input arguments, specified as a comma-separated list of variables or expressions.
+
+## Output argument
+
+ - f - FevalFuture object.
+
+## Description
+
+
+  <p><b>f = parfeval(bPool, fptr, n, x1, ..., xm)</b> starts the function fptr to run in the background.</p>
+  <p>backgroundPool has <b>NumWorkers</b> available. If there are more functions scheduled, functions wait than one entry is available in pool.</p>
+  <p><b>parfeval</b> runs the function <b>fptr</b> on a background worker.</p>
+
+
+## Example
+
+```matlab
+b = backgroundPool()
+fptr = str2func('cos');
+f = parfeval(b, fptr, 1, 5);
+r = fetchOutputs(f)
+```
+
+## See also
+
+[backgroundPool](backgroundPool.md), [fetchOutputs](fetchOutputs.md), [feval](../functions_manager/feval.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.6.5.0
+### Nelson 0.6.6.0
 
 Ceci est une version alpha de Nelson.
 
diff --git a/fr/changelogs/CHANGELOG.md b/fr/changelogs/CHANGELOG.md
@@ -4,6 +4,36 @@ 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.6.6 (2022-06-27)
+
+### Added
+
+- Parallel functions (part 1):
+
+  - `parfeval`: Run function on parallel background thread pool worker.
+  - `backgroundPool`: Environment for running code in the background.
+  - `fetchOutputs`: Retrieve results from function running in the background.
+
+- [#666](http://github.com/Nelson-numerical-software/nelson/issues/666): `ls` function: List folder contents.
+
+- [#655](http://github.com/Nelson-numerical-software/nelson/issues/655): help viewer embedded (available on all platforms).
+
+### Changed
+
+- LGTM replaced by CodeQL (Thanks to Github for their support)
+
+- [#662](http://github.com/Nelson-numerical-software/nelson/issues/662): Snap uses Core22 and Qt6 (all dependencies are up-to-date).
+
+- [#668](http://github.com/Nelson-numerical-software/nelson/issues/668): `maxNumCompThreads` detects numbers of physical cores on Windows.
+
+- matrix of handles supported.
+
+### Fixed
+
+- [#659](http://github.com/Nelson-numerical-software/nelson/issues/659): qhelpgenerator on macOs after brew Qt6.3.0 update.
+
+- [#661](http://github.com/Nelson-numerical-software/nelson/issues/661): CodeQL warnings.
+
 ## 0.6.5 (2022-05-26)
 
 ### Added
