All files ndarray.js

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

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 892x 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 2x 2x 2x 2x 2x 15x 15x 3x 3x 12x 15x 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 format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Computes an `LU` factorization of a matrix `T - lambda*I`, where `T` is a general real tridiagonal matrix, and `lambda` a scalar, using partial pivoting with row interchanges and alternative indexing semantics.
*
* ## Notes
*
* -   `A` should have `N` elements and is overwritten by the diagonal elements of `U`.
* -   `B` should have `N-1` elements and is overwritten by the first super-diagonal elements of `U`.
* -   `C` should have `N-1` elements and is overwritten by the multipliers that define `L`.
* -   `D` should have `N-2` elements and is overwritten by the second super-diagonal elements of `U`.
* -   `IN` should have `N` elements and is overwritten by the pivot details and singularity info.
*
* @param {NonNegativeInteger} N - order of the matrix T
* @param {Float64Array} A - diagonal elements of T
* @param {integer} strideA - stride length for A
* @param {NonNegativeInteger} offsetA - starting index of A
* @param {number} lambda - scalar constant
* @param {Float64Array} B - super-diagonal elements of T
* @param {integer} strideB - stride length for B
* @param {NonNegativeInteger} offsetB - starting index of B
* @param {Float64Array} C - sub-diagonal elements of T
* @param {integer} strideC - stride length for C
* @param {NonNegativeInteger} offsetC - starting index of C
* @param {number} tol - tolerance constant
* @param {Float64Array} D - second super-diagonal elements of U
* @param {integer} strideD - stride length for D
* @param {NonNegativeInteger} offsetD - starting index of D
* @param {Int32Array} IN - pivot and singularity indices
* @param {integer} strideIN - stride length for IN
* @param {NonNegativeInteger} offsetIN - starting index of IN
* @throws {RangeError} first argument must be a nonnegative integer
* @returns {integer} status code
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var Int32Array = require( '@stdlib/array/int32' );
*
* var A = new Float64Array( [ 2.0, 3.0, 1.0 ] );
* var B = new Float64Array( [ 1.0, 1.0 ] );
* var C = new Float64Array( [ 1.0, 1.0 ] );
* var D = new Float64Array( [ 0.0 ] );
* var IN = new Int32Array( [ 0, 0, 0 ] );
*
* dlagtf( 3, A, 1, 0, 0.0, B, 1, 0, C, 1, 0, 0.0, D, 1, 0, IN, 1, 0 );
* // A => <Float64Array>[ 2.0, 2.5, 0.6 ]
* // B => <Float64Array>[ 1.0, 1.0 ]
* // C => <Float64Array>[ 0.5, 0.4 ]
* // D => <Float64Array>[ 0.0 ]
* // IN => <Int32Array>[ 0, 0, 0 ]
*/
function dlagtf( N, A, strideA, offsetA, lambda, B, strideB, offsetB, C, strideC, offsetC, tol, D, strideD, offsetD, IN, strideIN, offsetIN ) { // eslint-disable-line stdlib/jsdoc-doctest-decimal-point, max-len, max-params
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	return base( N, A, strideA, offsetA, lambda, B, strideB, offsetB, C, strideC, offsetC, tol, D, strideD, offsetD, IN, strideIN, offsetIN ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dlagtf;