All files / lapack/base/dorm2r/lib dorm2r.js

87.3% Statements 110/126
77.77% Branches 14/18
100% Functions 1/1
87.3% Lines 110/126

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 1272x 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 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 48x 48x 48x 48x 48x 48x 13x 13x 48x 13x 13x 48x 13x 13x 48x 3x     3x     48x 3x 3x 48x 3x 3x 48x 3x 3x                         48x 2x 2x 2x 2x 2x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isOperationSide = require( '@stdlib/blas/base/assert/is-operation-side' );
var isTransposeOperation = require( '@stdlib/blas/base/assert/is-transpose-operation' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
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 //
 
/**
* Multiplies a matrix `C` by an orthogonal matrix `Q` from a QR factorization.
*
* ## Notes
*
* `dorm2r` overwrites the general real M by N matrix C with
*
* -   `Q * C`  if side = 'left' and trans = 'no-transpose'
* -   `Q^T * C`  if side = 'left' and trans = 'transpose'
* -   `C * Q`  if side = 'right' and trans = 'no-transpose'
* -   `C * Q^T` if side = 'right' and trans = 'transpose'
*
* where Q is a real orthogonal matrix defined as the product of K elementary reflectors `Q = H(1) H(2) ... H(K)` as returned by `dgeqrf`. Q is of order M if side = 'left' and of order N if side = 'right'.
*
* @param {string} order - storage layout
* @param {string} side - specifies the side of multiplication with `C`
* @param {string} trans - specifies the operation to be performed
* @param {NonNegativeInteger} M - number of rows in matrix `C`
* @param {NonNegativeInteger} N - number of columns in matrix `C`
* @param {NonNegativeInteger} K - number of elementary reflectors whose product defines the matrix `Q`
* @param {Float64Array} A - input matrix containing the elementary reflectors
* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Float64Array} tau - array containing the scalar factors of the elementary reflectors
* @param {Float64Array} C - input/output matrix to be multiplied
* @param {PositiveInteger} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
* @param {Float64Array} work - workspace array for intermediate calculations
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must be a valid operation side
* @throws {TypeError} third argument must be a valid transpose operation
* @throws {RangeError} eighth argument must be greater than or equal to max(1,M) when side is 'left' or max(1,N) when side is 'right'
* @throws {RangeError} twelfth argument must be greater than or equal to max(1,M)
* @returns {Float64Array} the modified matrix `C`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1.0, 0.0, 0.0, 2.0, 4.0, 0.0, 3.0, 5.0, 6.0 ] );
* var tau = new Float64Array( [ 7.0, 8.0, 9.0 ] );
* var C = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
* var work = new Float64Array( 3 );
*
* dorm2r( 'row-major', 'left', 'no-transpose', 3, 3, 3, A, 3, tau, C, 3, work );
* // C => <Float64Array>[ -261638.0, -298618.0, -335598.0, -521066.0, -594715.0, -668364.0, -773933.0, -883324.0, -992715.0 ]
*/
function dorm2r( order, side, trans, M, N, K, A, LDA, tau, C, LDC, work ) { // eslint-disable-line max-params
	var sa1;
	var sa2;
	var sc1;
	var sc2;
	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 ( !isTransposeOperation( trans ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', trans ) );
	}
	if ( isColumnMajor( order ) ) {
		if ( side === 'left' && LDA < max( 1, M ) ) {
			throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to max(1,%d) when side is left. Value: `%d`.', M, LDA ) );
		}
		if ( side === 'right' && LDA < max( 1, N ) ) {
			throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to max(1,%d) when side is right. Value: `%d`.', N, LDA ) );
		}
	} else if ( LDA < max( 1, K ) ) {
		throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to max(1,%d) for row-major layout. Value: `%d`.', K, LDA ) );
	}
	if ( isRowMajor( order ) && LDC < max( 1, N ) ) {
		throw new RangeError( format( 'invalid argument. Twelfth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDC ) );
	}
	if ( isColumnMajor( order ) && LDC < max( 1, M ) ) {
		throw new RangeError( format( 'invalid argument. Twelfth argument must be greater than or equal to max(1,%d). Value: `%d`.', M, LDC ) );
	}
	if ( isColumnMajor( order ) ) {
		sa1 = 1;
		sa2 = LDA;
		sc1 = 1;
		sc2 = LDC;
	} else {
		sa1 = LDA;
		sa2 = 1;
		sc1 = LDC;
		sc2 = 1;
	}
	return base( side, trans, M, N, K, A, sa1, sa2, 0, tau, 1, 0, C, sc1, sc2, 0, work, 1, 0 ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dorm2r;