v0.5.5 help files

Author: Nelson-numerical-software

en/README.md

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

en/SUMMARY.md

@@ -123,25 +123,56 @@
     * [usermodulesdir](./modules_manager/usermodulesdir.md)
 
 
+* [operators](./operators/README.md)
+    * [all](./operators/all.md)
+    * [and](./operators/and.md)
+    * [any](./operators/any.md)
+    * [colon](./operators/colon.md)
+    * [ctranspose](./operators/ctranspose.md)
+    * [eq](./operators/eq.md)
+    * [ge](./operators/ge.md)
+    * [gt](./operators/gt.md)
+    * [horzcat](./operators/horzcat.md)
+    * [ismember](./operators/ismember.md)
+    * [ldivide](./operators/ldivide.md)
+    * [le](./operators/le.md)
+    * [lt](./operators/lt.md)
+    * [minus](./operators/minus.md)
+    * [mldivide](./operators/mldivide.md)
+    * [mpower](./operators/mpower.md)
+    * [mrdivide](./operators/mrdivide.md)
+    * [mtimes](./operators/mtimes.md)
+    * [ne](./operators/ne.md)
+    * [not](./operators/not.md)
+    * [or](./operators/or.md)
+    * [plus](./operators/plus.md)
+    * [power](./operators/power.md)
+    * [rdivide](./operators/rdivide.md)
+    * [shortcutand](./operators/shortcutand.md)
+    * [shortcutor](./operators/shortcutor.md)
+    * [subsindex](./operators/subsindex.md)
+    * [mtimes](./operators/times.md)
+    * [transpose](./operators/transpose.md)
+    * [uminus](./operators/uminus.md)
+    * [uplus](./operators/uplus.md)
+    * [vertcat](./operators/vertcat.md)
+
+
 * [elementary_functions](./elementary_functions/README.md)
     * [abs](./elementary_functions/abs.md)
-    * [and](./elementary_functions/and.md)
     * [angle](./elementary_functions/angle.md)
     * [base2dec](./elementary_functions/base2dec.md)
     * [bin2dec](./elementary_functions/bin2dec.md)
     * [bin2num](./elementary_functions/bin2num.md)
     * [cast](./elementary_functions/cast.md)
     * [ceil](./elementary_functions/ceil.md)
     * [circshift](./elementary_functions/circshift.md)
-    * [colon](./elementary_functions/colon.md)
     * [complex](./elementary_functions/complex.md)
     * [conj](./elementary_functions/conj.md)
-    * [ctranspose](./elementary_functions/ctranspose.md)
     * [dec2base](./elementary_functions/dec2base.md)
     * [dec2bin](./elementary_functions/dec2bin.md)
     * [dec2hex](./elementary_functions/dec2hex.md)
     * [disp](./elementary_functions/disp.md)
-    * [eq](./elementary_functions/eq.md)
     * [exp](./elementary_functions/exp.md)
     * [factorial](./elementary_functions/factorial.md)
     * [find](./elementary_functions/find.md)
@@ -151,10 +182,7 @@
     * [fliplr](./elementary_functions/fliplr.md)
     * [flipud](./elementary_functions/flipud.md)
     * [floor](./elementary_functions/floor.md)
-    * [ge](./elementary_functions/ge.md)
-    * [gt](./elementary_functions/gt.md)
     * [hex2dec](./elementary_functions/hex2dec.md)
-    * [horzcat](./elementary_functions/horzcat.md)
     * [imag](./elementary_functions/imag.md)
     * [isapprox](./elementary_functions/isapprox.md)
     * [istriu](./elementary_functions/isdiag.md)
@@ -168,57 +196,36 @@
     * [istril](./elementary_functions/istril.md)
     * [istriu](./elementary_functions/istriu.md)
     * [isvector](./elementary_functions/isvector.md)
-    * [ldivide](./elementary_functions/ldivide.md)
-    * [le](./elementary_functions/le.md)
     * [length](./elementary_functions/length.md)
     * [linspace](./elementary_functions/linspace.md)
     * [log](./elementary_functions/log.md)
     * [log10](./elementary_functions/log10.md)
     * [log1p](./elementary_functions/log1p.md)
     * [log2](./elementary_functions/log2.md)
     * [logspace](./elementary_functions/logspace.md)
-    * [lt](./elementary_functions/lt.md)
     * [magic](./elementary_functions/magic.md)
     * [max](./elementary_functions/max.md)
     * [min](./elementary_functions/min.md)
     * [minus](./elementary_functions/minus.md)
-    * [mldivide](./elementary_functions/mldivide.md)
     * [mod](./elementary_functions/mod.md)
