Skip to content

Commit

Permalink
docs: add repl
Browse files Browse the repository at this point in the history
  • Loading branch information
Pranavchiku committed Sep 2, 2024
1 parent b1ffa9b commit d363531
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions lib/node_modules/@stdlib/lapack/base/iladlr/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@

{{alias}}( order, M, N, A, LDA )
Return last non-zero row of matrix `A`.

Indexing is relative to the first index. To introduce an offset, use typed
array views.

Parameters
----------
order: string
Row-major (C-style) or column-major (Fortran-style) order. Must be
either 'row-major' or 'column-major'.

M: integer
Number of rows in `A`.

N: integer
Number of columns in `A`.

A: Float64Array
Input matrix `A`.

LDA: integer
Stride of the first dimension of `A` (a.k.a., leading dimension of the
matrix `A`).

Returns
-------
out: integer
Index of last non-zero row.

Examples
--------
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> {{alias}}( 'row-major', 2, 2, A, 2 )
1


{{alias}}.ndarray( M, N, A, sa1, sa2, oa )
Returns last non-zero row of matrix `A` using alternative indexing
semantics.

While typed array views mandate a view offset based on the underlying
buffer, the offset parameters support indexing semantics based on starting
indices.

Parameters
----------
M: integer
Number of rows in `A`.

N: integer
Number of columns in `A`.

A: Float64Array
Input matrix `A`.

sa1: integer
Stride of the first dimension of `A`.

sa2: integer
Stride of the second dimension of `A`.

oa: integer
Starting index for `A`.

Returns
-------
out: integer
Index of last non-zero row.

Examples
--------
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
> {{alias}}.ndarray( 2, 2, A, 2, 1, 0 )
1

See Also
--------

0 comments on commit d363531

Please sign in to comment.