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

100% Statements 72/72
100% Branches 2/2
100% Functions 1/1
100% Lines 72/72

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 732x 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 13x 13x 13x 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 base = require( './base.js' );
 
 
// MAIN //
 
/**
* Estimates the one-norm of a square matrix `A`, using alternative indexing semantics and reverse communication for evaluating matrix-vector products.
*
* ## Notes
*
* the reverse communication takes place using `KASE`, it may have any of these values:
*
* -   `0`: estimation is complete
* -   `1`: caller must compute `A * X` and store the result back in `X`
* -   `2`: caller must compute `A' * X` (transpose) and store the result back in `X`
*
* @param {PositiveInteger} N - number of rows/columns in `A`
* @param {Float64Array} V - workspace array having `N` indexed elements, used internally to store intermediate vectors
* @param {Float64Array} X - input/output vector having `N` indexed elements, contains the current or next matrix-vector product
* @param {Int32Array} ISGN - integer array having `N` indexed elements, stores the sign of each element in `X` during iterations
* @param {Float64Array} EST - single-element array, on output, contains the estimated one-norm of the matrix `A`
* @param {Int32Array} KASE - single-element array that controls the reverse communication.
* @param {Int32Array} ISAVE - integer array of having 3 indexed elements, used internally to maintain state across multiple calls
* @returns {void}
*
* @example
* var Int32Array = require( '@stdlib/array/int32' );
* var Float64Array = require( '@stdlib/array/float64' );
*
* var V = new Float64Array( [ 5.0, 3.0, 1.0, 5.0 ] );
* var X = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var ISGN = new Int32Array( [ 1, 1, 1, 1 ] );
* var EST = new Float64Array( [ 10 ] )
* var KASE = new Int32Array( [ 1 ] )
* var ISAVE = new Int32Array( [ 2, 3, 1 ] );
*
* dlacn2( 4, V, X, ISGN, EST, KASE, ISAVE );
* // X => <Float64Array>[ 0.0, 0.0, 0.0, 1.0 ]
* // V => <Float64Array>[ 5.0, 3.0, 1.0, 5.0 ]
* // EST => <Float64Array>[ 10.0 ]
* // KASE => <Int32Array>[ 1 ]
*/
function dlacn2( N, V, X, ISGN, EST, KASE, ISAVE ) {
	return base( N, V, 1, 0, X, 1, 0, ISGN, 1, 0, EST, 0, KASE, 0, ISAVE, 1, 0 ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dlacn2;