ndims

Return the number of ndarray dimensions.

Installation

npm install @stdlib/ndarray-ndims

Usage

var ndims = require( '@stdlib/ndarray-ndims' );

ndims( x )

Returns the number of ndarray dimensions.

var zeros = require( '@stdlib/ndarray-zeros' );

var x = zeros( [ 3, 2, 3 ] );
// returns <ndarray>

var n = ndims( x );
// returns 3

Examples

var zeros = require( '@stdlib/ndarray-zeros' );
var slice = require( '@stdlib/ndarray-slice' );
var E = require( '@stdlib/slice-multi' );
var S = require( '@stdlib/slice-ctor' );
var ndims = require( '@stdlib/ndarray-ndims' );

// Create an array:
var x = zeros( [ 10, 10, 10, 10 ] );
// returns <ndarray>

// Define some slices:
var slices = [
    // :,:,:,:
    E( null, null, null, null ),

    // 5:10,4,2:4,::-1
    E( S( 5, 10 ), 4, S( 2, 4 ), S( null, null, -1 ) ),

    // :,:,2,:
    E( null, null, 2, null ),

    // 1,2,3,:
    E( 1, 2, 3, null ),

    // 1,3,::2,4::2
    E( 1, 3, S( null, null, 2 ), S( 4, null, 2 ) )
];

// Determine the number of dimensions in each slice...
var s;
var i;
for ( i = 0; i < slices.length; i++ ) {
    s = slice( x, slices[ i ] );
    console.log( '%s => %d dimensions', s.shape.join( 'x' ), ndims( s ) );
}

See Also

• @stdlib/ndarray-array: multidimensional arrays.
• @stdlib/ndarray-ctor: multidimensional array constructor.
• @stdlib/ndarray-numel: return the number of elements in an ndarray.
• @stdlib/ndarray-shape: return the shape of a provided ndarray.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.