All files / spttrf/lib spttrf.js

89.65% Statements 52/58
100% Branches 1/1
0% Functions 0/1
89.65% Lines 52/58

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 591x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x             1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 the `L * D * L^T` factorization of a real symmetric positive definite tridiagonal matrix `A`.
*
* @param {NonNegativeInteger} N - order of matrix `A`
* @param {Float32Array} D - the `N` diagonal elements of `A`
* @param {Float32Array} E - the `N-1` subdiagonal elements of `A`
* @throws {RangeError} first argument must be a nonnegative integer
* @returns {integer} status code
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var D = new Float32Array( [ 4.0, 5.0, 6.0 ] );
* var E = new Float32Array( [ 1.0, 2.0 ] );
*
* spttrf( 3, D, E );
* // D => <Float32Array>[ 4, 4.75, ~5.15789 ]
* // E => <Float32Array>[ 0.25, ~0.4210 ]
*/
function spttrf( N, D, E ) {
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	return base( N, D, 1, 0, E, 1, 0 );
}
 
 
// EXPORTS //
 
module.exports = spttrf;