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!

typedarray

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Create a typed array.

Installation

``bash npm install @stdlib/array-typed`

`Usage`

`javascript var typedarray = require( '@stdlib/array-typed' );`

#### typedarray( \[dtype] )

Creates a [typed array][mdn-typed-array] having a specified [data type][@stdlib/array/typed-dtypes].

`javascript var arr = typedarray(); // returns`

By default, the output [typed array][mdn-typed-array] data type is float64. To specify an alternative data type, provide a [dtype][@stdlib/array/typed-dtypes] argument.

`javascript var arr = typedarray( 'int32' ); // returns`

#### typedarray( length\[, dtype] )

Returns a [typed array][mdn-typed-array] having a specified length.

`javascript var arr1 = typedarray( 5 ); // returns [ 0.0, 0.0, 0.0, 0.0, 0.0 ]

var arr2 = typedarray( 5, 'uint8' ); // returns [ 0, 0, 0, 0, 0 ]`

#### typedarray( typedarray\[, dtype] )

Creates a [typed array][mdn-typed-array] from another [typed array][mdn-typed-array].

`javascript var arr1 = typedarray( [ 5.0, -3.0, 2.0 ] ); // returns [ 5.0, -3.0, 2.0 ]

var arr2 = typedarray( arr1 ); // returns [ 5.0, -3.0, 2.0 ]

var arr3 = typedarray( arr1, 'int32' ); // returns [ 5, -3, 2 ]`

#### typedarray( obj\[, dtype] )

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

`javascript var arr1 = typedarray( [ 0.5, 0.5, 0.5 ] ); // returns [ 0.5, 0.5, 0.5 ]

var arr2 = typedarray( [ 0.5, 0.5, 0.5 ], 'float32' ); // returns [ 0.5, 0.5, 0.5 ]`

If [dtype][@stdlib/array/typed-dtypes] 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][mdn-typed-array] view of an [ArrayBuffer][mdn-arraybuffer].

`javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var buf = new ArrayBuffer( 32 );

var arr1 = typedarray( buf ); // returns [ 0.0, 0.0, 0.0, 0.0 ]

var arr2 = typedarray( buf, 'float32' ); // returns [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

var arr3 = typedarray( buf, 16 ); // returns [ 0.0, 0.0 ]

var arr4 = typedarray( buf, 16, 'float32' ); // returns [ 0.0, 0.0, 0.0, 0.0 ]

var arr5 = typedarray( buf, 16, 1 ); // returns [ 0.0 ]

var arr6 = typedarray( buf, 10, 4, 'int16' ); // returns [ 0, 0, 0, 0 ]`

`Notes`

- When providing a complex number array, if [dtype][@stdlib/array/typed-dtypes] is unspecified or the specified data type is not a complex number data type, the returned array contains interleaved real and imaginary components.

`Examples`

`javascript 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 );`

*

`Notice`

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/array-typed.svg [npm-url]: https://npmjs.org/package/@stdlib/array-typed

[test-image]: https://github.com/stdlib-js/array-typed/actions/workflows/test.yml/badge.svg?branch=v0.3.2 [test-url]: https://github.com/stdlib-js/array-typed/actions/workflows/test.yml?query=branch:v0.3.2

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-typed/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/array-typed?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/array-typed/tree/deno [deno-readme]: https://github.com/stdlib-js/array-typed/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/array-typed/tree/umd [umd-readme]: https://github.com/stdlib-js/array-typed/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/array-typed/tree/esm [esm-readme]: https://github.com/stdlib-js/array-typed/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/array-typed/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-typed/main/LICENSE

[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray

[mdn-arraybuffer]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer

[@stdlib/array/typed-dtypes]: https://www.npmjs.com/package/@stdlib/array-typed-dtypes

[@stdlib/array/complex128]: https://www.npmjs.com/package/@stdlib/array-complex128

[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64

[@stdlib/array/float64]: https://www.npmjs.com/package/@stdlib/array-float64

[@stdlib/array/float32]: https://www.npmjs.com/package/@stdlib/array-float32

[@stdlib/array/int32]: https://www.npmjs.com/package/@stdlib/array-int32

[@stdlib/array/uint32]: https://www.npmjs.com/package/@stdlib/array-uint32

[@stdlib/array/int16]: https://www.npmjs.com/package/@stdlib/array-int16

[@stdlib/array/uint16]: https://www.npmjs.com/package/@stdlib/array-uint16

[@stdlib/array/int8]: https://www.npmjs.com/package/@stdlib/array-int8

[@stdlib/array/uint8]: https://www.npmjs.com/package/@stdlib/array-uint8

[@stdlib/array/uint8c]: https://www.npmjs.com/package/@stdlib/array-uint8c


  
    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!

`typedarray`

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Create a typed array.

`Installation`

``bash npm install @stdlib/array-typed `

`Usage`

`javascript var typedarray = require( '@stdlib/array-typed' ); `

#### typedarray( \[dtype] )

Creates a [typed array][mdn-typed-array] having a specified [data type][@stdlib/array/typed-dtypes].

`javascript var arr = typedarray(); // returns `

By default, the output [typed array][mdn-typed-array] data type is float64. To specify an alternative data type, provide a [dtype][@stdlib/array/typed-dtypes] argument.

`javascript var arr = typedarray( 'int32' ); // returns `

#### typedarray( length\[, dtype] )

Returns a [typed array][mdn-typed-array] having a specified length.

`javascript var arr1 = typedarray( 5 ); // returns [ 0.0, 0.0, 0.0, 0.0, 0.0 ]

var arr2 = typedarray( 5, 'uint8' ); // returns [ 0, 0, 0, 0, 0 ] `

#### typedarray( typedarray\[, dtype] )

Creates a [typed array][mdn-typed-array] from another [typed array][mdn-typed-array].

`javascript var arr1 = typedarray( [ 5.0, -3.0, 2.0 ] ); // returns [ 5.0, -3.0, 2.0 ]

var arr2 = typedarray( arr1 ); // returns [ 5.0, -3.0, 2.0 ]

var arr3 = typedarray( arr1, 'int32' ); // returns [ 5, -3, 2 ] `

#### typedarray( obj\[, dtype] )

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

`javascript var arr1 = typedarray( [ 0.5, 0.5, 0.5 ] ); // returns [ 0.5, 0.5, 0.5 ]

var arr2 = typedarray( [ 0.5, 0.5, 0.5 ], 'float32' ); // returns [ 0.5, 0.5, 0.5 ] `

If [dtype][@stdlib/array/typed-dtypes] 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][mdn-typed-array] view of an [ArrayBuffer][mdn-arraybuffer].

`javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var buf = new ArrayBuffer( 32 );

var arr1 = typedarray( buf ); // returns [ 0.0, 0.0, 0.0, 0.0 ]

var arr2 = typedarray( buf, 'float32' ); // returns [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]

var arr3 = typedarray( buf, 16 ); // returns [ 0.0, 0.0 ]

var arr4 = typedarray( buf, 16, 'float32' ); // returns [ 0.0, 0.0, 0.0, 0.0 ]

var arr5 = typedarray( buf, 16, 1 ); // returns [ 0.0 ]

var arr6 = typedarray( buf, 10, 4, 'int16' ); // returns [ 0, 0, 0, 0 ] `

`Notes`

- When providing a complex number array, if [dtype][@stdlib/array/typed-dtypes] is unspecified or the specified data type is not a complex number data type, the returned array contains interleaved real and imaginary components.

`Examples`

`javascript 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 ); `