All files dlasr.js

100% Statements 134/134
100% Branches 29/29
100% Functions 3/3
100% Lines 134/134

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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 1352x 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 48x 48x 35x 35x 13x 48x 2x 2x 2x 2x 2x 2x 2x 2x 35x 35x 22x 22x 13x 35x 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 74x 74x 74x 74x 74x 13x 13x 74x 13x 13x 74x 13x 13x 74x 13x 13x 74x 3x 3x 74x 3x 3x 74x 3x 3x 74x 7x 7x 74x 6x 6x 6x 13x 74x 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 format = require( '@stdlib/string/format' );
var isOperationSide = require( '@stdlib/blas/base/assert/is-operation-side' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var max = require( '@stdlib/math/base/special/fast/max' );
var base = require( './base.js' );
 
 
// FUNCTIONS //
 
/**
* Tests whether a string is a valid pivot type.
*
* @private
* @param {string} pivot - pivot type
* @returns {boolean} boolean indicating if the string is a valid pivot type
*/
function isPivot( pivot ) {
	if ( pivot === 'variable' || pivot === 'top' || pivot === 'bottom' ) {
		return true;
	}
	return false;
}
 
/**
* Tests whether a string is a valid direction.
*
* @private
* @param {string} direct - direction
* @returns {boolean} boolean indicating if the string is a valid direction
*/
function isDirection( direct ) {
	if ( direct === 'forward' || direct === 'backward' ) {
		return true;
	}
	return false;
}
 
 
// MAIN //
 
/**
* Applies a sequence of plane rotations to a general rectangular matrix.
*
* @param {string} order - storage layout
* @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 {Float64Array} S - array of sines of the plane rotations
* @param {Float64Array} A - input/output matrix
* @param {integer} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must be a valid side
* @throws {TypeError} third argument must be a valid pivot type
* @throws {TypeError} fourth argument must be a valid direction
* @throws {RangeError} fifth argument must be a non-negative integer
* @throws {RangeError} sixth argument must be a non-negative integer
* @throws {RangeError} tenth argument must be greater than or equal to max(1,`M`)
* @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( 'column-major', 'left', 'variable', 'forward', 4, 3, C, S, A, 4 );
* // returns <Float64Array>[ 2, ~-1.443, ~4.276, ~2.373, 7.6, ~-3.74, ~9.054, ~4.504, 13.2, ~-6.037, ~13.832, ~6.634 ]
*/
function dlasr( order, side, pivot, direct, M, N, C, S, A, LDA ) {
	var sa1;
	var sa2;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( !isOperationSide( side ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid operation side. Value: `%s`.', side ) );
	}
	if ( !isPivot( pivot ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid pivot. Value: `%s`.', pivot ) );
	}
	if ( !isDirection( direct ) ) {
		throw new TypeError( format( 'invalid argument. Fourth argument must be a valid direction. Value: `%s`.', direct ) );
	}
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	if ( ( isColumnMajor( order ) ) && LDA < max( 1, M ) ) {
		throw new RangeError( format( 'invalid argument. Tenth argument must be greater than or equal to max(1,`M`). Value: `%d`.', LDA ) );
	}
	if ( order === 'column-major' ) {
		sa1 = 1;
		sa2 = LDA;
	} else {
		sa1 = LDA;
		sa2 = 1;
	}
	return base( side, pivot, direct, M, N, C, 1, 0, S, 1, 0, A, sa1, sa2, 0 );
}
 
 
// EXPORTS //
 
module.exports = dlasr;