Package Exports

@stdlib/ndarray-every
@stdlib/ndarray-every/lib/index.js

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-every) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

every

Test whether every element along one or more ndarray dimensions is truthy.

Installation

npm install @stdlib/ndarray-every

Usage

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

every( x[, options] )

Tests whether every element along one or more ndarray dimensions is truthy.

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

// Create an input ndarray:
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

// Perform reduction:
var out = every( x );
// returns <ndarray>

var v = out.get();
// returns true

The function accepts the following arguments:

x: input ndarray.
options: function options (optional).

The function accepts the following options:

dims: list of dimensions over which to perform a reduction.
keepdims: boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions. Default: false.

By default, the function performs a reduction over all elements in a provided ndarray. To reduce specific dimensions, set the dims option.

var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );

// Create an input ndarray:
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

// Perform reduction:
var out = every( x, {
    'dims': [ 1, 2 ]
});
// returns <ndarray>

var v = ndarray2array( out );
// returns [ true, true, true ]

By default, the function returns an ndarray having a shape matching only the non-reduced dimensions of the input ndarray (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output ndarray, set the keepdims option to true.

var array = require( '@stdlib/ndarray-array' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );

// Create an input ndarray:
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

// Perform reduction:
var out = every( x, {
    'dims': [ 1, 2 ],
    'keepdims': true
});
// returns <ndarray>

var v = ndarray2array( out );
// returns [ [ [ true ] ], [ [ true ] ], [ [ true ] ] ]

every.assign( x, out[, options] )

Tests whether every element along one or more ndarray dimensions is truthy and assigns results to a provided output ndarray.

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

// Create an input ndarray:
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

// Create an output ndarray:
var y = empty( [], {
    'dtype': 'bool'
});

// Perform reduction:
var out = every.assign( x, y );
// returns <ndarray>

var bool = ( out === y );
// returns true

var v = y.get();
// returns true

The function accepts the following arguments:

x: input ndarray.
out: output ndarray. The output ndarray must have a shape matching the non-reduced dimensions of the input ndarray.
options: function options (optional).

The function accepts the following options:

dims: list of dimensions over which to perform a reduction.

By default, the function performs a reduction over all elements in a provided ndarray. To reduce specific dimensions, set the dims option.

var array = require( '@stdlib/ndarray-array' );
var empty = require( '@stdlib/ndarray-empty' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );

// Create an input ndarray:
var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
// returns <ndarray>

// Create an output ndarray:
var y = empty( [ 3 ], {
    'dtype': 'bool'
});

// Perform reduction:
var out = every.assign( x, y, {
    'dims': [ 1, 2 ]
});

var bool = ( out === y );
// returns true

var v = ndarray2array( y );
// returns [ true, true, true ]

Examples

var bernoulli = require( '@stdlib/random-base-bernoulli' ).factory;
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var fillBy = require( '@stdlib/ndarray-fill-by' );
var zeros = require( '@stdlib/ndarray-zeros' );
var every = require( '@stdlib/ndarray-every' );

var x = zeros( [ 2, 4, 5 ], {
    'dtype': 'float64'
});
x = fillBy( x, bernoulli( 0.90 ) );
console.log( ndarray2array( x ) );

var y = every( x );
console.log( 'every(x[:,:,:]) =' );
console.log( y.get() );

y = every( x, {
    'dims': [ 0 ],
    'keepdims': true
});
console.log( 'every(x[:,j,k]) =' );
console.log( ndarray2array( y ) );

y = every( x, {
    'dims': [ 1 ],
    'keepdims': true
});
console.log( 'every(x[i,:,k]) =' );
console.log( ndarray2array( y ) );

y = every( x, {
    'dims': [ 2 ],
    'keepdims': true
});
console.log( 'every(x[i,j,:]) =' );
console.log( ndarray2array( y ) );

y = every( x, {
    'dims': [ 0, 1 ],
    'keepdims': true
});
console.log( 'every(x[:,:,k]) =' );
console.log( ndarray2array( y ) );

y = every( x, {
    'dims': [ 0, 2 ],
    'keepdims': true
});
console.log( 'every(x[:,j,:]) =' );
console.log( ndarray2array( y ) );

y = every( x, {
    'dims': [ 1, 2 ],
    'keepdims': true
});
console.log( 'every(x[i,:,:]) =' );
console.log( ndarray2array( y ) );

y = every( x, {
    'dims': [ 0, 1, 2 ],
    'keepdims': true
});
console.log( 'every(x[:,:,:]) =' );
console.log( ndarray2array( y ) );

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.

@stdlib/ndarray-every