All files dlanhs.js

100% Statements 85/85
100% Branches 11/11
100% Functions 1/1
100% Lines 85/85

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 862x 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 93x 93x 93x 93x 13x 13x 93x 13x 13x 93x 8x 8x 93x 35x 35x 93x 24x 24x 24x 59x 93x 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 isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var isNorm = require( './is_norm.js' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Computes the value of the one norm, Frobenius norm, infinity norm, or the element of largest absolute value of an upper Hessenberg matrix `A`.
*
* ## Notes
*
* -   The part of `A` below the first subdiagonal is not referenced.
*
* @param {string} order - storage layout of `A`
* @param {string} norm - specifies the value to be returned
* @param {NonNegativeInteger} N - order of the matrix `A`
* @param {Float64Array} A - input matrix
* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
* @param {Float64Array} work - workspace array (only referenced when computing the infinity norm)
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must be a valid norm
* @throws {RangeError} fifth argument must be greater than or equal to max(1,N)
* @returns {number} norm value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 0.0, 7.0, 8.0 ] );
* var work = new Float64Array( 3 );
*
* var out = dlanhs( 'row-major', 'max', 3, A, 3, work );
* // returns 8.0
*/
function dlanhs( order, norm, N, A, LDA, work ) {
	var sa1;
	var sa2;
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( !isNorm( norm ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid norm. Value: `%s`.', norm ) );
	}
	if ( LDA < max( 1, N ) ) {
		throw new RangeError( format( 'invalid argument. Fifth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDA ) );
	}
	if ( isColumnMajor( order ) ) {
		sa1 = 1;
		sa2 = LDA;
	} else { // order === 'row-major'
		sa1 = LDA;
		sa2 = 1;
	}
	return base( norm, N, A, sa1, sa2, 0, work, 1, 0 );
}
 
 
// EXPORTS //
 
module.exports = dlanhs;