Skip to content

any

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

any

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
docs
docs
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

any

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

Usage

var any = require( '@stdlib/ndarray/any' );

any( x[, options] )

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

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

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

// Perform reduction:
var out = any( x );
// returns <ndarray>[ 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' );

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

// Perform reduction:
var out = any( x, {
    'dims': [ 1, 2 ]
});
// returns <ndarray>[ 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' );

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

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

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

Tests whether at least one 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, 0.0 ] ], [ [ -3.0, 0.0 ] ], [ [ 5.0, 0.0 ] ] ] );
// returns <ndarray>

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

// Perform reduction:
var out = any.assign( x, y );
// returns <ndarray>[ true ]

var bool = ( out === y );
// 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' );

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

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

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

var bool = ( out === y );
// returns 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 any = require( '@stdlib/ndarray/any' );

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

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

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

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

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

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

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

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

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