Nonlinear Performance Magnification
Need private packages and team management tools?Check out npm Teams »

compute-array-constructors

1.0.1 • Public • Published

Array Constructors

NPM version Build Status Coverage Status Dependencies

Returns an array constructor corresponding to an array data type.

Installation

$ npm install compute-array-constructors

For use in the browser, use browserify.

Usage

var getCtor = require( 'compute-array-constructors' );

getCtor( dtype )

Returns an array constructor corresponding to an array data type.

var ctor = getCtor( 'int8' );
// returns Int8Array

The following array data types are supported:

Data Type Constructor
int8 Int8Array
uint8 Uint8Array
uint8_clamped Uint8ClampedArray
int16 Int16Array
uint16 Uint16Array
int32 Int32Array
uint32 Uint32Array
float32 Float32Array
float64 Float64Array
generic Array

Examples

var getCtor = require( 'compute-array-constructors' );
 
console.log( getCtor( 'int8' ) );
// returns Int8Array
 
console.log( getCtor( 'uint8' ) );
// returns Uint8Array
 
console.log( getCtor( 'uint8_clamped' ) );
// returns Uint8ClampedArray
 
console.log( getCtor( 'int16' ) );
// returns Int16Array
 
console.log( getCtor( 'uint16' ) );
// returns Uint16Array
 
console.log( getCtor( 'int32' ) );
// returns Int32Array
 
console.log( getCtor( 'uint32' ) );
// returns Uint32Array
 
console.log( getCtor( 'float32' ) );
// returns Float32Array
 
console.log( getCtor( 'float64' ) );
// returns Float64Array
 
console.log( getCtor( 'generic' ) );
// returns Array
 
console.log( getCtor( null ) );
// returns null
 
console.log( getCtor( 'object' ) );
// returns null
 
console.log( getCtor( 'array' ) );
// returns null
 
console.log( getCtor( {} ) );
// returns null
 
console.log( getCtor( [] ) );
// returns null

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. The Compute.io Authors.

Install

npm i compute-array-constructors

DownloadsWeekly Downloads

1,228

Version

1.0.1

License

MIT

Last publish

Collaborators

  • avatar