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

100% Statements 82/82
100% Branches 6/6
100% Functions 1/1
100% Lines 82/82

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 832x 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 127x 127x 26x 26x 127x 13x 13x 88x 127x 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 isOperationSide = require( '@stdlib/blas/base/assert/is-operation-side' );
var isJob = require( './isjob.js' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Forms the right or left eigenvectors of a real general matrix by backward transformation on the computed eigenvectors of the balanced matrix output by `dgebal` using alternative indexing semantics.
*
* ## Notes
*
* The job parameter can be one of the following:
*
* -   `none`: none, return immediately
* -   `permute`: permute only
* -   `scale`: scale only
* -   `both`: both permute and scale
*
* @param {string} job - type of transformation.
* @param {string} side - specifies the side of the eigenvectors in `V` (`right` or `left`).
* @param {NonNegativeInteger} N - number of rows in matrix `V`
* @param {NonNegativeInteger} M - number of columns in matrix `V`
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
* @param {Float64Array} scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
* @param {integer} strideScale - stride of `scale`
* @param {NonNegativeInteger} offsetScale - starting index for `scale`
* @param {Float64Array} V - input matrix
* @param {integer} strideV1 - stride of the first dimension of `V`
* @param {integer} strideV2 - stride of the second dimension of `V`
* @param {NonNegativeInteger} offsetV - starting index for `V`
* @throws {TypeError} first argument must be a valid job
* @throws {TypeError} third argument must be a valid side
* @returns {Float64Array} `V`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var scale = new Float64Array( [ 0.5, 2.0, 1.0 ] );
* var V = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] );
*
* var out = dgebak( 'scale', 'right', 3, 2, 0, 2, scale, 1, 0, V, 2, 1, 0 );
* // returns <Float64Array>[ 0.5, 2, 4, 10, 3, 6 ]
*/
function dgebak( job, side, N, M, ilo, ihi, scale, strideScale, offsetScale, V, strideV1, strideV2, offsetV ) { // eslint-disable-line max-len, max-params
	if ( !isJob( job ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid job. Value: `%s`.', job ) );
	}
	if ( !isOperationSide( side ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid side. Value: `%s`.', side ) );
	}
	return base( job, side, N, M, ilo, ihi, scale, strideScale, offsetScale, V, strideV1, strideV2, offsetV ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dgebak;