All files dormqr.js

97.57% Statements 161/165
97.5% Branches 39/40
100% Functions 1/1
97.57% Lines 161/165

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 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 1662x 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 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 82x 82x 82x 82x 82x 82x 82x 13x 13x 82x 13x 13x 82x 13x 13x 82x 3x 3x 82x 3x 3x 82x 3x 3x 82x 20x 3x 3x 20x 3x 3x 20x 3x 3x 20x 82x 14x 3x 3x 14x 3x 3x 14x 2x 2x 14x 82x 14x 3x 3x 14x 3x 3x 82x 3x 3x 82x         82x 8x 8x 8x 8x 8x 8x 82x 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 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 isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isMatrixTranspose = require( '@stdlib/blas/base/assert/is-transpose-operation' );
var max = require( '@stdlib/math/base/special/fast/max' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Applies an orthogonal matrix `Q`, formed from Householder reflectors returned by `DGEQRF`, to overwrite matrix `C` by multiplying from the left or right with `Q` or `Q^T`.
*
* ## 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'.
*
* -   `WORK` must have length, `LWORK >= max(1,N)` if SIDE = `left`, and `LWORK >= max(1,M)` if SIDE = `right`.
*
* @param {string} order - storage layout
* @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 `DGEQRF`
* @param {integer} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Float64Array} TAU - scalar factors of reflectors
* @param {Float64Array} C - input/output matrix
* @param {integer} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
* @param {Float64Array} WORK - workspace array
* @param {NonNegativeInteger} LWORK - dimension of the array `WORK`
* @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 transpose operation
* @throws {RangeError} fourth argument must be a non-negative integer
* @throws {RangeError} fifth argument must be a non-negative integer
* @throws {RangeError} sixth argument must be a non-negative integer
* @throws {RangeError} sixth argument must be smaller than the order of `Q`
* @throws {RangeError} eighth argument must be a valid `LDA` value
* @throws {RangeError} eleventh argument must be a valid `LDC` value
* @throws {RangeError} thirteenth argument must be a valid `LWORK` value
* @returns {integer} status code (0 if successful)
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1, 0, 0 ] );
* var TAU = new Float64Array( [ 2 ] );
* var C = new Float64Array( [ 1, 3, 5, 2, 4, 6 ] );
* var WORK = new Float64Array( 64 );
*
* var info = dormqr( 'row-major', 'left', 'no-transpose', 2, 3, 1, A, 2, TAU, C, 3, WORK, 64 );
* // returns 0
* // C => <Float64Array>[ -1, -3, -5, 2, 4, 6 ]
* // WORK[ 0 ] => 4256
*/
function dormqr( order, side, trans, M, N, K, A, LDA, TAU, C, LDC, WORK, LWORK ) {
	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 ( !isMatrixTranspose( trans ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', trans ) );
	}
	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 ) );
	}
	if ( K < 0 ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be a nonnegative integer. Value: `%d`.', K ) );
	}
	if ( side === 'left' ) {
		if ( K > M ) {
			throw new RangeError( format( 'invalid argument. Sixth argument must be smaller than the order of `Q`. Value: `%d`.', K ) );
		}
		if ( ( !isRowMajor( order ) ) && LDA < max( 1, M ) ) {
			throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to `max(1,M)`. Value: `%d`.', LDA ) );
		}
		if ( LWORK < max( 1, N ) && LWORK !== -1 ) {
			throw new RangeError( format( 'invalid argument. Thirteenth argument must be greater than or equal to `max(1, N)` when `SIDE = \'L\'`. Value: `%d`.', LWORK ) );
		}
	}
	if ( side === 'right' ) {
		if ( K > N ) {
			throw new RangeError( format( 'invalid argument. Sixth argument must be smaller than the order of `Q`. Value: `%d`.', K ) );
		}
		if ( ( !isRowMajor( order ) ) && LDA < max( 1, N ) ) {
			throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to `max(1,N)`. Value: `%d`.', LDA ) );
		}
		if ( LWORK < max( 1, M ) && LWORK !== -1 ) {
			throw new RangeError( format( 'invalid argument. Thirteenth argument must be greater than or equal to `max(1, M)` when `SIDE = \'R\'`. Value: `%d`.', LWORK ) );
		}
	}
	if ( isRowMajor( order ) ) {
		if ( LDA < max( 1, K ) ) {
			throw new RangeError( format( 'invalid argument. Eighth argument must be greater than or equal to `max(1,K)`. Value: `%d`.', LDA ) );
		}
		if ( LDC < max( 1, N ) ) {
			throw new RangeError( format( 'invalid argument. Eleventh argument must be greater than or equal to `max(1,N)`. Value: `%d`.', LDC ) );
		}
	} else if ( LDC < max( 1, M ) ) {
		throw new RangeError( format( 'invalid argument. Eleventh argument must be greater than or equal to `max(1,M)`. Value: `%d`.', LDC ) );
	}
	if ( order === 'column-major' ) {
		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, LWORK );
}
 
 
// EXPORTS //
 
module.exports = dormqr;