All files dgetf2.js

100% Statements 80/80
100% Branches 9/9
100% Functions 1/1
100% Lines 80/80

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 812x 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 17x 17x 17x 17x 17x 4x 4x 17x 1x 1x 17x 6x 6x 6x 6x 6x 6x 12x 17x 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 isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
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 general M-by-N matrix `A` using partial pivoting with row interchanges.
*
* @param {string} order - storage layout of `A`
* @param {NonNegativeInteger} M - number of rows in matrix `A`
* @param {NonNegativeInteger} N - number of columns in matrix `A`
* @param {Float64Array} A - input matrix
* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A` if column-major, or stride between rows if row-major)
* @param {Int32Array} IPIV - vector of pivot indices
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} fifth argument must be greater than or equal to `max(1, N)`
* @returns {integer} status code
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var Int32Array = require( '@stdlib/array/int32' );
* var dgetf2 = require( '@stdlib/lapack/base/dgetf2' );
*
* var A = new Float64Array( [ 2.0, 1.0, 4.0, 6.0 ] );
* var IPIV = new Int32Array( 2 );
*
* var info = dgetf2( 'row-major', 2, 2, A, 2, IPIV );
* // info => 0
*/
function dgetf2( order, M, N, A, LDA, IPIV ) {
	var sa1;
	var sa2;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isRowMajor( order ) && LDA < max( 1, N ) ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDA ) );
	}
	if ( isColumnMajor( order ) ) {
		sa1 = 1;
		sa2 = LDA;
	} else { // order === 'row-major'
		sa1 = LDA;
		sa2 = 1;
	}
	return base( M, N, A, sa1, sa2, 0, IPIV, 1, 0 );
}
 
 
// EXPORTS //
 
module.exports = dgetf2;