All files dlansy.js

100% Statements 87/87
100% Branches 14/14
100% Functions 1/1
100% Lines 87/87

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 882x 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 46x 46x 46x 46x 46x 4x 4x 46x 4x 4x 46x 4x 4x 46x 1x 1x 46x 6x 6x 46x 27x 27x 27x 33x 46x 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 isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' );
var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var max = require( '@stdlib/math/base/special/max' );
var format = require( '@stdlib/string/format' );
var isNorm = require( './is_norm.js' );
var base = require( './base.js' );
 
 
// MAIN //
 
/**
* Returns the value of the one-norm, Frobenius norm, infinity-norm, or the largest absolute value of any element of a real symmetric matrix `A`.
*
* @param {string} order - storage layout of `A`
* @param {string} norm - specifies the norm type
* @param {string} uplo - specifies whether the upper or lower triangular part of `A` is referenced
* @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`)
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must be a valid norm type
* @throws {TypeError} third argument must be a valid uplo value
* @throws {RangeError} sixth argument must be greater than or equal to `max(1, N)`
* @returns {number} matrix norm
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1.0, 2.0, 2.0, 5.0 ] );
*
* var norm = dlansy( 'row-major', 'M', 'upper', 2, A, 2 );
* // returns 5.0
*/
function dlansy( order, norm, uplo, N, A, LDA ) {
	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 type. Value: `%s`.', norm ) );
	}
	if ( !isMatrixTriangle( uplo ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid uplo value. Value: `%s`.', uplo ) );
	}
	if ( isRowMajor( order ) && LDA < max( 1, N ) ) {
		throw new RangeError( format( 'invalid argument. Sixth 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, uplo, N, A, sa1, sa2, 0 );
}
 
 
// EXPORTS //
 
module.exports = dlansy;