@stdlib/array-dataview

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!

DataView

Constructor which returns a data view representing a provided array buffer.

Installation

npm install @stdlib/array-dataview

Usage

var DataView = require( '@stdlib/array-dataview' );

DataView( buffer[, byteOffset[, byteLength]] )

Returns a DataView representing a provided array buffer.

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

var buf = new ArrayBuffer( 5 );
// returns <ArrayBuffer>

var dv = new DataView( buf );
// returns <DataView>

Properties

DataView.prototype.buffer

Read-only property which returns the underlying array buffer.

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

var buf1 = new ArrayBuffer( 5 );
var dv = new DataView( buf1 );

var buf2 = dv.buffer;
// returns <ArrayBuffer>

var bool = ( buf1 === buf2 );
// returns true

DataView.prototype.byteLength

Read-only property which returns the length (in bytes) of the DataView.

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

var buf = new ArrayBuffer( 5 );
var dv = new DataView( buf );

var byteLength = dv.byteLength;
// returns 5

DataView.prototype.byteOffset

Read-only property which returns the number of bytes from the DataView to the start of the underlying array buffer.

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

var buf = new ArrayBuffer( 5 );
var dv = new DataView( buf, 3 );

var byteOffset = dv.byteOffset;
// returns 3

Methods

TODO: document methods

Examples

var IS_LITTLE_ENDIAN = require( '@stdlib/assert-is-little-endian' );
var toBinaryString = require( '@stdlib/number-uint8-base-to-binary-string' );
var randu = require( '@stdlib/random-base-randu' );
var Uint8Array = require( '@stdlib/array-uint8' );
var ArrayBuffer = require( '@stdlib/array-buffer' );
var DataView = require( '@stdlib/array-dataview' );

// Create a new ArrayBuffer:
var buf = new ArrayBuffer( 64 );

// Create a new DataView:
var dv = new DataView( buf );

// Set values in the view:
var i;
for ( i = 0; i < dv.byteLength/8; i++ ) {
    dv.setFloat64( i*8, randu()*100.0, IS_LITTLE_ENDIAN );
}

// Create a "bytes" view of the underlying array buffer:
var bytes = new Uint8Array( dv.buffer );

// Print the bytes:
for ( i = 0; i < bytes.length; i++ ) {
    console.log( 'byte %d: %s', i, toBinaryString( bytes[ i ] ) );
}

See Also

• @stdlib/array-buffer: ArrayBuffer.
• @stdlib/array-typed: create a typed array.

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.

Changelog

0.2.2 (2024-07-28)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.2.1">