mathjs 10.4.0 → 10.4.1

package/types/index.d.ts

@@ -352,6 +352,8 @@ declare namespace math {
     RelationalNode: RelationalNodeCtor;
     SymbolNode: SymbolNodeCtor;
 
+    Matrix: MatrixCtor;
+
     /**
      * If null were to be included in this interface, it would be
      * auto-suggested as an import in VSCode. This causes issues because
@@ -365,7 +367,11 @@ declare namespace math {
     version: string;
 
     expression: MathNode;
-    json: MathJsJson;
+
+    /**
+     * Returns reviver function that can be used as reviver in JSON.parse function.
+     */
+     reviver(): (key: any, value: any) => any;
 
     /*************************************************************************
      * Core functions
@@ -570,6 +576,11 @@ declare namespace math {
      * @returns The created unit
      */
     unit(unit: string): Unit;
+    /**
+     * @param unit The unit to be created
+     * @returns The created unit
+     */
+    unit(unit: Unit): Unit;
     /**
      * @param value The value of the unit to be created
      * @param unit The unit to be created
@@ -767,6 +778,7 @@ declare namespace math {
      * @param y Second value to add
      * @returns Sum of x and y
      */
+    add<T extends MathType>(x: T, y: T): T;
     add(x: MathType, y: MathType): MathType;
 
     /**
@@ -1116,8 +1128,7 @@ declare namespace math {
      * @param y Value to subtract from x
      * @returns Subtraction of x and y
      */
-    subtract(x: number, y: number): number;
-    subtract(x: Unit, y: Unit): Unit;
+    subtract<T extends MathType>(x: T, y: T): T;
     subtract(x: MathType, y: MathType): MathType;
 
     /**
@@ -2254,7 +2265,7 @@ declare namespace math {
      * ‘unbiased’.
      * @returns The standard deviation array
      */
-    std(array: MathArray | Matrix, dimension: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): number[]
+    std(array: MathArray | Matrix, dimension?: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): number[]
     /**
      * Compute the standard deviation of a matrix or a list with values. The
      * standard deviations is defined as the square root of the variance:
@@ -2335,7 +2346,7 @@ declare namespace math {
      * Default value: ‘unbiased’.
      * @returns variance matrix.
      */
-    variance(array: MathArray | Matrix, dimension: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): number[];
+    variance(array: MathArray | Matrix, dimension?: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): number[];
     /**
      * @param array A single matrix
      * @param normalization normalization Determines how to normalize the
@@ -2343,7 +2354,7 @@ declare namespace math {
      * Default value: ‘unbiased’.
      * @returns The variance
      */
-    variance(array: MathArray | Matrix, normalization?: 'unbiased' | 'uncorrected' | 'biased'): number;
+    variance(array: MathArray | Matrix, normalization: 'unbiased' | 'uncorrected' | 'biased'): number;
 
     /*************************************************************************
      * String functions
@@ -2688,7 +2699,86 @@ declare namespace math {
     to(x: Unit | MathArray | Matrix, unit: Unit | string): Unit | MathArray | Matrix;
 
     /*************************************************************************
-     * Utils functions
+     * Utils
+     ************************************************************************/
+     isNumber(x: unknown): x is number;
+
+     isBigNumber(x: unknown): x is BigNumber;
+
+     isComplex(x: unknown): x is Complex;
+
+     isFraction(x: unknown): x is Fraction;
+
+     isUnit(x: unknown): x is Unit;
+
+     isString(x: unknown): x is string;
+
+     isArray: ArrayConstructor['isArray'];
+
+     isMatrix(x: unknown): x is Matrix;
+
+     isCollection(x: unknown): x is (Matrix | any[]);
+
+     isDenseMatrix(x: unknown): x is Matrix;
+
+     isSparseMatrix(x: unknown): x is Matrix;
+
+     isRange(x: unknown): boolean;
+
+     isIndex(x: unknown): x is Index;
+
+     isBoolean(x: unknown): x is boolean;
+
+     isResultSet(x: unknown): boolean;
+
+     isHelp(x: unknown): x is Help;
+
+     isFunction(x: unknown): boolean;
+
+     isDate(x: unknown): x is Date;
+
+     isRegExp(x: unknown): x is RegExp;
+
+     isObject(x: unknown): boolean;
+
+     isNull(x: unknown): x is null;
+
+     isUndefined(x: unknown): x is undefined;
+
+     isAccessorNode(x: unknown): x is AccessorNode;
+
+     isArrayNode(x: unknown): x is ArrayNode;
+
+     isAssignmentNode(x: unknown): x is AssignmentNode;
+
+     isBlockNode(x: unknown): x is BlockNode;
+
+     isConditionalNode(x: unknown): x is ConditionalNode;
+
+     isConstantNode(x: unknown): x is ConstantNode;
+
+     isFunctionAssignmentNode(x: unknown): x is FunctionAssignmentNode;
+
+     isFunctionNode(x: unknown): x is FunctionNode;
+
+     isIndexNode(x: unknown): x is IndexNode;
+
+     isNode(x: unknown): x is MathNodeCommon;
+
+     isObjectNode(x: unknown): x is ObjectNode;
+
+     isOperatorNode(x: unknown): x is OperatorNode;
+
+     isParenthesisNode(x: unknown): x is ParenthesisNode;
+
+     isRangeNode(x: unknown): x is RangeNode;
+
+     isSymbolNode(x: unknown): x is SymbolNode;
+
+     isChain(x: unknown): x is MathJsChain;
+
+    /*************************************************************************
+     * Functions -> Utils
      ************************************************************************/
 
     /**
@@ -3165,6 +3255,10 @@ declare namespace math {
     swapRows(i: number, j: number): Matrix;
   }
 
+  interface MatrixCtor {
+    new(): Matrix;
+  }
+
   interface BigNumber extends Decimal {} // tslint:disable-line no-empty-interface
 
   interface Fraction {
@@ -3522,13 +3616,6 @@ declare namespace math {
     randomSeed?: string | null;
   }
 
-  interface MathJsJson {
-    /**
-     * Returns reviver function that can be used as reviver in JSON.parse function.
-     */
-    reviver(): (key: any, value: any) => any;
-  }
-
   interface MathJsChain {
     done(): any;
 
@@ -4782,14 +4869,13 @@ declare namespace math {
      * values: 'unbiased' (default) The sum of squared errors is divided by
      * (n - 1) 'uncorrected' The sum of squared errors is divided by n
      * 'biased' The sum of squared errors is divided by (n + 1)
-     * @param array A single matrix or multiple scalar values
      * @param dim A dimension to compute standard deviation.
      * @param normalization Determines how to normalize the variance. Choose
      * ‘unbiased’ (default), ‘uncorrected’, or ‘biased’. Default value:
      * ‘unbiased’.
      * @returns The standard deviation
      */
-    std(dim: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
+    std(dim?: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
     /**
      * Compute the standard deviation of a matrix or a list with values. The
      * standard deviations is defined as the square root of the variance:
@@ -4800,13 +4886,12 @@ declare namespace math {
      * values: 'unbiased' (default) The sum of squared errors is divided by
      * (n - 1) 'uncorrected' The sum of squared errors is divided by n
      * 'biased' The sum of squared errors is divided by (n + 1)
-     * @param array A single matrix or multiple scalar values
      * @param normalization Determines how to normalize the variance. Choose
      * ‘unbiased’ (default), ‘uncorrected’, or ‘biased’. Default value:
      * ‘unbiased’.
      * @returns The standard deviation
      */
-    std(normalization?: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
+    std(normalization: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
 
     /**
      * Compute the sum of a matrix or a list with values. In case of a
@@ -4831,7 +4916,7 @@ declare namespace math {
      * Default value: ‘unbiased’.
      * @returns The variance
      */
-    variance(dim: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
+    variance(dim?: number, normalization?: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
     /**
      * Compute the variance of a matrix or a list with values. In case of a
      * (multi dimensional) array or matrix, the variance over all elements
@@ -4848,7 +4933,7 @@ declare namespace math {
      * Default value: ‘unbiased’.
      * @returns The variance
      */
-    variance(normalization?: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
+    variance(normalization: 'unbiased' | 'uncorrected' | 'biased'): MathJsChain;
 
     /*************************************************************************
      * String functions
@@ -5126,4 +5211,5 @@ declare namespace math {
   interface ImportObject {
     [key: string]: any;
   }
+
 }