stdlib-js/array-bufferPublic

NotificationsYou must be signed in to change notification settings
Fork1
Star2

ArrayBuffer.

License

Apache-2.0 license

2 stars 1 fork Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 62 Commits
.github		.github
benchmark		benchmark
dist		dist
docs		docs
examples		examples
lib		lib
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
branches.md		branches.md
package.json		package.json

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

ArrayBuffer

Constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.

Installation

npm install @stdlib/array-buffer

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

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

ArrayBuffer( size )

Returns anArrayBuffer having a specified number of bytes.

varbuf=newArrayBuffer(5);// returns <ArrayBuffer>

Properties

ArrayBuffer.length

Number of input arguments the constructor accepts.

varlen=ArrayBuffer.length;// returns 1

ArrayBuffer.prototype.byteLength

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

varbuf=newArrayBuffer(5);varbyteLength=buf.byteLength;// returns 5

Methods

ArrayBuffer.isView( arr )

Static method which returns aboolean indicating if provided a buffer view.

varFloat64Array=require('@stdlib/array-float64');varview=newFloat64Array(10);varbool=ArrayBuffer.isView(view);// returns true

ArrayBuffer.prototype.slice( [start[, end]] )

Copies the bytes of anArrayBuffer to a newArrayBuffer.

varb1=newArrayBuffer(10);varb2=b1.slice();// returns <ArrayBuffer>varbool=(b2===b1);// returns false

By default, the method copies from the beginning of theArrayBuffer. To beginning copying from a different byte index, provide astart argument, specifying the starting byte index (inclusive).

varb1=newArrayBuffer(10);varb2=b1.slice(2);varnbytes=b2.byteLength;// returns 8

Ifstart < 0, the index is relative to the end of theArrayBuffer.

varb1=newArrayBuffer(10);varb2=b1.slice(-2);varnbytes=b2.byteLength;// returns 2

By default, the method copies to the end of theArrayBuffer. To copy until a particular byte index, provide anend index, specifying the ending byte index (exclusive).

varb1=newArrayBuffer(10);varb2=b1.slice(2,6);varnbytes=b2.byteLength;// returns 4

Ifend < 0, the index is relative to the end of theArrayBuffer.

varb1=newArrayBuffer(10);varb2=b1.slice(2,-2);varnbytes=b2.byteLength;// returns 6

Examples

varrandu=require('@stdlib/random-base-randu');varFloat64Array=require('@stdlib/array-float64');varUint8Array=require('@stdlib/array-uint8');vartoBinaryString=require('@stdlib/number-uint8-base-to-binary-string');varArrayBuffer=require('@stdlib/array-buffer');varbytes;varbuf;vararr;vari;// Create a new ArrayBuffer:buf=newArrayBuffer(64);// Create a Float64 array buffer view:arr=newFloat64Array(buf.byteLength/8);for(i=0;i<arr.length;i++){arr[i]=randu()*100.0;}// Create a "bytes" view of the array buffer:bytes=newUint8Array(arr.buffer);// Print the bytes:for(i=0;i<bytes.length;i++){console.log('byte %d: %s',i,toBinaryString(bytes[i]));}

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.