All files main.js

100% Statements 82/82
100% Branches 9/9
100% Functions 1/1
100% Lines 82/82

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 833x 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 44x 44x 44x 44x 44x 13x 13x 44x 12x 12x 12x 44x 19x 19x 19x 19x 44x 4x 4x 27x 44x 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 isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var stride2offset = require( '@stdlib/strided/base/stride2offset' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var ndarray = require( './ndarray.js' );
 
 
// MAIN //
 
/**
* Permutes the rows of a matrix according to the specified strided permutation array.
*
* @param {string} order - storage layout
* @param {NonNegativeInteger} M - number of rows in matrix `A`
* @param {NonNegativeInteger} N - number of columns in matrix `A`
* @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`)
* @param {Collection} ip - permutation index array
* @param {integer} strideIp - stride length for `ip`
* @param {Collection} workspace - workspace array for storing a row during permutation
* @param {integer} strideW - stride length for `workspace`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fifth argument must be a valid stride
* @returns {Collection} `A`
*
* @example
* var A = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
* var ip = [ 2, 0, 1 ];
* var workspace = [ 0.0, 0.0 ];
*
* gpermuteRows( 'row-major', 3, 2, A, 2, ip, 1, workspace, 1 );
* // A => [ 5.0, 6.0, 1.0, 2.0, 3.0, 4.0 ]
*/
function gpermuteRows( order, M, N, A, LDA, ip, strideIp, workspace, strideW ) {
	var sa1;
	var sa2;
	var s;
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isColumnMajor( order ) ) {
		s = M;
		sa1 = 1;
		sa2 = LDA;
	} else { // order === 'row-major'
		s = N;
		sa1 = LDA;
		sa2 = 1;
	}
	if ( LDA < max( 1, s ) ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', s, LDA ) );
	}
	return ndarray( M, N, A, sa1, sa2, 0, ip, strideIp, stride2offset( M, strideIp ), workspace, strideW, stride2offset( N, strideW ) ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = gpermuteRows;