Package Exports
- @stdlib/ndarray-base-singleton-dimensions
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/ndarray-base-singleton-dimensions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Singleton Dimensions
Return the number of singleton dimensions.
Installation
npm install @stdlib/ndarray-base-singleton-dimensionsUsage
var singletonDimensions = require( '@stdlib/ndarray-base-singleton-dimensions' );singletonDimensions( shape )
Returns number of singleton dimensions.
var n = singletonDimensions( [ 3, 1, 3 ] );
// returns 1Notes
- A singleton dimension is a dimension whose size is equal to
1.
Examples
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
var singletonDimensions = require( '@stdlib/ndarray-base-singleton-dimensions' );
var shape;
var n;
var i;
shape = [ 0, 0, 0 ];
for ( i = 0; i < 100; i++ ) {
shape[ 0 ] = discreteUniform( 1, 5 );
shape[ 1 ] = discreteUniform( 1, 5 );
shape[ 2 ] = discreteUniform( 1, 5 );
n = singletonDimensions( shape );
console.log( 'shape: %s. singleton dimensions: %d.', shape.join( 'x' ), n );
}C APIs
Installation
npm install @stdlib/ndarray-base-singleton-dimensionsUsage
#include "stdlib/ndarray/base/singleton_dimensions.h"stdlib_ndarray_singleton_dimensions( ndims, *shape )
Returns the number of singleton dimensions.
int64_t ndims = 2;
int64_t shape[] = { 10, 1 };
int64_t n = stdlib_ndarray_singleton_dimensions( ndims, shape );
// returns 1The function accepts the following arguments:
- ndims:
[in] int64_tnumber of dimensions. - shape:
[in] int64_t*array shape.
int64_t stdlib_ndarray_singleton_dimensions( int64_t ndims, int64_t *shape );Examples
#include "stdlib/ndarray/base/singleton_dimensions.h"
#include <stdio.h>
int main() {
int64_t shape[] = { 10, 3, 1, 1, 5 };
int64_t n = stdlib_ndarray_singleton_dimensions( 5, shape );
printf( "shape: %llux%llux%llux%llux%llu. singleton dimensions: %llu\n", shape[ 0 ], shape[ 1 ], shape[ 2 ], shape[ 3 ], shape[ 4 ], n );
}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.
License
See LICENSE.
Copyright
Copyright © 2016-2021. The Stdlib Authors.