58 lines
1.2 KiB
Markdown
58 lines
1.2 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function identity
|
||
|
|
|
||
|
|
Create a 2-dimensional identity matrix with size m x n or n x n.
|
||
|
|
The matrix has ones on the diagonal and zeros elsewhere.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.identity(n)
|
||
|
|
math.identity(n, format)
|
||
|
|
math.identity(m, n)
|
||
|
|
math.identity(m, n, format)
|
||
|
|
math.identity([m, n])
|
||
|
|
math.identity([m, n], format)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`size` | ...number | Matrix | Array | The size for the matrix
|
||
|
|
`format` | string | The Matrix storage format
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
Matrix | Array | number | A matrix with ones on the diagonal.
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.identity(3) // returns [[1, 0, 0], [0, 1, 0], [0, 0, 1]]
|
||
|
|
math.identity(3, 2) // returns [[1, 0], [0, 1], [0, 0]]
|
||
|
|
|
||
|
|
const A = [[1, 2, 3], [4, 5, 6]]
|
||
|
|
math.identity(math.size(A)) // returns [[1, 0, 0], [0, 1, 0]]
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[diag](diag.md),
|
||
|
|
[ones](ones.md),
|
||
|
|
[zeros](zeros.md),
|
||
|
|
[size](size.md),
|
||
|
|
[range](range.md)
|