All files dlapmr.js

100% Statements 83/83
100% Branches 10/10
100% Functions 1/1
100% Lines 83/83

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 842x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 18x 18x 18x 18x 4x 4x 18x 2x 2x 18x 12x 2x 2x 10x 10x 10x 18x 1x 1x 11x 18x 2x 2x 2x 2x 2x  
/**
* @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 max = require( '@stdlib/math/base/special/max' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Rearranges the rows of an `M` by `N` matrix `X` as specified by a permutation vector `K`.
*
* @param {string} order - storage layout
* @param {boolean} forwrd - boolean indicating whether to apply a forward permutation
* @param {NonNegativeInteger} M - number of rows of `X`
* @param {NonNegativeInteger} N - number of columns of `X`
* @param {Float64Array} X - input matrix
* @param {PositiveInteger} LDX - leading dimension of `X`
* @param {Int32Array} K - permutation vector
* @param {integer} strideK - stride length of `K`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} sixth argument must be greater than or equal to max(1,N)
* @throws {RangeError} eighth argument must be a non-zero integer
* @returns {Float64Array} permuted matrix `X`
*
* @example
* var Int32Array = require( '@stdlib/array/int32' );
* var Float64Array = require( '@stdlib/array/float64' );
*
* var X = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); // => [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
* var K = new Int32Array( [ 2, 0, 1 ] );
*
* dlapmr( 'row-major', true, 3, 2, X, 2, K, 1 );
* // X => <Float64Array>[ 5.0, 6.0, 1.0, 2.0, 3.0, 4.0 ]
*/
function dlapmr( order, forwrd, M, N, X, LDX, K, strideK ) {
	var sx1;
	var sx2;
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isColumnMajor( order ) ) {
		sx1 = 1;
		sx2 = LDX;
	} else { // order === 'row-major'
		if ( LDX < max( 1, N ) ) {
			throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDX ) );
		}
		sx1 = LDX;
		sx2 = 1;
	}
	if ( strideK === 0 ) {
		throw new RangeError( format( 'invalid argument. Eighth argument must be a non-zero integer. Value: `%d`.', strideK ) );
	}
	return base( forwrd, M, N, X, sx1, sx2, 0, K, strideK, 0 );
}
 
 
// EXPORTS //
 
module.exports = dlapmr;