All files / ndims/lib main.js

86.27% Statements 44/51
100% Branches 1/1
0% Functions 0/1
86.27% Lines 44/51

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 521x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x               1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2023 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 isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
 
 
// MAIN //
 
/**
* Returns the number of ndarray dimensions.
*
* @param {ndarrayLike} x - input ndarray
* @returns {NonNegativeInteger} number of dimensions
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var n = ndims( zeros( [ 3, 3, 3 ] ) );
* // returns 3
*/
function ndims( x ) {
	var n = x.ndims; // Note: intentionally cache in case `ndims` is lazily resolved via accessor
	if ( isNumber( n ) ) {
		return n;
	}
	return x.shape.length;
}
 
 
// EXPORTS //
 
module.exports = ndims;