All files ndarray.js

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

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 91 92 93 94 95 962x 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 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 56x 56x 11x 11x 45x 56x 2x 2x 2x 2x 2x  
/**
* @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 format = require( '@stdlib/string/format' );
var isMatrixNorm = require( './is_norm.js' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Returns the value of the one norm, or the Frobenius norm, or the infinity norm, or the element of largest absolute value of a real symmetric tridiagonal matrix using alternative indexing semantics.
*
* ## Notes
*
* -   `D` should have `N` indexed elements.
* -   `E` should have `N-1` indexed elements.
*
* @param {string} norm - specifies the norm to be returned
* @param {NonNegativeInteger} N - order of the matrix
* @param {Float64Array} D - array containing the diagonal elements
* @param {integer} strideD - stride length for `D`
* @param {NonNegativeInteger} offsetD - starting index for `D`
* @param {Float64Array} E - array containing the sub-diagonal elements
* @param {integer} strideE - stride length for `E`
* @param {NonNegativeInteger} offsetE - starting index for `E`
* @throws {TypeError} first argument must be a valid norm
* @returns {number} norm value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var D = new Float64Array( [ 4.0, -2.0, 5.0, -1.0 ] );
* var E = new Float64Array( [ 1.0, -3.0, 2.0 ] );
*
* var out = dlanst( 'max', 4, D, 1, 0, E, 1, 0 );
* // returns 5.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var D = new Float64Array( [ 4.0, -2.0, 5.0, -1.0 ] );
* var E = new Float64Array( [ 1.0, -3.0, 2.0 ] );
*
* var out = dlanst( 'one-norm', 4, D, 1, 0, E, 1, 0 );
* // returns 10.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var D = new Float64Array( [ 4.0, -2.0, 5.0, -1.0 ] );
* var E = new Float64Array( [ 1.0, -3.0, 2.0 ] );
*
* var out = dlanst( 'infinity-norm', 4, D, 1, 0, E, 1, 0 );
* // returns 10.0
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var D = new Float64Array( [ 4.0, -2.0, 5.0, -1.0 ] );
* var E = new Float64Array( [ 1.0, -3.0, 2.0 ] );
*
* var out = dlanst( 'frobenius-norm', 4, D, 1, 0, E, 1, 0 );
* // returns ~8.6023
*/
function dlanst( norm, N, D, strideD, offsetD, E, strideE, offsetE ) {
	if ( !isMatrixNorm( norm ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid norm. Value: `%s`.', norm ) );
	}
	return base( norm, N, D, strideD, offsetD, E, strideE, offsetE );
}
 
 
// EXPORTS //
 
module.exports = dlanst;