File tree Expand file tree Collapse file tree
lib/node_modules/@stdlib/ndarray/diagonal/docs Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1818 Function options.
1919
2020 options.k: integer (optional)
21- Diagonal offset. The diagonal offset is interpreted as
22- `column - row`. Accordingly, when `options.k = 0` , the function
23- returns the main diagonal; when `options.k > 0` , the function returns
24- the diagonal above the main diagonal; and when `options.k < 0`, the
25- function returns the diagonal below the main diagonal. Default: 0.
21+ Diagonal offset. The diagonal offset is interpreted as `column - row`.
22+ Accordingly, when equal to zero , the function returns the main diagonal.
23+ When greater than zero , the function returns the diagonal above the main
24+ diagonal. When less than zero, the function returns the diagonal below
25+ the main diagonal. Default: 0.
2626
2727 options.dims: ArrayLikeObject<integer> (optional)
2828 Dimension indices defining the plane from which to extract the
You can’t perform that action at this time.
0 commit comments