|
| 1 | + |
| 2 | +{{alias}}( order, uplo, M, N, A, LDA, alpha, beta ) |
| 3 | + Initialises an M by N matrix `A` to `beta` on the diagonals and `alpha` |
| 4 | + on the off diagonals. |
| 5 | + |
| 6 | + Indexing is relative to the first index. To introduce an offset, use typed |
| 7 | + array views. |
| 8 | + |
| 9 | + Parameters |
| 10 | + ---------- |
| 11 | + order: string |
| 12 | + Row-major (C-style) or column-major (Fortran-style) order. Must be |
| 13 | + either 'row-major' or 'column-major'. |
| 14 | + |
| 15 | + uplo: string |
| 16 | + Specifies whether to set the upper or lower triangular/trapezoidal part |
| 17 | + of a matrix `A`. |
| 18 | + |
| 19 | + M: integer |
| 20 | + Number of rows in `A`. |
| 21 | + |
| 22 | + N: integer |
| 23 | + Number of columns in `A`. |
| 24 | + |
| 25 | + A: Float64Array |
| 26 | + Input matrix `A`. |
| 27 | + |
| 28 | + LDA: integer |
| 29 | + Stride of the first dimension of `A` (a.k.a., leading dimension of the |
| 30 | + matrix `A`). |
| 31 | + |
| 32 | + alpha: number |
| 33 | + Number to set on the off-diagonal elements. |
| 34 | + |
| 35 | + beta: number |
| 36 | + Number to set on the diagonal elements. |
| 37 | + |
| 38 | + Returns |
| 39 | + ------- |
| 40 | + A: Float64Array |
| 41 | + Output matrix. |
| 42 | + |
| 43 | + Examples |
| 44 | + -------- |
| 45 | + > var A = new {{alias:@stdlib/array/float64}}( 4 ); |
| 46 | + > {{alias}}( 'row-major', 'all', 2, 2, A, 2, 0.0, 1.0 ) |
| 47 | + <Float64Array>[ 1.0, 0.0, 0.0, 1.0 ] |
| 48 | + |
| 49 | + |
| 50 | +{{alias}}.ndarray( uplo, M, N, A, sa1, sa2, oa, alpha, beta ) |
| 51 | + Initialises an M by N matrix `A` to `beta` on the diagonals and `alpha` |
| 52 | + on the off diagonals using alternative indexing semantics. |
| 53 | + |
| 54 | + While typed array views mandate a view offset based on the underlying |
| 55 | + buffer, the offset parameters support indexing semantics based on starting |
| 56 | + indices. |
| 57 | + |
| 58 | + Parameters |
| 59 | + ---------- |
| 60 | + uplo: string |
| 61 | + Specifies whether to set the upper or lower triangular/trapezoidal part |
| 62 | + of a matrix `A`. |
| 63 | + |
| 64 | + M: integer |
| 65 | + Number of rows in `A`. |
| 66 | + |
| 67 | + N: integer |
| 68 | + Number of columns in `A`. |
| 69 | + |
| 70 | + A: Float64Array |
| 71 | + Input matrix `A`. |
| 72 | + |
| 73 | + sa1: integer |
| 74 | + Stride of the first dimension of `A`. |
| 75 | + |
| 76 | + sa2: integer |
| 77 | + Stride of the second dimension of `A`. |
| 78 | + |
| 79 | + oa: integer |
| 80 | + Starting index for `A`. |
| 81 | + |
| 82 | + alpha: number |
| 83 | + Number to set on the off-diagonal elements. |
| 84 | + |
| 85 | + beta: number |
| 86 | + Number to set on the diagonal elements. |
| 87 | + |
| 88 | + Returns |
| 89 | + ------- |
| 90 | + A: Float64Array |
| 91 | + Output matrix. |
| 92 | + |
| 93 | + Examples |
| 94 | + -------- |
| 95 | + > var A = new {{alias:@stdlib/array/float64}}( 4 ); |
| 96 | + > {{alias}}.ndarray( 'all', 2, 2, A, 2, 1, 0, 0.0, 1.0 ) |
| 97 | + <Float64Array>[ 1.0, 0.0, 0.0, 1.0 ] |
| 98 | + |
| 99 | + See Also |
| 100 | + -------- |
0 commit comments