mathjs
Version:
Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif
54 lines (38 loc) • 1.45 kB
Markdown
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
# Function getMatrixDataType
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
```js
math.getMatrixDataType(x)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | ...Matrix | Array | The Matrix with values.
### Returns
Type | Description
---- | -----------
string | A string representation of the matrix type
## Examples
```js
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](SparseMatrix.md),
[DenseMatrix](DenseMatrix.md)