Skip to content

stdlib-js/strided-base-reinterpret-boolean

 
 

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!

reinterpret

NPM version Build Status Coverage Status

Reinterpret a BooleanArray as a Uint8Array.

Usage

To use in Observable,

reinterpret = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@umd/browser.js' )

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

var reinterpret = require( 'path/to/vendor/umd/strided-base-reinterpret-boolean/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@umd/browser.js"></script>

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

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

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

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/array-bool@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-reinterpret-boolean@umd/browser.js"></script>
<script type="text/javascript">
(function () {

// 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

})();
</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-2024. The Stdlib Authors.