All files dorglq.js

88.78% Statements 95/107
75% Branches 12/16
100% Functions 1/1
88.78% Lines 95/107

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 1081x 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 41x 41x 41x 41x 41x 13x 13x 41x 3x 3x 41x 19x 19x 41x     6x 6x     6x 6x 41x             41x     6x 41x 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.
*/
 
'use strict';
 
// MODULES //
 
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var format = require( '@stdlib/string/format' );
var max = require( '@stdlib/math/base/special/fast/max' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Generates an `M-by-N` real orthogonal matrix `Q` from the elementary reflectors returned by `DGELQF`.
*
* ## Notes
*
* -   On entry, the i-th row 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`.
* -   On exit, the `M-by-N` orthogonal matrix `Q`.
* -   `WORK` must have length, `LWORK >= max(1,M)`. For optimum performance `LWORK >= M*NB`.
*
* @param {string} order - storage layout
* @param {NonNegativeInteger} M - number of rows of `Q`
* @param {NonNegativeInteger} N - number of columns of `Q`
* @param {NonNegativeInteger} K - number of elementary reflectors
* @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`)
* @param {Float64Array} TAU - scalar factors of reflectors
* @param {Float64Array} WORK - workspace array
* @param {NonNegativeInteger} LWORK - dimension of the array `WORK`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} second argument must be a non-negative integer
* @throws {RangeError} third argument must be greater than or equal to `M`
* @throws {RangeError} fourth argument must be a non-negative integer and smaller than or equal to `M`
* @throws {RangeError} sixth argument must be a valid `LDA` value
* @throws {RangeError} ninth argument must be a valid `LWORK` value
* @returns {integer} status code
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1, 0, 0, -1, -2, 0 ] );
* var TAU = new Float64Array( [ 1, 1 ] );
* var WORK = new Float64Array( 10 );
*
* var info = dorglq( 'column-major', 2, 3, 2, A, 2, TAU, WORK, 10 );
* // A => <Float64Array>[ 0, 0, 0, 0, 2, 0 ]
* // info => 0
* // WORK[ 0 ] => 2
*/
function dorglq( order, M, N, K, A, LDA, TAU, WORK, LWORK ) {
	var sa1;
	var sa2;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < M ) {
		throw new RangeError( format( 'invalid argument. Third argument must be greater than or equal to `M`. Value: `%d`.', N ) );
	}
	if ( K < 0 || K > M ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must be a nonnegative integer and smaller than or equal to `M`. Value: `%d`.', K ) );
	}
	if ( order === 'column-major' ) {
		if ( LDA < max( 1, M ) ) {
			throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to `max(1,M)`. Value: `%d`.', LDA ) );
		}
		sa1 = 1;
		sa2 = LDA;
	} else { // row-major
		if ( LDA < max( 1, N ) ) {
			throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to `max(1,N)`. Value: `%d`.', LDA ) );
		}
		sa1 = LDA;
		sa2 = 1;
	}
	if ( LWORK < max( 1, N ) && LWORK !== -1 ) {
		throw new RangeError( format( 'invalid argument. Ninth argument must be greater than or equal to `max(1,N)` except when equal to -1. Value: `%d`.', LWORK ) );
	}
	return base( M, N, K, A, sa1, sa2, 0, TAU, 1, 0, WORK, 1, 0, LWORK );
}
 
 
// EXPORTS //
 
module.exports = dorglq;