Skip to content

includes

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

includes

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

includes

Test whether an ndarray contains a specified value along one or more dimensions.

Usage

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

includes( x, searchElement[, options] )

Tests whether an ndarray contains a specified value along one or more dimensions.

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 = includes( x, 5.0 );
// returns <ndarray>

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

The function accepts the following arguments:

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 = includes( x, 5.0, {
    'dims': [ 1, 2 ]
});
// returns <ndarray>

var v = ndarray2array( out );
// returns [ false, false, 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 = includes( x, 5.0, {
    'dims': [ 1, 2 ],
    'keepdims': true
});
// returns <ndarray>

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

includes.assign( x, searchElement, out[, options] )

Tests whether an ndarray contains a specified value along one or more dimensions 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 = includes.assign( x, 5.0, y );
// returns <ndarray>

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

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

The function accepts the following arguments:

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 = includes.assign( x, 5.0, y, {
    'dims': [ 1, 2 ]
});

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

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

Examples

var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory;
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var fillBy = require( '@stdlib/ndarray/fill-by' );
var zeros = require( '@stdlib/ndarray/zeros' );
var includes = require( '@stdlib/ndarray/includes' );

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

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

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

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

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

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

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

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

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