All files dorgl2.js

100% Statements 101/101
100% Branches 13/13
100% Functions 1/1
100% Lines 101/101

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 1022x 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 24x 24x 24x 24x 24x 13x 13x 24x 3x 3x 24x 3x 3x 24x 3x 3x 24x 1x 1x 1x 1x 1x 1x 2x 24x 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 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 //
 
/**
* Generates an M-by-N real orthogonal matrix Q from the elementary reflectors returned by DGELQF/DGELQ2 (LQ factorization, unblocked).
*
* ## Notes
*
* -   On entry, the i-th row of A must contain the vector which defines the elementary reflector H(i), for i = 1, 2, ..., K, as returned by `DGELQF` in the first K rows of its array argument A.
*
* -   Q is defined as the product of K elementary reflectors:
*
*     -   Q = H(K) ... H(2) H(1), where each H(i) has the form `H(i) = I - tau(i)*v*v^T`, and v is stored as row i of the input matrix A.
*
* -   On exit, A contains the M-by-N matrix Q.
*
* @param {string} order - storage layout
* @param {NonNegativeInteger} M - number of rows of Q (0 <= M <= N)
* @param {NonNegativeInteger} N - number of columns of Q (N >= 0)
* @param {NonNegativeInteger} K - number of elementary reflectors (0 <= K <= M)
* @param {Float64Array} A - input/output matrix (LDA x N)
* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Float64Array} TAU - scalar factors of reflectors (length K)
* @param {Float64Array} WORK - workspace (length >= M)
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} second argument must be smaller than N
* @throws {RangeError} fourth argument must be smaller than M
* @throws {RangeError} sixth argument must be smaller than or equal to max(1,M)
* @returns {integer} status code (0 = success)
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( 12 );
* var TAU = new Float64Array( 2 );
* var WORK = new Float64Array( 3 );
*
* var info = dorgl2( 'row-major', 3, 4, 2, A, 3, TAU, WORK );
* // returns 0
* // A => <Float64Array>[ 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0 ]
* // WORK => <Float64Array>[ 0, 0, 0 ]
*/
function dorgl2( order, M, N, K, A, LDA, TAU, WORK ) {
	var strideA1;
	var strideA2;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( M > N ) {
		throw new RangeError( format( 'invalid argument. Second argument must be smaller than `N`. Value: `M`: `%s`, `N`: `%s`.', M, N ) );
	}
	if ( K > M ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must be smaller than `M`. Value: `M`: `%s`, `K`: `%s`.', M, K ) );
	}
	if ( isRowMajor( order ) && LDA < max( 1, M ) ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to max(1,%d). Value: `%d`.', M, LDA ) );
	}
	if ( isColumnMajor( order ) ) {
		strideA1 = 1;
		strideA2 = LDA;
	} else { // order === 'row-major'
		strideA1 = N;
		strideA2 = 1;
	}
	return base( M, N, K, A, strideA1, strideA2, 0, TAU, 1, 0, WORK, 1, 0 );
}
 
 
// EXPORTS //
 
module.exports = dorgl2;