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

100% Statements 73/73
100% Branches 4/4
100% Functions 1/1
100% Lines 73/73

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 742x 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 54x 54x 13x 13x 41x 54x 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 isOperation = require( './isoperation.js' );
var NORMS = require( './norms.json' ).norms;
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Returns the value of the one norm, or the frobenius norm, or the infinity norm, or the element with the largest absolute value of a real matrix `A`.
*
* ## Notes
*
* -   use `norm` = `max` to calculate the element with the largest absolute value
* -   use `norm` = `one` to calculate the one norm, work should have `N` indexed elements if row-major layout is used
* -   use `norm` = `infinity` to calculate the infinity norm, work should have `M` indexed elements if column-major layout is used
* -   use `norm` = `frobenius` to calculate the frobenius norm
*
* @param {string} norm - specifies the type of norm to be calculated
* @param {NonNegativeInteger} M - number of rows in `A`
* @param {NonNegativeInteger} N - number of columns in `A`
* @param {Float64Array} A - input array
* @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 of `A`
* @param {Float64Array} work - temporary workspace array
* @param {integer} strideWork - stride length of `work`
* @param {NonNegativeInteger} offsetWork - starting index of `work`
* @throws {TypeError} first argument must be a valid operation
* @returns {number} required norm value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1.0, 4.0, 7.0, 10.0, 2.0, 5.0, 8.0, 11.0, 3.0, 6.0, 9.0, 12.0 ] );
* var work = new Float64Array( 3 );
*
* var out = dlange( 'frobenius', 3, 4, A, 4, 1, 0, work, 1, 0 );
* // returns ~25.5
*/
function dlange( norm, M, N, A, strideA1, strideA2, offsetA, work, strideWork, offsetWork ) { // eslint-disable-line max-len
	if ( !isOperation( norm ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be one of the following: "%s". Value: `%s`.', NORMS.join( '", "' ), norm ) );
	}
	return base( norm, M, N, A, strideA1, strideA2, offsetA, work, strideWork, offsetWork ); // eslint-disable-line max-len
}
 
 
// EXPORTS //
 
module.exports = dlange;