Skip to content

Commit da8c580

Browse files
committed
docs: add ts declaration file
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 2b55f10 commit da8c580

File tree

1 file changed

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

1 file changed

+101
-0
lines changed
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { Layout } from '@stdlib/types/blas';
24+
25+
/**
26+
* Interface describing `iladlr`.
27+
*/
28+
interface Routine {
29+
/**
30+
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
31+
*
32+
* @param order - storage layout
33+
* @param M - number of rows in `A`
34+
* @param N - number of columns in `A`
35+
* @param A - input matrix
36+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
37+
* @returns index of the last row
38+
*
39+
* @example
40+
* var Float64array = require( '@stdlib/array/float64' );
41+
*
42+
* var A = new Float64array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ]
43+
*
44+
* var out = iladlr( 'row-major', 3, 2, A, 2 );
45+
* // returns 1
46+
*/
47+
( order: Layout, M: number, N: number, A: Float64Array, LDA: number ): number;
48+
49+
/**
50+
* Finds the index of the last non zero row in a matrix `A`.
51+
*
52+
* @param M - number of rows in `A`
53+
* @param N - number of columns in `A`
54+
* @param A - input matrix
55+
* @param strideA1 - stride of the first dimension of `A`
56+
* @param strideA2 - stride of the second dimension of `A`
57+
* @returns index of the last row
58+
*
59+
* @example
60+
* var Float64array = require( '@stdlib/array/float64' );
61+
*
62+
* var A = new Float64array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ]
63+
*
64+
* var out = iladlr.ndarray( 3, 2, A, 2, 1, 0 );
65+
* // returns 1
66+
*/
67+
ndarray( M: number, N: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number ): number;
68+
}
69+
70+
/**
71+
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
72+
*
73+
* @param order - storage layout
74+
* @param M - number of rows in `A`
75+
* @param N - number of columns in `A`
76+
* @param A - input matrix
77+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
78+
* @returns index of the last row
79+
*
80+
* @example
81+
* var Float64array = require( '@stdlib/array/float64' );
82+
*
83+
* var A = new Float64array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ]
84+
*
85+
* var out = iladlr( 'row-major', 3, 2, A, 2 );
86+
* // returns 1
87+
*
88+
* @example
89+
* var Float64array = require( '@stdlib/array/float64' );
90+
*
91+
* var A = new Float64array( [ 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 0.0, 0.0 ] ]
92+
*
93+
* var out = iladlr.ndarray( 3, 2, A, 2, 1, 0 );
94+
* // returns 1
95+
*/
96+
declare var iladlr: Routine;
97+
98+
99+
// EXPORTS //
100+
101+
export = iladlr;

0 commit comments

Comments
 (0)