53 lines
1.8 KiB
JavaScript
53 lines
1.8 KiB
JavaScript
|
import { factory } from '../../utils/factory.js';
|
||
|
|
import { getArrayDataType } from '../../utils/array.js';
|
||
|
|
import { typeOf } from '../../utils/is.js';
|
||
|
|
var name = 'getMatrixDataType';
|
||
|
|
var dependencies = ['typed'];
|
||
|
|
export var createGetMatrixDataType = /* #__PURE__ */factory(name, dependencies, _ref => {
|
||
|
|
var {
|
||
|
|
typed
|
||
|
|
} = _ref;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Find the data type of all elements in a matrix or array,
|
||
|
|
* for example 'number' if all items are a number and 'Complex' if all values
|
||
|
|
* are complex numbers.
|
||
|
|
* If a matrix contains more than one data type, it will return 'mixed'.
|
||
|
|
*
|
||
|
|
* Syntax:
|
||
|
|
*
|
||
|
|
* math.getMatrixDataType(x)
|
||
|
|
*
|
||
|
|
* Examples:
|
||
|
|
*
|
||
|
|
* const x = [ [1, 2, 3], [4, 5, 6] ]
|
||
|
|
* const mixedX = [ [1, true], [2, 3] ]
|
||
|
|
* const fractionX = [ [math.fraction(1, 3)], [math.fraction(1, 3] ]
|
||
|
|
* const unitX = [ [math.unit('5cm')], [math.unit('5cm')] ]
|
||
|
|
* const bigNumberX = [ [math.bignumber(1)], [math.bignumber(0)] ]
|
||
|
|
* const sparse = math.sparse(x)
|
||
|
|
* const dense = math.matrix(x)
|
||
|
|
* math.getMatrixDataType(x) // returns 'number'
|
||
|
|
* math.getMatrixDataType(sparse) // returns 'number'
|
||
|
|
* math.getMatrixDataType(dense) // returns 'number'
|
||
|
|
* math.getMatrixDataType(mixedX) // returns 'mixed'
|
||
|
|
* math.getMatrixDataType(fractionX) // returns 'Fraction'
|
||
|
|
* math.getMatrixDataType(unitX) // returns 'Unit'
|
||
|
|
* math.getMatrixDataType(bigNumberX) // return 'BigNumber'
|
||
|
|
*
|
||
|
|
* See also:
|
||
|
|
* SparseMatrix, DenseMatrix
|
||
|
|
*
|
||
|
|
* @param {...Matrix | Array} x The Matrix with values.
|
||
|
|
*
|
||
|
|
* @return {string} A string representation of the matrix type
|
||
|
|
*/
|
||
|
|
return typed(name, {
|
||
|
|
Array: function Array(x) {
|
||
|
|
return getArrayDataType(x, typeOf);
|
||
|
|
},
|
||
|
|
Matrix: function Matrix(x) {
|
||
|
|
return x.getDataType();
|
||
|
|
}
|
||
|
|
});
|
||
|
|
});
|