Skip to content

Files

Latest commit

kgrytekgryte
Add forEach benchmarks
Oct 2, 2018
de8b6a7 · Oct 2, 2018

History

History

uint8c

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
Oct 2, 2018
docs
docs
Sep 9, 2018
examples
examples
Feb 2, 2018
lib
lib
Feb 10, 2018
test
test
Oct 2, 2018
README.md
README.md
Feb 2, 2018
package.json
package.json
Nov 22, 2017

README.md

Uint8ClampedArray

Typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order clamped to 0-255.

Usage

var Uint8ClampedArray = require( '@stdlib/array/uint8c' );

Uint8ClampedArray()

A typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order clamped to 0-255.

var arr = new Uint8ClampedArray();
// returns <Uint8ClampedArray>

Uint8ClampedArray( length )

Returns a typed array having a specified length.

var arr = new Uint8ClampedArray( 5 );
// returns <Uint8ClampedArray>[ 0, 0, 0, 0, 0 ]

Uint8ClampedArray( typedarray )

Creates a typed array from another typed array.

var Float32Array = require( '@stdlib/array/float32' );

var arr1 = new Float32Array( [ 5.0, 5.0, 5.0 ] );
var arr2 = new Uint8ClampedArray( arr1 );
// returns <Uint8ClampedArray>[ 5, 5, 5 ]

Uint8ClampedArray( obj )

Creates a typed array from an array-like object or iterable.

var arr = new Uint8ClampedArray( [ 5.0, 5.0, 5.0 ] );
// returns <Uint8ClampedArray>[ 5, 5, 5 ]

Uint8ClampedArray( buffer[, byteOffset[, length]] )

Returns a typed array view of an ArrayBuffer.

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

var buf = new ArrayBuffer( 4 );
var arr = new Uint8ClampedArray( buf, 0, 4 );
// returns <Uint8ClampedArray>[ 0, 0, 0, 0 ]

Properties

Uint8ClampedArray.BYTES_PER_ELEMENT

Number of bytes per view element.

var nbytes = Uint8ClampedArray.BYTES_PER_ELEMENT;
// returns 1

Uint8ClampedArray.name

Typed array constructor name.

var str = Uint8ClampedArray.name;
// returns 'Uint8ClampedArray'

Uint8ClampedArray.prototype.buffer

Read-only property which returns the ArrayBuffer referenced by the typed array.

var arr = new Uint8ClampedArray( 5 );
var buf = arr.buffer;
// returns <ArrayBuffer>

Uint8ClampedArray.prototype.byteLength

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

var arr = new Uint8ClampedArray( 5 );
var byteLength = arr.byteLength;
// returns 5

Uint8ClampedArray.prototype.byteOffset

Read-only property which returns the offset (in bytes) of the typed array from the start of its ArrayBuffer.

var arr = new Uint8ClampedArray( 5 );
var byteOffset = arr.byteOffset;
// returns 0

Uint8ClampedArray.prototype.length

Read-only property which returns the number of view elements.

var arr = new Uint8ClampedArray( 5 );
var len = arr.length;
// returns 5

Methods

TODO: add methods

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var ctor = require( '@stdlib/array/uint8c' );

var arr;
var i;

arr = new ctor( 10 );
for ( i = 0; i < arr.length; i++ ) {
    arr[ i ] = round( randu()*100.0 );
}
console.log( arr );