All files dgetrf.js

100% Statements 66/66
100% Branches 8/8
100% Functions 1/1
100% Lines 66/66

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 672x 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 10x 10x 1x 1x 10x 1x 1x 10x 1x 1x 7x 10x 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 max = require( '@stdlib/math/base/special/max' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Computes an `LU` factorization of a real general matrix `A` using elimination with partial pivoting and row interchanges.
*
* ## Notes
*
* -   The factorization has the form `A = P * L * U`, where `P` is a permutation matrix, `L` is lower triangular or trapezoidal with unit diagonal elements, and `U` is upper triangular or trapezoidal.
* -   `A` is overwritten in-place. The strictly lower triangular part contains the multipliers defining `L`, and the upper triangular part contains `U`. The unit diagonal of `L` is not stored.
* -   `IPIV` contains zero-based pivot indices. For each `i` in `0 <= i < min(M,N)`, row `i` is interchanged with row `IPIV(i)`.
* -   If the returned status code is greater than zero, `U(k,k)` is exactly zero for `k` equal to the status code. The factorization has been completed, but `U` is singular.
*
* @param {NonNegativeInteger} M - number of rows in `A`
* @param {NonNegativeInteger} N - number of columns in `A`
* @param {Float64Array} A - input matrix
* @param {PositiveInteger} LDA - stride between successive columns of `A`
* @param {Int32Array} IPIV - vector of pivot indices
* @throws {RangeError} first argument must be a nonnegative integer
* @throws {RangeError} second argument must be a nonnegative integer
* @throws {RangeError} fourth argument must be greater than or equal to max(1,M)
* @returns {integer} status code
*/
function dgetrf( M, N, A, LDA, IPIV ) {
	if ( M < 0 ) {
		throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', M ) );
	}
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	if ( LDA < max( 1, M ) ) {
		throw new RangeError( format( 'invalid argument. Fourth argument must be greater than or equal to max(1,%d). Value: `%d`.', M, LDA ) );
	}
	return base( M, N, A, 1, LDA, 0, IPIV, 1, 0 );
}
 
 
// EXPORTS //
 
module.exports = dgetrf;