All files ndarray.js

95.65% Statements 88/92
80% Branches 8/10
100% Functions 1/1
95.65% Lines 88/92

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 932x 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 29x 29x 3x 3x 29x 13x 13x 29x     29x     13x 29x 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 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` using alternative indexing semantics.
*
* ## 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 {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} strideA1 - stride length for the first dimension of `A`
* @param {integer} strideA2 - stride length for the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index of `A`
* @param {Float64Array} TAU - scalar factors of reflectors
* @param {integer} strideTAU - stride length for `TAU`
* @param {NonNegativeInteger} offsetTAU - starting index of `TAU`
* @param {Float64Array} WORK - workspace array
* @param {integer} strideWORK - stride length for `WORK`
* @param {NonNegativeInteger} offsetWORK - starting index of `WORK`
* @param {NonNegativeInteger} LWORK - dimension of the array `WORK`
* @throws {RangeError} first argument must be a non-negative integer
* @throws {RangeError} second argument must be greater than or equal to `M`
* @throws {RangeError} third argument must be a non-negative integer and smaller than or equal to `M`
* @throws {RangeError} fourteenth 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( 2, 3, 2, A, 1, 2, 0, TAU, 1, 0, WORK, 1, 0, 10 );
* // A => <Float64Array>[ 0, 0, 0, 0, 2, 0 ]
* // info => 0
* // WORK[ 0 ] => 2
*/
function dorglq( M, N, K, A, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, WORK, strideWORK, offsetWORK, LWORK ) {
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < M ) {
		throw new RangeError( format( 'invalid argument. Second argument must be greater than or equal to `M`. Value: `%d`.', N ) );
	}
	if ( K < 0 || K > M ) {
		throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer and smaller than or equal to `M`. Value: `%d`.', K ) );
	}
	if ( LWORK < max( 1, N ) && LWORK !== -1 ) {
		throw new RangeError( format( 'invalid argument. Fourteenth 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, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, WORK, strideWORK, offsetWORK, LWORK );
}
 
 
// EXPORTS //
 
module.exports = dorglq;