-    * [mpower](./elementary_functions/mpower.md)
-    * [mrdivide](./elementary_functions/mrdivide.md)
-    * [mtimes](./elementary_functions/mtimes.md)
     * [ndims](./elementary_functions/ndims.md)
-    * [ne](./elementary_functions/ne.md)
     * [norm](./elementary_functions/norm.md)
-    * [not](./elementary_functions/not.md)
     * [num2bin](./elementary_functions/num2bin.md)
     * [numel](./elementary_functions/numel.md)
-    * [or](./elementary_functions/or.md)
-    * [plus](./elementary_functions/plus.md)
-    * [power](./elementary_functions/power.md)
     * [prod](./elementary_functions/prod.md)
-    * [rdivide](./elementary_functions/rdivide.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)
-    * [shortcutand](./elementary_functions/shortcutand.md)
-    * [shortcutor](./elementary_functions/shortcutor.md)
     * [sign](./elementary_functions/sign.md)
     * [size](./elementary_functions/size.md)
     * [sort](./elementary_functions/sort.md)
     * [sqrt](./elementary_functions/sqrt.md)
-    * [subsindex](./elementary_functions/subsindex.md)
     * [sum](./elementary_functions/sum.md)
     * [swapbytes](./elementary_functions/swapbytes.md)
-    * [mtimes](./elementary_functions/times.md)
-    * [transpose](./elementary_functions/transpose.md)
     * [tril](./elementary_functions/tril.md)
     * [triu](./elementary_functions/triu.md)
-    * [uminus](./elementary_functions/uminus.md)
-    * [uplus](./elementary_functions/uplus.md)
-    * [vertcat](./elementary_functions/vertcat.md)
 
 
 * [special_functions](./special_functions/README.md)
@@ -334,8 +341,6 @@
 
 
 * [logical](./logical/README.md)
-    * [all](./logical/all.md)
-    * [any](./logical/any.md)
     * [false](./logical/false.md)
     * [logical](./logical/logical.md)
     * [true](./logical/true.md)
@@ -847,13 +852,35 @@
 
 
 * [validators](./validators/README.md)
+    * [mustBeA](./validators/mustBeA.md)
+    * [mustBeFile](./validators/mustBeFile.md)
     * [mustBeFinite](./validators/mustBeFinite.md)
     * [mustBeFloat](./validators/mustBeFloat.md)
     * [mustBeFolder](./validators/mustBeFolder.md)
+    * [mustBeGreaterThan](./validators/mustBeGreaterThan.md)
+    * [mustBeGreaterThanOrEqual](./validators/mustBeGreaterThanOrEqual.md)
+    * [mustBeInRange](./validators/mustBeInRange.md)
+    * [mustBeInteger](./validators/mustBeInteger.md)
+    * [mustBeLessThan](./validators/mustBeLessThan.md)
+    * [mustBeLessThanOrEqual](./validators/mustBeLessThanOrEqual.md)
     * [mustBeLogical](./validators/mustBeLogical.md)
     * [mustBeLogicalScalar](./validators/mustBeLogicalScalar.md)
+    * [mustBeMember](./validators/mustBeMember.md)
+    * [mustBeNonnegative](./validators/mustBeNegative.md)
+    * [mustBeNonempty](./validators/mustBeNonempty.md)
+    * [mustBeNonmissing](./validators/mustBeNonmissing.md)
+    * [mustBeNonNan](./validators/mustBeNonNan.md)
+    * [mustBeNonnegative](./validators/mustBeNonnegative.md)
+    * [mustBeNonpositive](./validators/mustBeNonpositive.md)
+    * [mustBeNonSparse](./validators/mustBeNonSparse.md)
+    * [mustBeNonZero](./validators/mustBeNonZero.md)
+    * [mustBeNonzeroLengthText](./validators/mustBeNonzeroLengthText.md)
     * [mustBeNumeric](./validators/mustBeNumeric.md)
+    * [mustBeNumericOrLogical](./validators/mustBeNumericOrLogical.md)
+    * [mustBePositive](./validators/mustBePositive.md)
+    * [mustBeReal](./validators/mustBeReal.md)
     * [mustBeScalarOrEmpty](./validators/mustBeScalarOrEmpty.md)
+    * [mustBeText](./validators/mustBeText.md)
     * [mustBeTextScalar](./validators/mustBeTextScalar.md)
     * [mustBeValidVariableName](./validators/mustBeValidVariableName.md)
     * [mustBeVector](./validators/mustBeVector.md)

en/changelogs/CHANGELOG.md

