Thanks to visit codestin.com
Credit goes to github.com

Skip to content

stdlib-js/ndarray-vector-bool

 
 

Repository files navigation

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!

BooleanVector

NPM version Build Status Coverage Status

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

Usage

To use in Observable,

BooleanVector = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-bool@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var BooleanVector = require( 'path/to/vendor/umd/ndarray-vector-bool/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-bool@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.BooleanVector;
})();
</script>

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

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-array-bernoulli@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-every@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-bool@umd/browser.js"></script>
<script type="text/javascript">
(function () {

// 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() );

})();
</script>
</body>
</html>

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.

Releases

No releases published

Packages

No packages published