All files / lapack/base/dppequ/lib base.js

100% Statements 125/125
100% Branches 14/14
100% Functions 1/1
100% Lines 125/125

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 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 1263x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 18x 18x 18x 18x 18x 18x 18x 18x 2x 2x 2x 2x 16x 16x 16x 16x 16x 18x 8x 8x 16x 8x 8x 8x 8x 16x 16x 16x 16x 8x 8x 8x 16x 8x 8x 8x 8x 16x 16x 16x 16x 8x 16x 18x 8x 16x 8x 8x 8x 8x 8x 16x 8x 8x 24x 24x 8x 8x 8x 8x 8x 8x 18x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 sqrt = require( '@stdlib/math/base/special/sqrt' );
var max = require( '@stdlib/math/base/special/max' );
var min = require( '@stdlib/math/base/special/min' );
 
 
// MAIN //
 
/**
* Computes the row and column scaling factors intended to equilibrate a symmetric positive definite matrix `A` in packed storage and reduce it's condition number (with respect to the two-norm).
*
* @param {string} order - specifies whether `AP` is packed in row-major or column-major order
* @param {string} uplo - 'Upper' or 'Lower' triangle of `A` is stored
* @param {NonNegativeInteger} N - order of the matrix `A`
* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form
* @param {integer} strideAP - stride length for `AP`
* @param {integer} offsetAP - starting index for `AP`
* @param {Float64Array} S - array to store the scale factors of `A`
* @param {integer} strideS - stride length for `S`
* @param {integer} offsetS - starting index for `S`
* @param {Float64Array} out - array to store the output
* @param {integer} strideOut - stride length for `out`
* @param {integer} offsetOut - starting index for `out`
* @returns {integer} status code
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var AP = new Float64Array( [ 1.0, 2.0, 3.0, 5.0, 6.0, 9.0 ] );
* var S = new Float64Array( 3 );
* var out = new Float64Array( 2 );
*
* dppequ( 'row-major', 'L', 3, AP, 1, 0, S, 1, 0, out, 1, 0 );
* // S => <Float64Array>[ 1, ~0.58, ~0.33 ]
* // out => <Float64Array>[ ~0.33, 9 ]
*/
function dppequ( order, uplo, N, AP, strideAP, offsetAP, S, strideS, offsetS, out, strideOut, offsetOut ) { // eslint-disable-line max-len, max-params
	var info;
	var smin;
	var amax;
	var jj;
	var i;
 
	if ( N === 0 ) {
		out[ offsetOut ] = 1.0; // scond
		out[ offsetOut + strideOut ] = 0.0; // amax
		return 0; // info
	}
 
	S[ offsetAP ] = AP[ offsetAP ];
	smin = S[ offsetAP ];
	amax = S[ offsetAP ];
 
	if ( uplo === 'U' ) {
		jj = 0;
		for ( i = 1; i < N; i++ ) {
			if ( order === 'row-major' ) {
				jj += N - i + 1;
			} else { // order === 'column-major'
				jj += i + 1;
			}
			S[ offsetS + (i * strideS) ] = AP[ offsetAP + (jj * strideAP) ];
			smin = min( smin, S[ offsetS + (i * strideS) ] );
			amax = max( amax, S[ offsetS + (i * strideS) ] );
		}
	} else { // uplo === 'L'
		jj = 0;
		for ( i = 1; i < N; i++ ) {
			if ( order === 'row-major' ) {
				jj += i + 1;
			} else { // order === 'column-major'
				jj += N - i + 1;
			}
			S[ offsetS + (i * strideS) ] = AP[ offsetAP + (jj * strideAP) ];
			smin = min( smin, S[ offsetS + (i * strideS) ] );
			amax = max( amax, S[ offsetS + (i * strideS) ] );
		}
	}
 
	if ( smin <= 0.0 ) {
		for ( i = 0; i < N; i++ ) {
			if ( S[ offsetS + (i * strideS) ] <= 0.0 ) {
				// Leave first element of `out` unchanged
				out[ offsetOut + strideOut ] = amax; // amax
				info = i;
				return info;
			}
		}
	} else {
		for ( i = 0; i < N; i++ ) {
			S[ offsetS + (i * strideS) ] = 1.0 / sqrt( S[ offsetS + (i * strideS) ] ); // eslint-disable-line max-len
		}
	}
 
	out[ offsetOut ] = sqrt( smin ) / sqrt( amax ); // scond
	out[ offsetOut + strideOut ] = amax; // amax
	info = 0;
	return info;
}
 
 
// EXPORTS //
 
module.exports = dppequ;