v1.10.0 help files

nelson-lang · Dec 14, 2024 · fe495bf · fe495bf
1 parent 984a123
commit fe495bf
Show file tree

Hide file tree

Showing 70 changed files with 1,606 additions and 45 deletions.
diff --git a/en/README.md b/en/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 1.9.0.0
+### Nelson 1.10.0.0
 
 Nelson is a powerful, open-source numerical computational language, developed to provide a comprehensive and intuitive environment for engineers, scientists, and students. With over 1,200 built-in functions, Nelson supports a wide range of tasks, from basic algebra to advanced numerical simulations.
 

diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -113,6 +113,7 @@
 - [i18n](./i18n/README.md)
 
   - [gettext](./i18n/gettext.md)
+  - [i18nHelpers](./i18n/i18nHelpers.md)
   - [poheader](./i18n/poheader.md)
 
 - [characters_encoding](./characters_encoding/README.md)
@@ -171,6 +172,7 @@
   - [double](./double/double.md)
   - [flintmax](./double/flintmax.md)
   - [realmax](./double/realmax.md)
+  - [realmin](./double/realmin.md)
 
 - [data_structures](./data_structures/README.md)
 
@@ -185,6 +187,7 @@
   - [iscellstr](./data_structures/iscellstr.md)
   - [isfield](./data_structures/isfield.md)
   - [namedargs2cell](./data_structures/namedargs2cell.md)
+  - [num2cell](./data_structures/num2cell.md)
   - [orderfields](./data_structures/orderfields.md)
   - [rmfield](./data_structures/rmfield.md)
   - [setfield](./data_structures/setfield.md)
@@ -212,6 +215,7 @@
 
   - [Accessing and Manipulating Tables in Nelson](./table/1_accessing_manipulating_table.md)
   - [Direct computation with Table](./table/2_direct_compution_with_table.md)
+  - [Read/Write table to files](./table/3_read_write_table.md)
   - [array2table](./table/array2table.md)
   - [cell2table](./table/cell2table.md)
   - [head](./table/head.md)
@@ -265,6 +269,7 @@
   - [isStringScalar](./string/isStringScalar.md)
   - [isletter](./string/isletter.md)
   - [isspace](./string/isspace.md)
+  - [join](./string/join.md)
   - [mat2str](./string/mat2str.md)
   - [matches](./string/matches.md)
   - [newline](./string/newline.md)
@@ -430,6 +435,7 @@
   - [ismatrix](./elementary_functions/ismatrix.md)
   - [isnan](./elementary_functions/isnan.md)
   - [isrow](./elementary_functions/isrow.md)
+  - [isscalar](./elementary_functions/isscalar.md)
   - [istril](./elementary_functions/istril.md)
   - [istriu](./elementary_functions/istriu.md)
   - [isvector](./elementary_functions/isvector.md)
@@ -730,8 +736,11 @@
   - [datevec](./time/datevec.md)
   - [eomday](./time/eomday.md)
   - [etime](./time/etime.md)
+  - [hour](./time/hour.md)
   - [leapyear](./time/leapyear.md)
+  - [minute](./time/minute.md)
   - [now](./time/now.md)
+  - [second](./time/second.md)
   - [sleep](./time/sleep.md)
   - [tic](./time/tic.md)
   - [time](./time/time.md)
@@ -973,6 +982,7 @@
 - [validators](./validators/README.md)
 
   - [mustBeA](./validators/mustBeA.md)
+  - [mustBeColumn](./validators/mustBeColumn.md)
   - [mustBeFile](./validators/mustBeFile.md)
   - [mustBeFinite](./validators/mustBeFinite.md)
   - [mustBeFloat](./validators/mustBeFloat.md)
@@ -985,6 +995,7 @@
   - [mustBeLessThanOrEqual](./validators/mustBeLessThanOrEqual.md)
   - [mustBeLogical](./validators/mustBeLogical.md)
   - [mustBeLogicalScalar](./validators/mustBeLogicalScalar.md)
+  - [mustBeMatrix](./validators/mustBeMatrix.md)
   - [mustBeMember](./validators/mustBeMember.md)
   - [mustBeNegative](./validators/mustBeNegative.md)
   - [mustBeNonNan](./validators/mustBeNonNan.md)
@@ -999,6 +1010,7 @@
   - [mustBeNumericOrLogical](./validators/mustBeNumericOrLogical.md)
   - [mustBePositive](./validators/mustBePositive.md)
   - [mustBeReal](./validators/mustBeReal.md)
+  - [mustBeRow](./validators/mustBeRow.md)
   - [mustBeScalarOrEmpty](./validators/mustBeScalarOrEmpty.md)
   - [mustBeText](./validators/mustBeText.md)
   - [mustBeTextScalar](./validators/mustBeTextScalar.md)
