mathjs 10.5.2 → 10.6.1

package/docs/reference/classes/unit.md

@@ -1,242 +0,0 @@
-<a name="Unit"></a>
-## Unit
-* [new Unit([value], [name])](#new_Unit_new)
-* _instance_
-	* [.valueOf](#Unit+valueOf) ⇒ <code>string</code>
-	* [.clone()](#Unit+clone) ⇒ <code>Unit</code>
-	* [._isDerived()](#Unit+_isDerived) ⇒ <code>boolean</code>
-	* [.hasBase(base)](#Unit+hasBase)
-	* [.equalBase(other)](#Unit+equalBase) ⇒ <code>boolean</code>
-	* [.equals(other)](#Unit+equals) ⇒ <code>boolean</code>
-	* [.multiply(other)](#Unit+multiply) ⇒ <code>Unit</code>
-	* [.divide(other)](#Unit+divide) ⇒ <code>Unit</code>
-	* [.pow(p)](#Unit+pow) ⇒ <code>Unit</code>
-	* [.abs(x)](#Unit+abs) ⇒ <code>Unit</code>
-	* [.to(valuelessUnit)](#Unit+to) ⇒ <code>Unit</code>
-	* [.toNumber(valuelessUnit)](#Unit+toNumber) ⇒ <code>number</code>
-	* [.toNumeric(valuelessUnit)](#Unit+toNumeric) ⇒ <code>number</code> &#124; <code>BigNumber</code> &#124; <code>Fraction</code>
-	* [.toString()](#Unit+toString) ⇒ <code>string</code>
-	* [.toJSON()](#Unit+toJSON) ⇒ <code>Object</code>
-	* [.formatUnits()](#Unit+formatUnits) ⇒ <code>string</code>
-	* [.format([options])](#Unit+format) ⇒ <code>string</code>
-* _static_
-	* [.parse(str)](#Unit.parse) ⇒ <code>Unit</code>
-	* [.isValuelessUnit(name)](#Unit.isValuelessUnit) ⇒ <code>boolean</code>
-	* [.fromJSON(json)](#Unit.fromJSON) ⇒ <code>Unit</code>
-
-<a name="new_Unit_new"></a>
-### new Unit([value], [name])
-A unit can be constructed in the following ways:
-
-```js
-const a = new Unit(value, name)
-const b = new Unit(null, name)
-const c = Unit.parse(str)
-```
-
-Example usage:
-
-```js
-const a = new Unit(5, 'cm')               // 50 mm
-const b = Unit.parse('23 kg')             // 23 kg
-const c = math.in(a, new Unit(null, 'm')  // 0.05 m
-const d = new Unit(9.81, "m/s^2")         // 9.81 m/s^2
-```
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [value] | <code>number</code> &#124; <code>BigNumber</code> &#124; <code>Fraction</code> &#124; <code>Complex</code> &#124; <code>boolean</code> | A value like 5.2 |
-| [name] | <code>string</code> | A unit name like "cm" or "inch", or a derived unit of the form: "u1[^ex1] [u2[^ex2] ...] [/ u3[^ex3] [u4[^ex4]]]", such as "kg m^2/s^2", where each unit appearing after the forward slash is taken to be in the denominator. "kg m^2 s^-2" is a synonym and is also acceptable. Any of the units can include a prefix. |
-
-<a name="Unit+valueOf"></a>
-### unit.valueOf ⇒ <code>string</code>
-Returns the string representation of the unit.
-
-**Kind**: instance property of <code>Unit</code>  
-<a name="Unit+clone"></a>
-### unit.clone() ⇒ <code>Unit</code>
-create a copy of this unit
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - Returns a cloned version of the unit  
-<a name="Unit+_isDerived"></a>
-### unit._isDerived() ⇒ <code>boolean</code>
-Return whether the unit is derived (such as m/s, or cm^2, but not N)
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>boolean</code> - True if the unit is derived  
-<a name="Unit+hasBase"></a>
-### unit.hasBase(base)
-check if this unit has given base unit
-If this unit is a derived unit, this will ALWAYS return false, since by definition base units are not derived.
-
-**Kind**: instance method of <code>Unit</code>  
-
-| Param | Type |
-| --- | --- |
-| base | <code>BASE_UNITS</code> &#124; <code>STRING</code> &#124; <code>undefined</code> | 
-
-<a name="Unit+equalBase"></a>
-### unit.equalBase(other) ⇒ <code>boolean</code>
-Check if this unit has a base or bases equal to another base or bases
-For derived units, the exponent on each base also must match
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>boolean</code> - true if equal base  
-
-| Param | Type |
-| --- | --- |
-| other | <code>Unit</code> | 
-
-<a name="Unit+equals"></a>
-### unit.equals(other) ⇒ <code>boolean</code>
-Check if this unit equals another unit
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>boolean</code> - true if both units are equal  
-
-| Param | Type |
-| --- | --- |
-| other | <code>Unit</code> | 
-
-<a name="Unit+multiply"></a>
-### unit.multiply(other) ⇒ <code>Unit</code>
-Multiply this unit with another one
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - product of this unit and the other unit  
-
-| Param | Type |
-| --- | --- |
-| other | <code>Unit</code> | 
-
-<a name="Unit+divide"></a>
-### unit.divide(other) ⇒ <code>Unit</code>
-Divide this unit by another one
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - result of dividing this unit by the other unit  
-
-| Param | Type |
-| --- | --- |
-| other | <code>Unit</code> | 
-
-<a name="Unit+pow"></a>
-### unit.pow(p) ⇒ <code>Unit</code>
-Calculate the power of a unit
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - The result: this^p  
-
-| Param | Type |
-| --- | --- |
-| p | <code>number</code> &#124; <code>Fraction</code> &#124; <code>BigNumber</code> | 
-
-<a name="Unit+abs"></a>
-### unit.abs(x) ⇒ <code>Unit</code>
-Calculate the absolute value of a unit
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - The result: |x|, absolute value of x  
-
-| Param | Type |
-| --- | --- |
-| x | <code>number</code> &#124; <code>Fraction</code> &#124; <code>BigNumber</code> | 
-
-<a name="Unit+to"></a>
-### unit.to(valuelessUnit) ⇒ <code>Unit</code>
-Convert the unit to a specific unit name.
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - Returns a clone of the unit with a fixed prefix and unit.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| valuelessUnit | <code>string</code> &#124; <code>Unit</code> | A unit without value. Can have prefix, like "cm" |
-
-<a name="Unit+toNumber"></a>
-### unit.toNumber(valuelessUnit) ⇒ <code>number</code>
-Return the value of the unit when represented with given valueless unit
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>number</code> - Returns the unit value as number.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| valuelessUnit | <code>string</code> &#124; <code>Unit</code> | For example 'cm' or 'inch' |
-
-<a name="Unit+toNumeric"></a>
-### unit.toNumeric(valuelessUnit) ⇒ <code>number</code> &#124; <code>BigNumber</code> &#124; <code>Fraction</code>
-Return the value of the unit in the original numeric type
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>number</code> &#124; <code>BigNumber</code> &#124; <code>Fraction</code> - Returns the unit value  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| valuelessUnit | <code>string</code> &#124; <code>Unit</code> | For example 'cm' or 'inch' |
-
-<a name="Unit+toString"></a>
-### unit.toString() ⇒ <code>string</code>
-Get a string representation of the unit.
-
-**Kind**: instance method of <code>Unit</code>  
-<a name="Unit+toJSON"></a>
-### unit.toJSON() ⇒ <code>Object</code>
-Get a JSON representation of the unit
-
-**Kind**: instance method of <code>Unit</code>  
-**Returns**: <code>Object</code> - Returns a JSON object structured as:
-                  `{"mathjs": "Unit", "value": 2, "unit": "cm", "fixPrefix": false}`  
-<a name="Unit+formatUnits"></a>
-### unit.formatUnits() ⇒ <code>string</code>
-Get a string representation of the units of this Unit, without the value.
-
-**Kind**: instance method of <code>Unit</code>  
-<a name="Unit+format"></a>
-### unit.format([options]) ⇒ <code>string</code>
-Get a string representation of the Unit, with optional formatting options.
-
-**Kind**: instance method of <code>Unit</code>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [options] | <code>Object</code> &#124; <code>number</code> &#124; <code>function</code> | Formatting options. See                                                lib/utils/number:format for a                                                description of the available                                                options. |
-
-<a name="Unit.parse"></a>
-### Unit.parse(str) ⇒ <code>Unit</code>
-Parse a string into a unit. The value of the unit is parsed as number,
-BigNumber, or Fraction depending on the math.js config setting `number`.
-
-Throws an exception if the provided string does not contain a valid unit or
-cannot be parsed.
-
-**Kind**: static method of <code>Unit</code>  
-**Returns**: <code>Unit</code> - unit  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| str | <code>string</code> | A string like "5.2 inch", "4e2 cm/s^2" |
-
-<a name="Unit.isValuelessUnit"></a>
-### Unit.isValuelessUnit(name) ⇒ <code>boolean</code>
-Test if the given expression is a unit.
-The unit can have a prefix but cannot have a value.
-
-**Kind**: static method of <code>Unit</code>  
-**Returns**: <code>boolean</code> - true if the given string is a unit  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| name | <code>string</code> | A string to be tested whether it is a value less unit.                        The unit can have prefix, like "cm" |
-
-<a name="Unit.fromJSON"></a>
-### Unit.fromJSON(json) ⇒ <code>Unit</code>
-Instantiate a Unit from a JSON object
-
-**Kind**: static method of <code>Unit</code>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| json | <code>Object</code> | A JSON object structured as:                       `{"mathjs": "Unit", "value": 2, "unit": "cm", "fixPrefix": false}` |
-

package/docs/reference/classes.md

@@ -1,86 +0,0 @@
-
-# Class Reference
-
-This page lists all the various class types in Math.js. Every top-level function is listed here and links to its detailed reference to other parts of the documentation.
-
-## math
-
-The "math" namespace contains the entire math.js functionality. All of the mathematical functions are available in the "math" namespace, and allow for inputs of various types.
-
-- [Function reference](functions.md)
-- [Constant reference](constants.md)
-
-
-## Unit
-
-Stores values for a scalar unit and its postfix. (eg `100 mm` or `100 kg`). Although the `Unit` class contains public functions documented as follows, using the following API directly is *not* recommended. Prefer using the functions in the "math" namespace wherever possible.
-
-- [Overview](../datatypes/units.md)
-- [Class API](classes/unit.md)
-
-
-## Fraction
-
-Stores values for a fractional number.
-
-- [Overview](../datatypes/fractions.md)
-- [Class API](https://github.com/infusion/Fraction.js/)
-
-## BigNumber
-
-Stores values for a arbitrary-precision floating point number.
-
-- [Overview](../datatypes/bignumbers.md)
-- [Class API](https://mikemcl.github.io/decimal.js/)
-
-
-## Matrix
-
-Two types of matrix classes are available in math.js, for storage of dense and sparse matrices. Although they contain public functions documented as follows, using the following API directly is *not* recommended. Prefer using the functions in the "math" namespace wherever possible.
-
-- [Overview](../datatypes/matrices.md)
-- [DenseMatrix](classes/densematrix.md)
-- [SparseMatrix](classes/sparsematrix.md)
-
-Classes used internally that may be of use to developers:
-
-- [Index](classes/matrixindex.md)
-- [Range](classes/matrixrange.md)
-- [ResultSet](classes/matrixrange.md)
-- [FibonacciHeap](classes/fibonacciheap.md)
-
-## Complex
-
-Stores values for a complex number.
-
-- [Overview](../datatypes/complex_numbers.md)
-- [Class API](https://github.com/infusion/Complex.js/)
-
-## Parser
-
-The Parser object returned by `math.parser()`.
-
-- [Overview](../expressions/parsing.md)
-
-## Node
-
-A node in an expression-tree, which can be used to analyze, manipulate, and evaluate expressions.
-
-- [Overview](../expressions/expression_trees.md)
-
-`Node` is the base class of all other node classes:
-
-- [AccessorNode](../expressions/expression_trees.md#accessornode)
-- [ArrayNode](../expressions/expression_trees.md#arraynode)
-- [AssignmentNode](../expressions/expression_trees.md#assignmentnode)
-- [BlockNode](../expressions/expression_trees.md#blocknode)
-- [ConditionalNode](../expressions/expression_trees.md#conditionalnode)
-- [ConstantNode](../expressions/expression_trees.md#constantnode)
-- [FunctionAssignmentNode](../expressions/expression_trees.md#functionassignmentnode)
-- [FunctionNode](../expressions/expression_trees.md#functionnode)
-- [IndexNode](../expressions/expression_trees.md#indexnode)
-- [ObjectNode](../expressions/expression_trees.md#objectnode)
-- [OperatorNode](../expressions/expression_trees.md#operatornode)
-- [ParenthesisNode](../expressions/expression_trees.md#parenthesisnode)
-- [RangeNode](../expressions/expression_trees.md#rangenode)
-- [SymbolNode](../expressions/expression_trees.md#symbolnode)

package/docs/reference/constants.md

@@ -1,29 +0,0 @@
-# Constant reference
-
-Math.js contains the following constants. 
-
-Constant        | Description | Value
---------------- | ----------- | -----
-`e`, `E`        | Euler's number, the base of the natural logarithm. | 2.718281828459045
-`i`             | Imaginary unit, defined as `i * i = -1`. A complex number is described as `a + b * i`, where a is the real part, and b is the imaginary part. | `sqrt(-1)`
-`Infinity`      | Infinity, a number which is larger than the maximum number that can be handled by a floating point number. | `Infinity`
-`LN2`           | Returns the natural logarithm of 2. | `0.6931471805599453`
-`LN10`          | Returns the natural logarithm of 10. | `2.302585092994046`
-`LOG2E`         | Returns the base-2 logarithm of E. | `1.4426950408889634`
-`LOG10E`        | Returns the base-10 logarithm of E. | `0.4342944819032518`
-`NaN`           | Not a number. | `NaN`
-`null`          | Value null. | `null`
-`phi`           | Phi is the golden ratio. Two quantities are in the golden ratio if their ratio is the same as the ratio of their sum to the larger of the two quantities. Phi is defined as `(1 + sqrt(5)) / 2` | `1.618033988749895`
-`pi`, `PI`      | The number pi is a mathematical constant that is the ratio of a circle\'s circumference to its diameter. | `3.141592653589793`
-`SQRT1_2`       | Returns the square root of 1/2. | `0.7071067811865476`
-`SQRT2`         | Returns the square root of 2. | `1.4142135623730951`
-`tau`           | Tau is the ratio constant of a circle\'s circumference to radius, equal to `2 * pi`. | `6.283185307179586`
-`undefined`     | An undefined value. Preferably, use `null` to indicate undefined values. | `undefined`
-`version`       | Returns the version number of math.js. | For example `0.24.1`
-
-Example usage:
-
-```js
-math.sin(math.pi / 4)          // 0.70711
-math.multiply(math.i, math.i)  // -1
-```

package/docs/reference/functions/abs.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function abs
-
-Calculate the absolute value of a number. For matrices, the function is
-evaluated element wise.
-
-
-## Syntax
-
-```js
-math.abs(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  A number or matrix for which to get the absolute value
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Fraction &#124; Complex &#124; Array &#124; Matrix &#124; Unit |  Absolute value of `x`
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.abs(3.5)                // returns number 3.5
-math.abs(-4.2)               // returns number 4.2
-
-math.abs([3, -5, -1, 0, 2])  // returns Array [3, 5, 1, 0, 2]
-```
-
-
-## See also
-
-[sign](sign.md)

package/docs/reference/functions/acos.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function acos
-
-Calculate the inverse cosine of a value.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.acos(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | The arc cosine of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.acos(0.5)           // returns number 1.0471975511965979
-math.acos(math.cos(1.5)) // returns number 1.5
-
-math.acos(2)             // returns Complex 0 + 1.3169578969248166 i
-```
-
-
-## See also
-
-[cos](cos.md),
-[atan](atan.md),
-[asin](asin.md)

package/docs/reference/functions/acosh.md

@@ -1,47 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function acosh
-
-Calculate the hyperbolic arccos of a value,
-defined as `acosh(x) = ln(sqrt(x^2 - 1) + x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.acosh(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | Hyperbolic arccosine of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.acosh(1.5)       // returns 0.9624236501192069
-```
-
-
-## See also
-
-[cosh](cosh.md),
-[asinh](asinh.md),
-[atanh](atanh.md)

package/docs/reference/functions/acot.md

@@ -1,48 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function acot
-
-Calculate the inverse cotangent of a value, defined as `acot(x) = atan(1/x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.acot(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | The arc cotangent of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.acot(0.5)           // returns number 0.4636476090008061
-math.acot(math.cot(1.5)) // returns number 1.5
-
-math.acot(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-```
-
-
-## See also
-
-[cot](cot.md),
-[atan](atan.md)

package/docs/reference/functions/acoth.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function acoth
-
-Calculate the hyperbolic arccotangent of a value,
-defined as `acoth(x) = atanh(1/x) = (ln((x+1)/x) + ln(x/(x-1))) / 2`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.acoth(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | Hyperbolic arccotangent of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.acoth(0.5)       // returns 0.8047189562170503
-```
-
-
-## See also
-
-[acsch](acsch.md),
-[asech](asech.md)

package/docs/reference/functions/acsc.md

@@ -1,49 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function acsc
-
-Calculate the inverse cosecant of a value, defined as `acsc(x) = asin(1/x)`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.acsc(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | The arc cosecant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.acsc(0.5)           // returns number 0.5235987755982989
-math.acsc(math.csc(1.5)) // returns number ~1.5
-
-math.acsc(2)             // returns Complex 1.5707963267948966 -1.3169578969248166 i
-```
-
-
-## See also
-
-[csc](csc.md),
-[asin](asin.md),
-[asec](asec.md)

package/docs/reference/functions/acsch.md

@@ -1,46 +0,0 @@
-<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
-
-# Function acsch
-
-Calculate the hyperbolic arccosecant of a value,
-defined as `acsch(x) = asinh(1/x) = ln(1/x + sqrt(1/x^2 + 1))`.
-
-For matrices, the function is evaluated element wise.
-
-
-## Syntax
-
-```js
-math.acsch(x)
-```
-
-### Parameters
-
-Parameter | Type | Description
---------- | ---- | -----------
-`x` | number &#124; Complex &#124; Array &#124; Matrix | Function input
-
-### Returns
-
-Type | Description
----- | -----------
-number &#124; Complex &#124; Array &#124; Matrix | Hyperbolic arccosecant of x
-
-
-### Throws
-
-Type | Description
----- | -----------
-
-
-## Examples
-
-```js
-math.acsch(0.5)       // returns 1.4436354751788103
-```
-
-
-## See also
-
-[asech](asech.md),
-[acoth](acoth.md)