@@ -1,3 +1,45 @@
+# 0.5.5 (2021-05-24)
+
+## Features:
+
+- Validators functions available from Nelson and C++ API (part 2):
+
+  - `mustBeFile`,
+  - `mustBeNonempty`, `mustBeNonNan`, `mustBeNonZero`, `mustBeNonSparse`,
+  - `mustBeA`, `mustBeReal`, `mustBeInteger`, `mustBeNonmissing`,
+  - `mustBePositive`, `mustBeNonpositive`, `mustBeNonnegative`, `mustBeNegative`,
+  - `mustBeGreaterThan`, `mustBeGreaterThanOrEqual`, `mustBeLessThan`,
+  - `mustBeNumericOrLogical`, `mustBeText`, `mustBeNonzeroLengthText`,
+  - `mustBeMember`, `mustBeInRange`.
+
+- `test_run` manages `SEQUENTIAL TEST REQUIRED` and `NATIVE_ARCHITECTURE TEST REQUIRED` tags.
+
+- benchs are executed sequentialy (better bench results).
+
+- `all`, `any` behavior with empty matrix updated.
+
+- extends `all` to manage over all elements.
+
+- `ismember` builtin: Array elements that are members of another array.
+
+- [#439](http://github.com/Nelson-numerical-software/nelson/issues/439): split elementary_functions module and creates operators modules.
+
+## Changed:
+
+- comment symbol is '%'. others previous supported comment symbol removed.
+
+## Bug Fixes:
+
+- [#435](http://github.com/Nelson-numerical-software/nelson/issues/435): `maxNumCompThreads` did not return number of threads but number of cores.
+
+## Compilation:
+
+- Move Windows build to GitHub CI. Appveyor is no more the principal build CI for Windows.
+
+- [#441](http://github.com/Nelson-numerical-software/nelson/issues/441): Circle CI (ArchLinux build) fixed.
+
+- [#357](http://github.com/Nelson-numerical-software/nelson/issues/357): Curl 7.76.1 on Windows.
+
 # 0.5.4 (2021-04-24)
 
 ## Features:

en/dynamic_link/dlcall.md

@@ -29,8 +29,8 @@ C or Fortran Foreign function call.
 ```matlab
 lib = dlopen([modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()]);
 V = double([1 2;3 4]);
-// C prototype:
-// int dynlibTestMultiplyDoubleArrayWithReturn(double *x, int size)
+% C prototype:
+% int dynlibTestMultiplyDoubleArrayWithReturn(double *x, int size)
 f = dlsym(lib, 'dynlibTestMultiplyDoubleArrayWithReturn', 'int32', {'doublePtr', 'int32'});
 [r1, r2] = dlcall(f, V, int32(numel(V)))
 delete(f);

en/dynamic_link/dlsym.md

@@ -31,8 +31,8 @@ Loads a C/Fortran symbol for an dynamic library.
 ```matlab
 lib = dlopen([modulepath(nelsonroot(),'dynamic_link','bin'), '/libnlsDynamic_link', getdynlibext()]);
 V = double([1 2;3 4]);
-// C prototype:
-// int dynlibTestMultiplyDoubleArrayWithReturn(double *x, int size)
+% C prototype:
+% int dynlibTestMultiplyDoubleArrayWithReturn(double *x, int size)
 f = dlsym(lib, 'dynlibTestMultiplyDoubleArrayWithReturn', 'int32', {'doublePtr', 'int32'});
 [r1, r2] = dlcall(f, V, int32(numel(V)))
 delete(f);

en/dynamic_link/libpointer.md

@@ -49,7 +49,7 @@ lib = dlopen(path_ref);
 f = dlsym(lib, 'multiplicationDoubleByReference', 'libpointer', {'doublePtr'});
 [r1, r2] = dlcall(f, xPtr);
 r2
-// r1 is an libpointer of type '' (voidPointer) and it need to be change type and size.
+% r1 is an libpointer of type '' (voidPointer) and it need to be change type and size.
 r1.setdatatype('doublePtr');
 r1.reshape(1, 1);
 get(r1)

en/elementary_functions/README.md

@@ -9,23 +9,19 @@ elementary functions
 
 
 * [abs](abs.md) - Absolute value
-* [and](and.md) - logical 'AND' operator, &
 * [angle](angle.md) - Phase angle
 * [base2dec](base2dec.md) - Convert number in a base to decimal.
 * [bin2dec](bin2dec.md) - Convert number in base 2 to decimal.
 * [bin2num](bin2num.md) - Convert two's complement binary string to number.
 * [cast](cast.md) - Converts variable to a different data type
 * [ceil](ceil.md) - Round up
 * [circshift](circshift.md) - Circular shift
-* [colon](colon.md) - colon operator ':'.
 * [complex](complex.md) - Creates an complex number.
 * [conj](conj.md) - Complex conjugate
-* [ctranspose](ctranspose.md) - Returns complex conjugate transpose: ' operator.
 * [dec2base](dec2base.md) - Convert decimal number to another base.
 * [dec2bin](dec2bin.md) - Convert decimal number to base 2.
 * [dec2hex](dec2hex.md) - Convert decimal number to base 16.
 * [disp](disp.md) - Display a variable.
-* [eq](eq.md) - equality, == operator.
 * [exp](exp.md) - Exponential
 * [factorial](factorial.md) - Factorial function
 * [find](find.md) - Find Non-zero Elements
@@ -35,10 +31,7 @@ elementary functions
 * [fliplr](fliplr.md) - Flip order of elements left to right
 * [flipud](flipud.md) - Flip order of elements up to dow
 * [floor](floor.md) - Round down
-* [ge](ge.md) - greater than or equal, >= operator.
-* [gt](gt.md) - greater than, > operator.
 * [hex2dec](hex2dec.md) - Convert number in base 16 to decimal.
-* [horzcat](horzcat.md) - Horizontal concatenation.
 * [imag](imag.md) - Imaginary part of an complex number.
 * [isapprox](isapprox.md) - Return true if arguments are approximately equal, within the precision.
 * [istriu](isdiag.md) - Checks if matrix is diagonal.
@@ -52,57 +45,36 @@ elementary functions
 * [istril](istril.md) - Checks if matrix is lower triangular.
 * [istriu](istriu.md) - Checks if matrix is upper triangular.
 * [isvector](isvector.md) - Checks input is vector.
-* [ldivide](ldivide.md) - Left division, .\ operator.
-* [le](le.md) - less than or equal, ≤ operator.
 * [length](length.md) - Length of an object.
 * [linspace](linspace.md) - linearly spaced vector constructor.
 * [log](log.md) - Natural logarithm.
 * [log10](log10.md) - Common logarithm (base 10).
 * [log1p](log1p.md) - log(1 + x) accurately for small values of x.
 * [log2](log2.md) - dissect floating-point numbers into base 2 exponent and mantissa.
 * [logspace](logspace.md) - logarithmically spaced vector constructor.
-* [lt](lt.md) - less than, < operator.
 * [magic](magic.md) - Magic square
 * [max](max.md) - Maximum elements of an array.
 * [min](min.md) - Minimum elements of an array.
 * [minus](minus.md) - Subtraction, - operator
-* [mldivide](mldivide.md) - Matrix left division, \ operator.
 * [mod](mod.md) - Modulus after division.
-* [mpower](mpower.md) - Matrix power, ^ operator
-* [mrdivide](mrdivide.md) - Matrix right division, / operator.
-* [mtimes](mtimes.md) - Matrix multiplication, * operator
 * [ndims](ndims.md) - Number of dimensions of an array.
-* [ne](ne.md) - Inequality, ~= operator
 * [norm](norm.md) - Matrix and vector norms
-* [not](not.md) - not logical, ~ operator
 * [num2bin](num2bin.md) - Convert number to binary representation.
 * [numel](numel.md) - Number of elements.
-* [or](or.md) - logical 'OR' operator, |
-* [plus](plus.md) - Addition, + operator
-* [power](power.md) - Element wise power, .^ operator
 * [prod](prod.md) - Product of array elements.
-* [rdivide](rdivide.md) - Right division, ./ operator
 * [real](real.md) - Real part of an complex number.
 * [rem](rem.md) - Remainder after division.
 * [repmat](repmat.md) - Replicate and tile an array.
 * [reshape](reshape.md) - Reshapes a vector or a matrix to a different size matrix.
 * [round](round.md) - Round to nearest integer
-* [shortcutand](shortcutand.md) - Short circuit 'AND' operator, &&
-* [shortcutor](shortcutor.md) - Short circuit 'OR' operator, ||
 * [sign](sign.md) - Find the sign function of a number.
 * [size](size.md) - Size of an object.
 * [sort](sort.md) - Sort array elements by quick sort algorithm.
 * [sqrt](sqrt.md) - Square root.
-* [subsindex](subsindex.md) - Convert an object to an index vector.
 * [sum](sum.md) - Sum of array elements.
 * [swapbytes](swapbytes.md) - Swap byte ordering.
-* [mtimes](times.md) - Element wise multiplication, .* operator
-* [transpose](transpose.md) - Returns vector or matrix transpose: .' operator.
 * [tril](tril.md) - Lower triangular part of matrix
 * [triu](triu.md) - Upper triangular part of matrix
-* [uminus](uminus.md) - Unary minus, - operator
-* [uplus](uplus.md) - Unary plus, + operator
-* [vertcat](vertcat.md) - Vertical concatenation.