All files ndarray.js

100% Statements 90/90
100% Branches 15/15
100% Functions 1/1
100% Lines 90/90

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 913x 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 3x 3x 3x 3x 3x 60x 60x 60x 60x 16x 16x 60x 16x 16x 60x 8x 8x 60x 1x 1x 60x 1x 1x 18x 60x 60x 60x 60x 3x 3x 3x 3x 3x  
/**
* @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 isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Equilibrates a real symmetric matrix `A` stored in packed format using scaling factors `S` and alternative indexing semantics.
*
* @param {string} order - storage layout
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` is stored
* @param {NonNegativeInteger} N - order of matrix `A`
* @param {Float64Array} AP - packed symmetric matrix `A`
* @param {integer} strideAP - `AP` stride length
* @param {NonNegativeInteger} offsetAP - starting index of `AP`
* @param {Float64Array} S - scale factors vector
* @param {integer} strideS - `S` stride length
* @param {NonNegativeInteger} offsetS - starting index of `S`
* @param {number} scond - ratio of smallest `S[i]` to largest `S[i]`
* @param {number} amax - absolute value of largest matrix entry
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix is supplied
* @throws {RangeError} third argument must be a nonnegative integer
* @throws {RangeError} fifth argument must be non-zero
* @throws {RangeError} eighth argument must be non-zero
* @returns {string} character flag indicating whether the matrix was equilibrated ('Y') or not ('N')
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var dlaqsp = require( '@stdlib/lapack/base/dlaqsp' );
*
* var AP = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var S = new Float64Array( [ 0.05, 2.0, 4.0 ] );
*
* var out = dlaqsp.ndarray( 'column-major', 'upper', 3, AP, 1, 0, S, 1, 0, 0.0125, 6.0 );
* // returns 'Y'
*/
function ndarray( order, uplo, N, AP, strideAP, offsetAP, S, strideS, offsetS, scond, amax ) { // eslint-disable-line max-len, max-params
	var isUpper;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( !isMatrixTriangle( uplo ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
	}
	if ( N < 0 ) {
		throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer. Value: `%d`.', N ) );
	}
	if ( strideAP === 0 ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be non-zero. Value: `%d`.', strideAP ) );
	}
	if ( strideS === 0 ) {
		throw new RangeError( format( 'invalid argument. Eighth argument must be non-zero. Value: `%d`.', strideS ) );
	}
 
	isUpper = ( ( isColumnMajor( order ) && uplo === 'upper' ) || ( !isColumnMajor( order ) && uplo === 'lower' ) );
 
	return base( isUpper, N, AP, strideAP, offsetAP, S, strideS, offsetS, scond, amax );
}
 
 
// EXPORTS //
 
module.exports = ndarray;