Skip to content

Commit fabb246

Browse files
committed
docs: add docs for zlaswp
--- 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 8e261b4 commit fabb246

File tree

1 file changed

+124
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/zlaswp/docs/types

1 file changed

+124
-0
lines changed
Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
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+
import { Complex128Array } from '@stdlib/types/array';
25+
26+
27+
/**
28+
* Interface describing `zlaswp`.
29+
*/
30+
interface Routine {
31+
/**
32+
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
33+
*
34+
* @param order - storage layout
35+
* @param N - number of columns in `A`
36+
* @param A - input matrix
37+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
38+
* @param k1 - index of first row to interchange
39+
* @param k2 - index of last row to interchange
40+
* @param IPIV - vector of pivot indices
41+
* @param incx - increment between successive values of `IPIV`
42+
* @returns permuted matrix `A`
43+
*
44+
* @example
45+
* var Int32Array = require( '@stdlib/array/int32' );
46+
* var Complex128Array = require( '@stdlib/array/complex128' );
47+
*
48+
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
49+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
50+
*
51+
* zlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, 1 );
52+
* // A => <Complex128Array>[ 5.0, 6.0, 7.0, 8.0, 1.0, 2.0, 3.0, 4.0, 9.0, 10.0, 11.0, 12.0 ]
53+
*/
54+
( order: Layout, N: number, A: Complex128Array, LDA: number, k1: number, k2: number, IPIV: Int32Array, incx: number ): Complex128Array;
55+
56+
/**
57+
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV` and alternative indexing semantics.
58+
*
59+
* @param N - number of columns in `A`
60+
* @param A - input matrix
61+
* @param strideA1 - stride of the first dimension of `A`
62+
* @param strideA2 - stride of the second dimension of `A`
63+
* @param offsetA - index offset for `A`
64+
* @param k1 - index of first row to interchange
65+
* @param k2 - index of last row to interchange
66+
* @param inck - direction in which to apply pivots (-1 to apply pivots in reverse order; otherwise, apply in provided order)
67+
* @param IPIV - vector of pivot indices
68+
* @param strideIPIV - `IPIV` stride length
69+
* @param offsetIPIV - index offset for `IPIV`
70+
* @returns permuted matrix `A`
71+
*
72+
* @example
73+
* var Int32Array = require( '@stdlib/array/int32' );
74+
* var Complex128Array = require( '@stdlib/array/complex128' );
75+
*
76+
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
77+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
78+
*
79+
* zlaswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
80+
* // A => <Complex128Array>[ 5.0, 6.0, 7.0, 8.0, 1.0, 2.0, 3.0, 4.0, 9.0, 10.0, 11.0, 12.0 ]
81+
*/
82+
ndarray( N: number, A: Complex128Array, strideA1: number, strideA2: number, offsetA: number, k1: number, k2: number, inck: number, IPIV: Int32Array, strideIPIV: number, offsetIPIV: number ): Complex128Array;
83+
}
84+
85+
/**
86+
* Performs a series of row interchanges on a matrix `A` using pivot indices stored in `IPIV`.
87+
*
88+
* @param order - storage layout
89+
* @param N - number of columns in `A`
90+
* @param A - input matrix
91+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
92+
* @param k1 - index of first row to interchange
93+
* @param k2 - index of last row to interchange
94+
* @param IPIV - vector of pivot indices
95+
* @param incx - increment between successive values of `IPIV`
96+
* @returns permuted matrix `A`
97+
*
98+
* @example
99+
* var Int32Array = require( '@stdlib/array/int32' );
100+
* var Complex128Array = require( '@stdlib/array/complex128' );
101+
*
102+
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
103+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
104+
*
105+
* zlaswp( 'row-major', 2, A, 2, 0, 2, IPIV, 1 );
106+
* // A => <Complex128Array>[ 5.0, 6.0, 7.0, 8.0, 1.0, 2.0, 3.0, 4.0, 9.0, 10.0, 11.0, 12.0 ]
107+
*
108+
* @example
109+
* var Int32Array = require( '@stdlib/array/int32' );
110+
* var Complex128Array = require( '@stdlib/array/complex128' );
111+
*
112+
* var IPIV = new Int32Array( [ 2, 0, 1 ] );
113+
* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
114+
*
115+
* zlaswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
116+
* // A => <Complex128Array>[ 5.0, 6.0, 7.0, 8.0, 1.0, 2.0, 3.0, 4.0, 9.0, 10.0, 11.0, 12.0 ]
117+
* // A => <Complex128Array>[ 3.0, 4.0, 1.0, 2.0, 5.0, 6.0 ]
118+
*/
119+
declare var zlaswp: Routine;
120+
121+
122+
// EXPORTS //
123+
124+
export = zlaswp;

0 commit comments

Comments
 (0)