All files main.js

100% Statements 94/94
100% Branches 13/13
100% Functions 1/1
100% Lines 94/94

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 953x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 46x 46x 46x 46x 46x 46x 46x 13x 13x 33x 46x 5x 5x 28x 46x 4x 4x 46x 16x 16x 16x 46x 8x 8x 8x 8x 46x 4x 4x 20x 46x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var ndarray = require( './ndarray.js' );
 
 
// MAIN //
 
/**
* Interchanges two columns in a matrix `A`.
*
* ## Notes
*
* -   If provided negative column indices, the function resolves the indices relative to the last column, with the last column corresponding to `-1`.
*
* @param {string} order - storage layout of `A`
* @param {NonNegativeInteger} M - number of rows in matrix `A`
* @param {NonNegativeInteger} N - number of columns in matrix `A`
* @param {integer} i - index of the first column to interchange
* @param {integer} j - index of the second column to interchange
* @param {Collection} A - input matrix
* @param {PositiveInteger} LDA - stride length for the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fourth argument must resolve to a valid column index
* @throws {RangeError} fifth argument must resolve to a valid column index
* @throws {RangeError} seventh argument must be greater than or equal to max(1,M) when `A` is stored in column-major order and max(1,N) when `A` is stored in row-major order
* @returns {Collection} `A`
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
*
* gswapColumns( 'row-major', 3, 2, 0, 1, A, 2 );
* // A => [ 2.0, 1.0, 4.0, 3.0, 6.0, 5.0 ]
*/
function gswapColumns( order, M, N, i, j, A, LDA ) {
	var sa1;
	var sa2;
	var io;
	var jo;
	var s;
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	io = normalizeIndex( i, N-1 );
	if ( io < 0 ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must resolve to a valid column index. Value: `%d`.', i ) );
	}
	jo = normalizeIndex( j, N-1 );
	if ( jo < 0 ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must resolve to a valid column index. Value: `%d`.', j ) );
	}
	if ( isRowMajor( order ) ) {
		s = N;
		sa1 = LDA;
		sa2 = 1;
	} else {
		s = M;
		sa1 = 1;
		sa2 = LDA;
	}
	if ( LDA < max( 1, s ) ) {
		throw new RangeError( format( 'invalid argument. Seventh argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
	}
	return ndarray( M, N, io, jo, A, sa1, sa2, 0 );
}
 
 
// EXPORTS //
 
module.exports = gswapColumns;