@@ -1017,7 +1029,6 @@
 - [stream_manager](./stream_manager/README.md)
 
   - [diary](./stream_manager/diary.md)
-  - [dlmwrite](./stream_manager/dlmwrite.md)
   - [fclose](./stream_manager/fclose.md)
   - [feof](./stream_manager/feof.md)
   - [ferror](./stream_manager/ferror.md)
@@ -1125,6 +1136,8 @@
   - [dlgenerateloader](./dynamic_link/dlgenerateloader.md)
   - [dlgeneratemake](./dynamic_link/dlgeneratemake.md)
   - [dlgenerateunloader](./dynamic_link/dlgenerateunloader.md)
+  - [dlgetnelsonincludes](./dynamic_link/dlgetnelsonincludes.md)
+  - [dlgetnelsonlibraries](./dynamic_link/dlgetnelsonlibraries.md)
   - [dllib_used](./dynamic_link/dllib_used.md)
   - [dllibinfo](./dynamic_link/dllibinfo.md)
   - [dllibisloaded](./dynamic_link/dllibisloaded.md)
@@ -1143,7 +1156,7 @@
   - [libpointer_reshape](./dynamic_link/libpointer_reshape.md)
   - [libpointer_setdatatype](./dynamic_link/libpointer_setdatatype.md)
   - [libpointer_used](./dynamic_link/libpointer_used.md)
-  - [loadcompilerconf](./dynamic_link/loadcompiler.md)
+  - [loadcompilerconf](./dynamic_link/loadcompilerconf.md)
   - [removecompilerconf](./dynamic_link/removecompilerconf.md)
   - [vswhere](./dynamic_link/vswhere.md)
 
@@ -1204,7 +1217,7 @@
   - [COM_xlsfinfo](./com_engine/COM_xlsfinfo.md)
   - [COM_xlsread](./com_engine/COM_xlsread.md)
   - [COM_xlswrite](./com_engine/COM_xlswrite.md)
-  - [actxGetRunningSrv](./com_engine/actxGetRunningSrv.md)
+  - [actxGetRunningServer](./com_engine/actxGetRunningServer.md)
   - [actxcontrollist](./com_engine/actxcontrollist.md)
   - [actxserver](./com_engine/actxserver.md)
   - [actxserverlist](./com_engine/actxserverlist.md)
@@ -1275,6 +1288,7 @@
   - [zero](./control_system/zero.md)
 
 - [python_engine](./python_engine/README.md)
+
   - [The power of calling Python from Nelson](./python_engine/1_The_power_of_Python.md)
   - [How to install python package](./python_engine/2_How_to_install_python_package.md)
   - [Python Nelson types](./python_engine/3_python_types.md)
@@ -1283,3 +1297,16 @@
   - [pyenv](./python_engine/pyenv.md)
   - [pyrun](./python_engine/pyrun.md)
   - [pyrunfile](./python_engine/pyrunfile.md)
+
+- [spreadsheet](./spreadsheet/README.md)
+  - [csvread](./spreadsheet/csvread.md)
+  - [csvwrite](./spreadsheet/csvwrite.md)
+  - [detectImportOptions](./spreadsheet/detectImportOptions.md)
+  - [dlmread](./spreadsheet/dlmread.md)
+  - [dlmwrite](./spreadsheet/dlmwrite.md)
+  - [readcell](./spreadsheet/readcell.md)
+  - [readmatrix](./spreadsheet/readmatrix.md)
+  - [readtable](./spreadsheet/readtable.md)
+  - [writecell](./spreadsheet/writecell.md)
+  - [writematrix](./spreadsheet/writematrix.md)
+  - [writetable](./spreadsheet/writetable.md)
diff --git a/en/changelogs/CHANGELOG.md b/en/changelogs/CHANGELOG.md
@@ -5,6 +5,43 @@ 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/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.10.0 (2024-12-14)
+
+### Added
+
+- `detectImportOptions`: Generate import options from the file's content.
+- `readtable`: Read table from file.
+- `writetable`: Write table to file.
+- `readcell`: Read cell array from file.
+- `writecell`: write cell array to file.
+- `readmatrix`: read matrix from file.
+- `writematrix`: write matrix to file.
+- `csvread`: Read comma-separated value (CSV) file.
+- `csvwrite`: Write comma-separated value (CSV) file.
+- `dlmread`: Read ASCII-delimited file of numeric data into matrix.
+- `realmin`: Smallest normalized floating-point number.
+- [#1288](http://github.com/nelson-lang/nelson/issues/1288) `mustBeMatrix`, `mustBeRow`, `mustBeColumn` validator functions.
+- `join`: Combine strings.
+- [#1292](http://github.com/nelson-lang/nelson/issues/1292) Large Table Display.
+- [#1290](http://github.com/nelson-lang/nelson/issues/1290) `VariableTypes` property for table: Specify the data types of table in Nelson.
+- `hour`, `minute`, `second` component of input date and time.
+
+### Changed
+
+- `narginchk`, `nargoutchk` support for check only minimun arguments `narginchk(3, Inf)`.
+- Fedora 41 CI
+- `title`: `Visible` property is inherited from the parent if not explicitly defined.
+- i18n: migration PO files to JSON.
+- `dlmwrite`: rework the function to be more fast and robust.
+- `strjust`: rework the function to be more fast and robust.
+- `datenum`: support '' as format for compatibility.
+
+### Fixed
+
+- [#1303](http://github.com/nelson-lang/nelson/issues/1303) `datevec` result must be normalized.
+- [#1297](http://github.com/nelson-lang/nelson/issues/1297) some features have no help files.
+- [#1276](http://github.com/nelson-lang/nelson/issues/1276) micromamba macos build.
+
 ## 1.9.0 (2024-10-26)
 
 ### Added

diff --git a/en/com_engine/README.md b/en/com_engine/README.md
@@ -20,7 +20,7 @@ Component Object Model (COM) client interface: binary-interface standard for sof
 - [COM_xlsfinfo](COM_xlsfinfo.md) - Determines if file contains Microsoft Excel spreadsheet.
 - [COM_xlsread](COM_xlsread.md) - Read Microsoft Excel spreadsheet file using COM.
 - [COM_xlswrite](COM_xlswrite.md) - Write Microsoft Excel spreadsheet file using COM.
-- [actxGetRunningSrv](actxGetRunningSrv.md) - Handle to running instance of Automation server.
+- [actxGetRunningServer](actxGetRunningServer.md) - Handle to running instance of Automation server.
 - [actxcontrollist](actxcontrollist.md) - Get available ActiveX controls.
 - [actxserver](actxserver.md) - Creates COM server.
 - [actxserverlist](actxserverlist.md) - Get available ActiveX servers.

diff --git a/en/com_engine/SUMMARY.md b/en/com_engine/SUMMARY.md
@@ -13,7 +13,7 @@
   - [COM_xlsfinfo](COM_xlsfinfo.md)
   - [COM_xlsread](COM_xlsread.md)
   - [COM_xlswrite](COM_xlswrite.md)
-  - [actxGetRunningSrv](actxGetRunningSrv.md)
+  - [actxGetRunningServer](actxGetRunningServer.md)
   - [actxcontrollist](actxcontrollist.md)
   - [actxserver](actxserver.md)
   - [actxserverlist](actxserverlist.md)

diff --git a/en/com_engine/actxGetRunningSrv.md → en/com_engine/actxGetRunningServer.md b/en/com_engine/actxGetRunningSrv.md → en/com_engine/actxGetRunningServer.md
@@ -1,10 +1,10 @@
-# actxGetRunningSrv
+# actxGetRunningServer
 
 Handle to running instance of Automation server.
 
 ## Syntax
 
-- h = actxGetRunningSrv(progid)
+- h = actxGetRunningServer(progid)
 
 ## Input argument
 
@@ -16,7 +16,7 @@ Handle to running instance of Automation server.
 
 ## Description
 
-  <p><b>h = actxGetRunningSrv(progid)</b> gets a reference to a running instance of the OLE/COM Automation server.</p>
+  <p><b>h = actxGetRunningServer(progid)</b> gets a reference to a running instance of the OLE/COM Automation server.</p>
   <p><b>progid</b> is the programmatic identifier of the Automation server object and <b>h</b> is the handle to the default interface of the server object.</p>
   <p>The function returns an error if the server specified by progid is not currently running or if the server object is not registered.</p>
   <p>When multiple instances of the Automation server are running, the operating system controls the behavior of this function.</p>

diff --git a/en/com_engine/actxserver.md b/en/com_engine/actxserver.md
@@ -38,7 +38,7 @@ clear pTextToSpeech
 
 ## See also
 
-[actxGetRunningSrv](actxGetRunningSrv.md).
+[actxGetRunningSrv](actxGetRunningSrv.html).
 
 ## History
 

diff --git a/en/core/narginchk.md b/en/core/narginchk.md
@@ -14,6 +14,7 @@ Checks the number of input arguments.
 ## Description
 
   <p><b>narginchk</b> checks the number of input arguments of an function.</p>
+  <p>To ensure that a minimum number of arguments is provided, while allowing an unlimited maximum number by setting <b>maxArgs</b> to <b>inf</b>. For instance, use <b>narginchk(2, inf)</b> to throw an error if fewer than two inputs are supplied.</p>
 
 ## Example
 
@@ -29,9 +30,10 @@ narginchk(1, 2)
 
 ## History
 
-| Version | Description     |
-| ------- | --------------- |
-| 1.0.0   | initial version |
+| Version | Description               |
+| ------- | ------------------------- |
+| 1.0.0   | initial version           |
+| 1.10.0  | narginchk(3, Inf) managed |
 
 ## Author
 

diff --git a/en/core/nargoutchk.md b/en/core/nargoutchk.md
@@ -22,6 +22,7 @@ Checks the number of output arguments.
 ## Description
 
   <p><b>nargoutchk</b> checks the number of output arguments of an function.</p>
+  <p>To ensure a minimum number of outputs while imposing no maximum limit, set <b>maxArgs</b> to <b>inf</b>. For example, <b>nargoutchk(2, inf)</b> generates an error if fewer than two outputs are specified.</p>
 
 ## Example
 
@@ -34,13 +35,14 @@ nargoutchk(1, 2, 3, 'struct')
 
 ## See also
 
-[nargout](nargin.md), [narginchk](nargoutchk.md).
+[nargout](nargin.md), [narginchk](narginchk.md).
 
 ## History
 
-| Version | Description     |
-| ------- | --------------- |
-| 1.0.0   | initial version |
+| Version | Description                |
+| ------- | -------------------------- |
+| 1.0.0   | initial version            |
+| 1.10.0  | nargoutchk(3, Inf) managed |
 
 ## Author
 

diff --git a/en/data_structures/README.md b/en/data_structures/README.md
@@ -17,6 +17,7 @@ data structures functions
 - [iscellstr](iscellstr.md) - Returns if a variable is a cell of strings.
 - [isfield](isfield.md) - Checks if a fieldname exists in a struct.
 - [namedargs2cell](namedargs2cell.md) - Converts a struct containing name-value pairs to a cell.
+- [num2cell](num2cell.md) - Convert array to cell array with consistently sized cells.
 - [orderfields](orderfields.md) - Reorganize the fields of a structured array.
 - [rmfield](rmfield.md) - Remove fields from structure.
 - [setfield](setfield.md) - Set structure field contents.

diff --git a/en/data_structures/SUMMARY.md b/en/data_structures/SUMMARY.md
@@ -10,6 +10,7 @@
   - [iscellstr](iscellstr.md)
   - [isfield](isfield.md)
   - [namedargs2cell](namedargs2cell.md)
+  - [num2cell](num2cell.md)
   - [orderfields](orderfields.md)
   - [rmfield](rmfield.md)
   - [setfield](setfield.md)

diff --git a/en/data_structures/cellfun.md b/en/data_structures/cellfun.md
@@ -43,7 +43,7 @@ functions to define for next example:
 ```matlab
 function r = fun1(x, y)
 r = x > y;
-endfunction
+end
 
 function result = errorfun(S, varargin)
 	disp(nargin())
@@ -53,7 +53,7 @@ function result = errorfun(S, varargin)
 	disp(varargin{1})
 	disp(varargin{2})
 	result = false;
-endfunction
+end
 ```
 
 ```matlab

diff --git a/en/data_structures/num2cell.md b/en/data_structures/num2cell.md
@@ -0,0 +1,45 @@
+# num2cell
+
+Convert array to cell array with consistently sized cells.
+
+## Syntax
+
+- C = num2cell(A)
+- C = num2cell(A, dim)
+
+## Input argument
+
+- A - any type of multidimensional array.
+- dim - positive integer value or positive vector of integers.
+
+## Output argument
+
+- C - a cell array.
+
+## Description
+
+  <p><b>num2cell</b> function converts a numeric array into a cell array, where each element of the numeric array is placed in its own cell in the resulting cell array.</p>
+  <p>If <b>A</b> is a character array, num2cell will convert each row of the array into a separate cell in the resulting cell array.</p>
+
+## Example
+
+```matlab
+A = [1 2; 3 4; 5 6];
+C = num2cell(A)
+C = num2cell(A, 1)
+C = num2cell(A, 2)
+```
+
+## See also
+
+[cell](cell.md).
+
+## History
+
+| Version | Description     |
+| ------- | --------------- |
+| 1.0.0   | initial version |
+
+## Author
+
+Allan CORNET
diff --git a/en/double/README.md b/en/double/README.md
@@ -9,3 +9,4 @@ double type functions
 - [double](double.md) - Converts a variable to double precision type.
 - [flintmax](flintmax.md) - Largest consecutive integer in floating-point format.
 - [realmax](realmax.md) - Largest positive floating-point number.
+- [realmin](realmin.md) - Smallest positive floating-point number.
diff --git a/en/double/SUMMARY.md b/en/double/SUMMARY.md
@@ -2,3 +2,4 @@
   - [double](double.md)
   - [flintmax](flintmax.md)
   - [realmax](realmax.md)
+  - [realmin](realmin.md)