All files is_norm.js

100% Statements 56/56
100% Branches 2/2
100% Functions 1/1
100% Lines 56/56

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 573x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 31x 31x 31x 3x 3x 3x 3x 3x  
/**
* @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 contains = require( '@stdlib/array/base/assert/contains' ).factory;
 
 
// VARIABLES //
 
var NORMS = [ 'max', 'one-norm', 'infinity-norm', 'frobenius-norm' ];
var isNorm = contains( NORMS );
 
 
// MAIN //
 
/**
* Tests whether a value is a valid matrix norm.
*
* @private
* @param {*} value - value to test
* @returns {boolean} boolean indicating whether a value is a valid matrix norm
*
* @example
* var bool = isMatrixNorm( 'max' );
* // returns true
*
* @example
* var bool = isMatrixNorm( 'foo' );
* // returns false
*/
function isMatrixNorm( value ) {
	return isNorm( value );
}
 
 
// EXPORTS //
 
module.exports = isMatrixNorm;