Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

BooleanVector

Create a boolean vector (i.e., a one-dimensional ndarray).

Usage

var BooleanVector = require( '@stdlib/ndarray/vector/bool' );

BooleanVector( [options] )

Returns a one-dimensional boolean ndarray.

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

var arr = new BooleanVector();
// returns <ndarray>

var len = numel( arr );
// returns 0

The function accepts the following options:

  • order: specifies whether an ndarray is 'row-major' (C-style) or 'column-major' (Fortran-style). Default: 'row-major'.
  • mode: specifies how to handle indices which exceed array dimensions (see ndarray). Default: 'throw'.
  • readonly: boolean indicating whether an array should be read-only. Default: false.

BooleanVector( length[, options] )

Returns a one-dimensional boolean ndarray having a specified length.

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

var arr = new BooleanVector( 5 );
// returns <ndarray>

var len1 = numel( arr );
// returns 5

BooleanVector( obj[, options] )

Creates a one-dimensional boolean ndarray from an array-like object or iterable.

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

var arr = new BooleanVector( [ true, false, true ] );
// returns <ndarray>

var len1 = numel( arr );
// returns 3

BooleanVector( buffer[, byteOffset[, length]][, options] )

Returns a one-dimensional boolean ndarray view of an ArrayBuffer.

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

var buf = new ArrayBuffer( 32 );

var arr1 = new BooleanVector( buf );
// returns <ndarray>

var len1 = numel( arr1 );
// returns 32

var arr2 = new BooleanVector( buf, 16 );
// returns <ndarray>

var len2 = numel( arr2 );
// returns 16

var arr3 = new BooleanVector( buf, 16, 1 );
// returns <ndarray>

var len3 = numel( arr3 );
// returns 1

Examples

var bernoulli = require( '@stdlib/random/array/bernoulli' );
var every = require( '@stdlib/ndarray/every' );
var map = require( '@stdlib/ndarray/map' );
var BooleanVector = require( '@stdlib/ndarray/vector/bool' );

// Create a vector containing random values:
var x = new BooleanVector( bernoulli( 10, 0.9 ) );

// Determine whether every element is truthy:
var v = every( x );
console.log( v.get() );

// Define a function which inverts individual values:
function invert( v ) {
    return !v;
}

// Apply function:
var y = map( x, invert );

// Determine whether every element is truthy:
v = every( y );
console.log( v.get() );