All files dgeqr2.js

100% Statements 99/99
100% Branches 4/4
100% Functions 1/1
100% Lines 99/99

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 1002x 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 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 261x 261x 261x 261x 261x 261x 261x 257x 257x 257x 261x 261x 261x 5x 5x 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 dlarf1f = require( '@stdlib/lapack/base/dlarf1f' ).ndarray;
var Float64Array = require( '@stdlib/array/float64' );
var min = require( '@stdlib/math/base/special/min' );
var dlarfg = require( './dlarfg.js' );
 
 
// MAIN //
 
/**
* Compute a QR factorization of a general rectangular matrix using an unblocked algorithm.
*
* ## Notes
*
* -   On exit, the elements on and above the diagonal of A contain the min(M,N) by `N` upper trapezoidal matrix R (R is upper triangular if M >= N) matrix `R`.
* -   The elements below the diagonal, with the array `TAU`, represent the orthogonal matrix `Q` as a product of elementary reflectors.
*
* @private
* @param {NonNegativeInteger} M - number of rows in `A`
* @param {NonNegativeInteger} N - number of columns in `A`
* @param {Float64Array} A - input/output matrix
* @param {integer} strideA1 - stride of the first dimension of `A`
* @param {integer} strideA2 - stride of the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index for `A`
* @param {Float64Array} TAU - output array of scalar factors (length min(M,N))
* @param {integer} strideTAU - stride for TAU
* @param {NonNegativeInteger} offsetTAU - starting index for TAU
* @param {Float64Array} WORK - workspace array (length >= M)
* @param {integer} strideWORK - stride for WORK
* @param {NonNegativeInteger} offsetWORK - starting index for WORK
* @returns {integer} status code
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11, 4, 8, 12 ] );
* var TAU = new Float64Array( 3 );
* var work = new Float64Array( 4 );
*
* dgeqr2( 3, 4, A, 1, 3, 0, TAU, 1, 0, work, 1, 0 );
* // A => <Float64Array>[ ~-10.344, ~0.441, ~0.793, ~-11.794, ~0.947, ~0.919, ~-13.244, ~1.894, ~0.0, ~-14.694, ~2.842, ~0.0 ]
* // TAU => <Float64Array>[ ~1.097, ~1.084, 0.0 ]
* // work => <Float64Array>[ ~-1.894, ~-2.842, ~17.046, 0.0 ]
*/
function dgeqr2( M, N, A, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, WORK, strideWORK, offsetWORK ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point, max-len, max-params
	var taui;
	var aii;
	var out;
	var K;
	var i;
 
	K = min( M, N );
	out = new Float64Array( 2 );
 
	aii = offsetA; // Index of A(i,i)
	taui = offsetTAU; // Index of TAU(i)
 
	for ( i = 0; i < K; i++ ) {
		// Generate elementary reflector H(i) to annihilate A(i+1:m,i)
		out[ 0 ] = A[ aii ];
		dlarfg( M - i, A, strideA1, aii + ( min( 1, M - 1 - i ) * strideA1 ), out, 1, 0 );
		A[ aii ] = out[ 0 ];
		TAU[ taui ] = out[ 1 ];
 
		if ( i < N - 1 ) {
			// Apply H(i) to A(i:m,i+1:n) from the left
			dlarf1f( 'left', M - i, N - i - 1, A, strideA1, aii, TAU[ taui ], A, strideA1, strideA2, aii + strideA2, WORK, strideWORK, offsetWORK );
		}
		aii += strideA1 + strideA2;
		taui += strideTAU;
	}
	return 0;
}
 
 
// EXPORTS //
 
module.exports = dgeqr2;