All files dlansp.js

100% Statements 74/74
100% Branches 8/8
100% Functions 1/1
100% Lines 74/74

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 752x 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 53x 53x 4x 4x 53x 4x 4x 53x 4x 4x 41x 53x 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 format = require( '@stdlib/string/format' );
var base = require( './base.js' );
 
 
// VARIABLES //
 
var NORMS = [ 'M', 'm', '1', 'O', 'o', 'I', 'i', 'F', 'f', 'E', 'e' ];
var UPLOS = [ 'upper', 'lower' ];
 
 
// 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 `AP` supplied in packed form.
*
* @param {string} order - storage layout of `AP`
* @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} AP - packed form of a symmetric 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
* @returns {number} matrix norm
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* // AP = [ 1.0, 2.0, 5.0 ] (2x2 symmetric packed column-major upper)
* var AP = new Float64Array( [ 1.0, 2.0, 5.0 ] );
*
* var norm = dlansp( 'column-major', 'M', 'upper', 2, AP );
* // returns 5.0
*/
function dlansp( order, norm, uplo, N, AP ) {
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( NORMS.indexOf( norm ) === -1 ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid norm type. Value: `%s`.', norm ) );
	}
	if ( UPLOS.indexOf( uplo ) === -1 ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid uplo value. Value: `%s`.', uplo ) );
	}
	return base( order, norm, uplo, N, AP, 1, 0 );
}
 
 
// EXPORTS //
 
module.exports = dlansp;