All files ndarray.js

100% Statements 73/73
100% Branches 6/6
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 89x 89x 13x 13x 89x 13x 13x 63x 89x 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.
*/
 
/* eslint-disable max-len, max-params */
 
'use strict';
 
// MODULES //
 
var isMatrixTriangle = require( '@stdlib/blas/base/assert/is-matrix-triangle' );
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 a real symmetric band matrix `A` using alternative indexing semantics.
*
* @param {string} norm - specifies the value to be returned
* @param {string} uplo - specifies whether the upper or lower triangular part of the band matrix `A` is supplied
* @param {NonNegativeInteger} N - order of the matrix `A`
* @param {NonNegativeInteger} K - number of super-/sub-diagonals of the band matrix `A`
* @param {Float64Array} AB - input band matrix stored in banded format
* @param {integer} strideAB1 - stride of the first dimension of `AB`
* @param {integer} strideAB2 - stride of the second dimension of `AB`
* @param {NonNegativeInteger} offsetAB - starting index for `AB`
* @param {Float64Array} work - workspace array (only referenced when computing the one or infinity norm)
* @param {integer} strideWork - stride length for `work`
* @param {NonNegativeInteger} offsetWork - starting index for `work`
* @throws {TypeError} first argument must be a valid norm
* @throws {TypeError} second argument must specify whether to reference the upper or lower triangular matrix
* @returns {number} norm value
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var AB = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var work = new Float64Array( 3 );
*
* var out = dlansb( 'max', 'upper', 3, 1, AB, 1, 2, 0, work, 1, 0 );
* // returns 5.0
*/
function dlansb( norm, uplo, N, K, AB, strideAB1, strideAB2, offsetAB, work, strideWork, offsetWork ) {
	if ( !isNorm( norm ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid norm. Value: `%s`.', norm ) );
	}
	if ( !isMatrixTriangle( uplo ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must specify whether to reference the upper or lower triangular matrix. Value: `%s`.', uplo ) );
	}
	return base( norm, uplo, N, K, AB, strideAB1, strideAB2, offsetAB, work, strideWork, offsetWork );
}
 
 
// EXPORTS //
 
module.exports = dlansb;