Skip to content

Commit d363531

Browse files
committed
docs: add repl
1 parent b1ffa9b commit d363531

File tree

1 file changed

+79
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/iladlr/docs

1 file changed

+79
-0
lines changed
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
2+
{{alias}}( order, M, N, A, LDA )
3+
Return last non-zero row of matrix `A`.
4+
5+
Indexing is relative to the first index. To introduce an offset, use typed
6+
array views.
7+
8+
Parameters
9+
----------
10+
order: string
11+
Row-major (C-style) or column-major (Fortran-style) order. Must be
12+
either 'row-major' or 'column-major'.
13+
14+
M: integer
15+
Number of rows in `A`.
16+
17+
N: integer
18+
Number of columns in `A`.
19+
20+
A: Float64Array
21+
Input matrix `A`.
22+
23+
LDA: integer
24+
Stride of the first dimension of `A` (a.k.a., leading dimension of the
25+
matrix `A`).
26+
27+
Returns
28+
-------
29+
out: integer
30+
Index of last non-zero row.
31+
32+
Examples
33+
--------
34+
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
35+
> {{alias}}( 'row-major', 2, 2, A, 2 )
36+
1
37+
38+
39+
{{alias}}.ndarray( M, N, A, sa1, sa2, oa )
40+
Returns last non-zero row of matrix `A` using alternative indexing
41+
semantics.
42+
43+
While typed array views mandate a view offset based on the underlying
44+
buffer, the offset parameters support indexing semantics based on starting
45+
indices.
46+
47+
Parameters
48+
----------
49+
M: integer
50+
Number of rows in `A`.
51+
52+
N: integer
53+
Number of columns in `A`.
54+
55+
A: Float64Array
56+
Input matrix `A`.
57+
58+
sa1: integer
59+
Stride of the first dimension of `A`.
60+
61+
sa2: integer
62+
Stride of the second dimension of `A`.
63+
64+
oa: integer
65+
Starting index for `A`.
66+
67+
Returns
68+
-------
69+
out: integer
70+
Index of last non-zero row.
71+
72+
Examples
73+
--------
74+
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
75+
> {{alias}}.ndarray( 2, 2, A, 2, 1, 0 )
76+
1
77+
78+
See Also
79+
--------

0 commit comments

Comments
 (0)