All files ndarray.js

100% Statements 91/91
100% Branches 12/12
100% Functions 1/1
100% Lines 91/91

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 922x 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 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 106x 106x 13x 13x 106x 13x 13x 106x 13x 13x 106x 3x 3x 106x 3x 3x 61x 106x 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.
*/
 
/* eslint-disable max-len, max-params */
 
'use strict';
 
// MODULES //
 
var format = require( '@stdlib/string/format' );
var isOperationSide = require( '@stdlib/blas/base/assert/is-operation-side' );
var isDirection = require( './is_direction.js' );
var isPivot = require( './is_pivot.js' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Applies a sequence of plane rotations to a general rectangular matrix using alternative indexing semantics.
*
* @param {string} side - specifies the side where plane rotation matrix `P` is applied to `A`
* @param {string} pivot - specifies the plane for which `P(k)` is a plane rotation matrix
* @param {string} direct - specifies whether `P` is a forward or backward sequence of plane rotations
* @param {NonNegativeInteger} M - number of rows of `A`
* @param {NonNegativeInteger} N - number of columns of `A`
* @param {Float64Array} C - array of cosines of the plane rotations
* @param {integer} strideC - stride for `C`
* @param {NonNegativeInteger} offsetC - starting index for `C`
* @param {Float64Array} S - array of sines of the plane rotations
* @param {integer} strideS - stride for `S`
* @param {NonNegativeInteger} offsetS - starting index for `S`
* @param {Float64Array} A - input/output matrix
* @param {integer} strideA1 - stride of the first dimension of `A`
* @param {integer} strideA2 - stride of the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index for `A`
* @throws {TypeError} first argument must be a valid side
* @throws {TypeError} second argument must be a valid pivot type
* @throws {TypeError} third argument must be a valid direction
* @throws {RangeError} fourth argument must be a non-negative integer
* @throws {RangeError} fifth argument must be a non-negative integer
* @returns {Float64Array} `A`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var C = new Float64Array( [ 0.8, 0.7, 0.9 ] );
* var S = new Float64Array( [ 0.6, -0.7142857142857143, 0.4358898943540673 ] );
* var A = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] );
*
* var out = dlasr( 'left', 'variable', 'forward', 4, 3, C, 1, 0, S, 1, 0, A, 1, 4, 0 );
* // returns <Float64Array>[ 2.0, ~-1.443, ~4.276, ~2.373, 7.6, ~-3.74, ~9.054, ~4.504, 13.2, ~-6.037, ~13.832, ~6.634 ]
*/
function dlasr( side, pivot, direct, M, N, C, strideC, offsetC, S, strideS, offsetS, A, strideA1, strideA2, offsetA ) {
	if ( !isOperationSide( side ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid operation side. Value: `%s`.', side ) );
	}
	if ( !isPivot( pivot ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid pivot. Value: `%s`.', pivot ) );
	}
	if ( !isDirection( direct ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid direction. Value: `%s`.', direct ) );
	}
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	return base( side, pivot, direct, M, N, C, strideC, offsetC, S, strideS, offsetS, A, strideA1, strideA2, offsetA );
}
 
 
// EXPORTS //
 
module.exports = dlasr;