@stdlib/array-typed
v0.3.0
Published
Create a typed array.
Downloads
779
Keywords
Readme
typedarray
Create a typed array.
Installation
npm install @stdlib/array-typed
Usage
var typedarray = require( '@stdlib/array-typed' );
typedarray( [dtype] )
Creates a typed array having a specified data type.
var arr = typedarray();
// returns <Float64Array>
By default, the output typed array data type is float64
. To specify an alternative data type, provide a dtype
argument.
var arr = typedarray( 'int32' );
// returns <Int32Array>
typedarray( length[, dtype] )
Returns a typed array having a specified length
.
var arr1 = typedarray( 5 );
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]
var arr2 = typedarray( 5, 'uint8' );
// returns <Uint8Array>[ 0, 0, 0, 0, 0 ]
typedarray( typedarray[, dtype] )
Creates a typed array from another typed array.
var arr1 = typedarray( [ 5.0, -3.0, 2.0 ] );
// returns <Float64Array>[ 5.0, -3.0, 2.0 ]
var arr2 = typedarray( arr1 );
// returns <Float64Array>[ 5.0, -3.0, 2.0 ]
var arr3 = typedarray( arr1, 'int32' );
// returns <Int32Array>[ 5, -3, 2 ]
typedarray( obj[, dtype] )
Creates a typed array from an array-like object or iterable.
var arr1 = typedarray( [ 0.5, 0.5, 0.5 ] );
// returns <Float64Array>[ 0.5, 0.5, 0.5 ]
var arr2 = typedarray( [ 0.5, 0.5, 0.5 ], 'float32' );
// returns <Float32Array>[ 0.5, 0.5, 0.5 ]
If dtype
is complex number data type and an array-like object contains interleaved real and imaginary components, the array-like object must have a length which is a multiple of two.
typedarray( buffer[, byteOffset[, length]][, dtype] )
Returns a typed array view of an ArrayBuffer
.
var ArrayBuffer = require( '@stdlib/array-buffer' );
var buf = new ArrayBuffer( 32 );
var arr1 = typedarray( buf );
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0 ]
var arr2 = typedarray( buf, 'float32' );
// returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
var arr3 = typedarray( buf, 16 );
// returns <Float64Array>[ 0.0, 0.0 ]
var arr4 = typedarray( buf, 16, 'float32' );
// returns <Float32Array>[ 0.0, 0.0, 0.0, 0.0 ]
var arr5 = typedarray( buf, 16, 1 );
// returns <Float64Array>[ 0.0 ]
var arr6 = typedarray( buf, 10, 4, 'int16' );
// returns <Int16Array>[ 0, 0, 0, 0 ]
Notes
- When providing a complex number array, if
dtype
is unspecified or the specified data type is not a complex number data type, the returned array contains interleaved real and imaginary components.
Examples
var randu = require( '@stdlib/random-base-randu' );
var typedarray = require( '@stdlib/array-typed' );
var arr = typedarray( 100, 'float64' );
var i;
for ( i = 0; i < arr.length; i++ ) {
arr[ i ] = randu() * 100.0;
}
console.log( arr );
See Also
@stdlib/array-complex128
: Complex128Array.@stdlib/array-complex64
: Complex64Array.@stdlib/array-float64
: Float64Array.@stdlib/array-float32
: Float32Array.@stdlib/array-int32
: Int32Array.@stdlib/array-uint32
: Uint32Array.@stdlib/array-int16
: Int16Array.@stdlib/array-uint16
: Uint16Array.@stdlib/array-int8
: Int8Array.@stdlib/array-uint8
: Uint8Array.@stdlib/array-uint8c
: Uint8ClampedArray.
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.