All files ndarray.js

79.66% Statements 94/118
100% Branches 1/1
0% Functions 0/1
79.66% Lines 94/118

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 1191x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                 1x 1x 1x 1x 1x  
/**
* @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 isMatrixTranspose = require( '@stdlib/blas/base/assert/is-transpose-operation' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Multiply a general matrix by the orthogonal matrix from a LQ factorization determined by `DGELQF` using alternative indexing semantics.
*
* ## Notes
*
* -   `Q` is a real orthogonal matrix defined as the product of k elementary reflectors, Q = H(k) . . . H(2) H(1) as returned by `DGELQF`.
*
* -   `Q` is of order `M` if SIDE = 'left' and of order `N` if SIDE = 'R'.
*
* -   `DORML2` overwrites the general real `M` by `N` matrix `C` with,
*
*     -   `Q * C`  if SIDE = 'left' and TRANS = 'no-transpose', or
*     -   `Q^T* C`  if SIDE = 'left' and TRANS = 'transpose', or
*     -   `C * Q`  if SIDE = 'right' and TRANS = 'no-transpose', or
*     -   `C * Q**T` if SIDE = 'right' and TRANS = 'transpose'.
*
* @param {string} side - specifies the side of multiplication with `C`
* @param {string} trans - `'no-transpose'` for `Q`, `'transpose'` for `Q^T`
* @param {NonNegativeInteger} M - number of rows of `C`
* @param {NonNegativeInteger} N - number of columns of `C`
* @param {NonNegativeInteger} K - number of elementary reflectors
* @param {Float64Array} A - reflector vectors from `DGELQ2`
* @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
* @param {Float64Array} TAU - scalar factors of reflectors
* @param {integer} strideTAU - stride for TAU
* @param {NonNegativeInteger} offsetTAU - starting index for TAU
* @param {Float64Array} C - input/output matrix
* @param {integer} strideC1 - stride of the first dimension of `C`
* @param {integer} strideC2 - stride of the second dimension of `C`
* @param {NonNegativeInteger} offsetC - starting index for `C`
* @param {Float64Array} WORK - workspace array
* @param {integer} strideWORK - stride for `WORK`
* @param {NonNegativeInteger} offsetWORK - starting index for `WORK`
* @throws {TypeError} first argument must be a valid side
* @throws {TypeError} second argument must be a valid transpose operation
* @throws {RangeError} third argument must be a non-negative integer
* @throws {RangeError} fourth argument must be a non-negative integer
* @throws {RangeError} fifth argument must be a non-negative integer
* @throws {RangeError} fifth argument must be smaller than the order of `Q`
* @throws {RangeError} fifth argument must be smaller than the order of `Q`
* @returns {integer} status code (0 if successful)
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1, 0 ] );
* var TAU = new Float64Array( [ 2 ] );
* var C = new Float64Array( [ 1, 3, 5, 2, 4, 6 ] );
* var WORK = new Float64Array( 3 );
*
* var info = dorml2( 'left', 'no-transpose', 2, 3, 1, A, 2, 1, 0, TAU, 1, 0, C, 3, 1, 0, WORK, 1, 0 );
* // returns 0
* // C => <Float64Array>[ -1, -3, -5, 2, 4, 6 ]
* // WORK => <Float64Array>[ 1, 3, 5 ]
*/
function dorml2( side, trans, M, N, K, A, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, C, strideC1, strideC2, offsetC, WORK, strideWORK, offsetWORK ) {
	if ( !isOperationSide( side ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid operation side. Value: `%s`.', side ) );
	}
	if ( !isMatrixTranspose( trans ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid transpose operation. Value: `%s`.', trans ) );
	}
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	if ( K < 0 ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be a nonnegative integer. Value: `%d`.', K ) );
	}
	if ( side === 'left' && K > M ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be smaller than the order of `Q`. Value: `%d`.', K ) );
	}
	if ( side === 'right' && K > N ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be smaller than the order of `Q`. Value: `%d`.', K ) );
	}
	return base( side, trans, M, N, K, A, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, C, strideC1, strideC2, offsetC, WORK, strideWORK, offsetWORK );
}
 
 
// EXPORTS //
 
module.exports = dorml2;