1 |
|
2 |
|
3 | # Function ones
|
4 |
|
5 | Create a matrix filled with ones. The created matrix can have one or
|
6 | multiple dimensions.
|
7 |
|
8 |
|
9 | ## Syntax
|
10 |
|
11 | ```js
|
12 | math.ones(m)
|
13 | math.ones(m, format)
|
14 | math.ones(m, n)
|
15 | math.ones(m, n, format)
|
16 | math.ones([m, n])
|
17 | math.ones([m, n], format)
|
18 | math.ones([m, n, p, ...])
|
19 | math.ones([m, n, p, ...], format)
|
20 | ```
|
21 |
|
22 | ### Parameters
|
23 |
|
24 | Parameter | Type | Description
|
25 | --------- | ---- | -----------
|
26 | `size` | ...number | Array | The size of each dimension of the matrix
|
27 | `format` | string | The Matrix storage format
|
28 |
|
29 | ### Returns
|
30 |
|
31 | Type | Description
|
32 | ---- | -----------
|
33 | Array | Matrix | number | A matrix filled with ones
|
34 |
|
35 |
|
36 | ## Examples
|
37 |
|
38 | ```js
|
39 | math.ones(3) // returns [1, 1, 1]
|
40 | math.ones(3, 2) // returns [[1, 1], [1, 1], [1, 1]]
|
41 | math.ones(3, 2, 'dense') // returns Dense Matrix [[1, 1], [1, 1], [1, 1]]
|
42 |
|
43 | const A = [[1, 2, 3], [4, 5, 6]]
|
44 | math.ones(math.size(A)) // returns [[1, 1, 1], [1, 1, 1]]
|
45 | ```
|
46 |
|
47 |
|
48 | ## See also
|
49 |
|
50 | [zeros](zeros.md),
|
51 | [identity](identity.md),
|
52 | [size](size.md),
|
53 | [range](range.md)
|