@stdlib/strided-base-reinterpret-boolean v0.0.2

reinterpret

Reinterpret a BooleanArray as a Uint8Array.

Installation

npm install @stdlib/strided-base-reinterpret-boolean

Usage

var reinterpret = require( '@stdlib/strided-base-reinterpret-boolean' );

reinterpret( x, offset )

Returns a Uint8Array view of a BooleanArray.

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

var x = new BooleanArray( 10 );

var view = reinterpret( x, 0 );
// returns <Uint8Array>

var bool = ( view.buffer === x.buffer );
// returns true

var len = view.length;
// returns 10

The offset argument specifies the starting index of the returned Uint8Array view relative to the BooleanArray.

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

var x = new BooleanArray( [ true, false, false, true, true, false ] );

var view = reinterpret( x, 2 );
// returns <Uint8Array>

var len = view.length;
// returns 4

var v = view[ 0 ];
// returns 0

v = view[ 1 ];
// returns 1

Examples

var BooleanArray = require( '@stdlib/array-bool' );
var reinterpret = require( '@stdlib/strided-base-reinterpret-boolean' );

// Define a boolean array:
var x = new BooleanArray( [ true, false, false, true, true, false ] );
// returns <BooleanArray>

// Reinterpret as a `uint8` array:
var view = reinterpret( x, 0 );
// returns <Uint8Array>

// Set view elements:
view[ 0 ] = 0;
view[ 1 ] = 1;

// Get the first element of the boolean array:
var v = x.get( 0 );
// returns false

// Get the second element of the boolean array:
v = x.get( 1 );
// returns true

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.