All files / lapack/base/dgebal/lib ndarray.js

100% Statements 80/80
100% Branches 7/7
100% Functions 1/1
100% Lines 80/80

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 812x 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 23x 23x 4x 4x 19x 23x 2x 2x 2x 2x 2x  
/**
* @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 format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Balances a general real matrix `A` using alternative indexing semantics.
*
* ## Notes
*
* The job parameter can be one of the following:
*
* -   'none': none, return immediately
* -   'permutate': permute only
* -   'scale': scale only
* -   'both': both permute and scale
* -   The matrix `A` is overwritten by the balanced matrix.
*
* @private
* @param {string} job - indicates the operations to be performed
* @param {NonNegativeInteger} N - number of rows/columns in matrix `A`
* @param {Float64Array} A - input matrix to be balanced
* @param {integer} strideA1 - stride of the first dimension of `A`
* @param {integer} strideA2 - stride of the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index for `A`
* @param {Float64Array} out - stores the first and last row/column of the balanced submatrix
* @param {integer} strideOut - stride of `out`
* @param {NonNegativeInteger} offsetOut - starting index for `out`
* @param {Float64Array} scale - array containing permutation and scaling information
* @param {integer} strideScale - stride of `scale`
* @param {NonNegativeInteger} offsetScale  - starting index for `scale`
* @throws {TypeError} second argument must be a valid job
* @returns {integer} status code
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1.0, 100.0, 0.0, 2.0, 200.0, 0.0, 0.0, 0.0, 3.0 ] );
* var out = new Float64Array( 2 );
* var scale = new Float64Array( 3 );
*
* dgebal( 'both', 3, A, 3, 1, 0, out, 1, 0, scale, 1, 0 );
* // A => <Float64Array>[ 1, 12.5, 0, 16, 200, 0, 0, 0, 3 ]
* // out => <Float64Array>[ 0, 1 ]
* // scale => <Float64Array>[ 8, 1, 2 ]
*/
function dgebal( job, N, A, strideA1, strideA2, offsetA, out, strideOut, offsetOut, scale, strideScale, offsetScale ) { // eslint-disable-line max-len, max-params
	if ( job !== 'both' && job !== 'scale' && job !== 'permutate' && job !== 'none' ) {
		throw new TypeError( format( 'invalid argument. Second argument must be one of the following: `both`, `scale`, `permutate`, or `none`. Value: `%s`.', job ) );
	}
	return base( job, N, A, strideA1, strideA2, offsetA, out, strideOut, offsetOut, scale, strideScale, offsetScale ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dgebal;