Perform a series of row interchanges on an input matrix.
npm install @stdlib/lapack-base-claswpWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Perform a series of row interchanges on an input matrix.
``bash`
npm install @stdlib/lapack-base-claswp
`javascript`
var claswp = require( '@stdlib/lapack-base-claswp' );
#### claswp( N, A, LDA, k1, k2, IPIV, incx )
Performs a series of row interchanges on an input matrix A using pivot indices stored in IPIV.
`javascript
var Int32Array = require( '@stdlib/array-int32' );
var Complex64Array = require( '@stdlib/array-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
var IPIV = new Int32Array( [ 2, 0, 1 ] );
claswp( 'row-major', 2, A, 2, 0, 2, IPIV, 1 );
// A =>
`
The function has the following parameters:
- order: storage layout.
- N: number of columns in A.Complex64Array
- A: input matrix stored in linear memory as a [][@stdlib/array/complex64].A
- LDA: stride of the first dimension of (a.k.a., leading dimension of the matrix A).incx
- k1: index of first row to interchange when is positive and the index of the last row to interchange when incx is negative.incx
- k2: index of last row to interchange when is positive and the index of the first row to interchange when incx is negative.Int32Array
- IPIV: vector of pivot indices as an [][@stdlib/array/int32]. Must contain at least k1+(k2-k1)abs(incx) elements. Only the elements in positions k1 through k1+(k2-k1)abs(incx) are accessed.IPIV
- incx: increment between successive values of . Elements from IPIV are accessed according to IPIV[k1+(k-k1)*abs(incx)] = j, thus implying that rows k and j should be interchanged. If incx is negative, the pivots are applied in reverse order.
The sign of the increment parameter incx determines the order in which pivots are applied. For example, to apply pivots in reverse order,
`javascript
var Int32Array = require( '@stdlib/array-int32' );
var Complex64Array = require( '@stdlib/array-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
var IPIV = new Int32Array( [ 2, 0, 1 ] );
claswp( 'row-major', 2, A, 2, 0, 2, IPIV, -1 );
// A =>
`
To perform strided access over IPIV, provide an abs(incx) value greater than one. For example, to access every other element in IPIV,
`javascript
var Int32Array = require( '@stdlib/array-int32' );
var Complex64Array = require( '@stdlib/array-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
var IPIV = new Int32Array( [ 2, 999, 0, 999, 1 ] );
claswp( 'row-major', 2, A, 2, 0, 2, IPIV, 2 );
// A =>
`
Note that indexing is relative to the first index. To introduce an offset, use [typed array][mdn-typed-array] views.
`javascript
var Int32Array = require( '@stdlib/array-int32' );
var Complex64Array = require( '@stdlib/array-complex64' );
// Initial arrays...
var A0 = new Complex64Array( [ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
var IPIV0 = new Int32Array( [ 0, 2, 0, 1 ] );
// Create offset views...
var A1 = new Complex64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var IPIV1 = new Int32Array( IPIV0.buffer, IPIV0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
claswp( 'row-major', 2, A1, 2, 0, 2, IPIV1, 1 );
// A0 =>
`
#### claswp.ndarray( N, A, sa1, sa2, oa, k1, k2, inck, IPIV, si, oi )
Performs a series of row interchanges on the matrix A using pivot indices stored in IPIV and alternative indexing semantics.
`javascript
var Int32Array = require( '@stdlib/array-int32' );
var Complex64Array = require( '@stdlib/array-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
var IPIV = new Int32Array( [ 2, 0, 1 ] );
claswp.ndarray( 2, A, 2, 1, 0, 0, 2, 1, IPIV, 1, 0 );
// A =>
`
The function has the following additional parameters:
- N: number of columns in A.Complex64Array
- A: input matrix stored in linear memory as a [][@stdlib/array/complex64].A
- sa1: stride of the first dimension of .A
- sa2: stride of the second dimension of .A
- oa: starting index for .inck
- k1: index of first row to interchange when is positive and the index of the last row to interchange when inck is negative.inck
- k2: index of last row to interchange when is positive and the index of the first row to interchange when inck is negative.Int32Array
- inck: direction in which to apply pivots (-1 to apply pivots in reverse order; otherwise, apply in provided order).
- IPIV: vector of pivot indices as an [][@stdlib/array/int32].IPIV
- si: index increment for .IPIV
- oi: starting index for .
While [typed array][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
`javascript
var Int32Array = require( '@stdlib/array-int32' );
var Complex64Array = require( '@stdlib/array-complex64' );
var A = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
var IPIV = new Int32Array( [ 0, 0, 2, 0, 1 ] );
claswp.ndarray( 2, A, 2, 1, 2, 0, 2, 1, IPIV, 1, 2 );
// A =>
`
- Both functions access k2-k1+1 elements from IPIV.claswp
- While conflates the order in which pivots are applied with the order in which elements in IPIV are accessed, the ndarray method delineates control of those behaviors with separate parameters inck and si.claswp()
- corresponds to the [LAPACK][LAPACK] function [claswp][lapack-claswp].
`javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var Int32Array = require( '@stdlib/array-int32' );
var ndarray2array = require( '@stdlib/ndarray-base-to-array' );
var claswp = require( '@stdlib/lapack-base-claswp' );
// Specify matrix meta data:
var shape = [ 4, 2 ];
var strides = [ 1, 4 ];
var offset = 0;
var order = 'column-major';
// Create a matrix stored in linear memory:
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0 ] );
console.log( ndarray2array( A, shape, strides, offset, order ) );
// Define a vector of pivot indices:
var IPIV = new Int32Array( [ 2, 0, 3, 1 ] );
// Interchange rows:
claswp( order, shape[ 1 ], A, strides[ 1 ], 0, shape[ 0 ]-1, IPIV, 1 );
console.log( ndarray2array( A, shape, strides, offset, order ) );
`
*
`c`
TODO
#### TODO
TODO.
`c`
TODO
TODO
`c`
TODO
`c`
TODO
*
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/lapack-base-claswp.svg
[npm-url]: https://npmjs.org/package/@stdlib/lapack-base-claswp
[test-image]: https://github.com/stdlib-js/lapack-base-claswp/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/lapack-base-claswp/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/lapack-base-claswp/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/lapack-base-claswp?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/lapack-base-claswp/tree/deno
[deno-readme]: https://github.com/stdlib-js/lapack-base-claswp/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/lapack-base-claswp/tree/umd
[umd-readme]: https://github.com/stdlib-js/lapack-base-claswp/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/lapack-base-claswp/tree/esm
[esm-readme]: https://github.com/stdlib-js/lapack-base-claswp/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/lapack-base-claswp/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/lapack-base-claswp/main/LICENSE
[lapack]: https://www.netlib.org/lapack/explore-html/
[lapack-claswp]: https://www.netlib.org/lapack/explore-html/d1/d7e/group__laswp_ga9171d769b6ff8099934a845677e336b1.html
[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64
[@stdlib/array/int32]: https://www.npmjs.com/package/@stdlib/array-int32
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray