feat: add lapack/base/dppequ

lib/node_modules/@stdlib/lapack/base/dppequ/lib/base.js

@@ -0,0 +1,125 @@
+/**
+* @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;

lib/node_modules/@stdlib/lapack/base/dppequ/lib/dppequ.js

@@ -0,0 +1,67 @@
+/**
+* @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 isLayout = require( '@stdlib/blas/base/assert/is-layout' );
+var format = require( '@stdlib/string/format' );
+var base = require( './base.js' );
+
+
+// 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 {Float64Array} S - array to store the scale factors of `A`
+* @param {Float64Array} out - array to store the output
+* @throws {TypeError} first argument must be a valid order
+* @throws {RangeError} third argument must be a nonnegative integer
+* @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, S, out );
+* // S => <Float64Array>[ 1, ~0.58, ~0.33 ]
+* // out => <Float64Array>[ ~0.33, 9 ]
+*/
+function dppequ( order, uplo, N, AP, S, out ) {
+	if ( !isLayout( order ) ) {
+		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
+	}
+	if ( N < 0 ) {
+		throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', N ) );
+	}
+	return base( order, uplo, N, AP, 1, 0, S, 1, 0, out, 1, 0 );
+}
+
+
+// EXPORTS //
+
+module.exports = dppequ;

lib/node_modules/@stdlib/lapack/base/dppequ/lib/index.js

@@ -0,0 +1,72 @@
+/**
+* @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';
+
+/**
+* LAPACK routine to compute 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).
+*
+* @module @stdlib/lapack/base/dppequ
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var dppequ = require( '@stdlib/lapack/base/dppequ' );
+*
+* 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, S, out );
+* // S => <Float64Array>[ 1, ~0.58, ~0.33 ]
+* // out => <Float64Array>[ ~0.33, 9 ]
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+* var dppequ = require( '@stdlib/lapack/base/dppequ' );
+*
+* 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.ndarray( '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 ]
+*/
+
+// MODULES //
+
+var join = require( 'path' ).join;
+var tryRequire = require( '@stdlib/utils/try-require' );
+var isError = require( '@stdlib/assert/is-error' );
+var main = require( './main.js' );
+
+
+// MAIN //
+
+var dppequ;
+var tmp = tryRequire( join( __dirname, './native.js' ) );
+if ( isError( tmp ) ) {
+	dppequ = main;
+} else {
+	dppequ = tmp;
+}
+
+
+// EXPORTS //
+
+module.exports = dppequ;

lib/node_modules/@stdlib/lapack/base/dppequ/lib/main.js

@@ -0,0 +1,35 @@
+/**
+* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
+var dppequ = require( './dppequ.js' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+setReadOnly( dppequ, 'ndarray', ndarray );
+
+
+// EXPORTS //
+
+module.exports = dppequ;

lib/node_modules/@stdlib/lapack/base/dppequ/lib/ndarray.js

@@ -0,0 +1,73 @@
+/**
+* @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 isLayout = require( '@stdlib/blas/base/assert/is-layout' );
+var format = require( '@stdlib/string/format' );
+var base = require( './base.js' );
+
+
+// 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) using alternative indexing semantics.
+*
+* @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`
+* @throws {TypeError} first argument must be a valid order
+* @throws {RangeError} third argument must be a nonnegative integer
+* @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
+	if ( !isLayout( order ) ) {
+		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
+	}
+	if ( N < 0 ) {
+		throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', N ) );
+	}
+	return base( order, uplo, N, AP, strideAP, offsetAP, S, strideS, offsetS, out, strideOut, offsetOut ); // eslint-disable-line max-len
+}
+
+
+// EXPORTS //
+
+module.exports = dppequ;