Skip to content

Latest commit

 

History

History
552 lines (345 loc) · 36.9 KB

README.md

File metadata and controls

552 lines (345 loc) · 36.9 KB
Raw
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!

Arrays

NPM version Build Status Coverage Status

Arrays.

Usage

import ns from 'https://cdn.jsdelivr.net/gh/stdlib-js/array@esm/index.mjs';

The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the tagged bundles. For example,

import ns from 'https://cdn.jsdelivr.net/gh/stdlib-js/array@v0.3.3-esm/index.mjs';

You can also import the following named exports from the package:

import { ArrayBuffer, ArrayIndex, BooleanArray, Complex128Array, Complex64Array, DataView, Float32Array, Float32ArrayFE, Float32ArrayLE, Float64Array, Float64ArrayFE, Float64ArrayLE, Int16Array, Int32Array, Int8Array, SharedArrayBuffer, Uint16Array, Uint32Array, Uint8Array, Uint8ClampedArray, array2fancy, array2iterator, array2iteratorRight, arrayview2iterator, arrayview2iteratorRight, base, byteOrders, cartesianPower, cartesianProduct, cartesianSquare, circarray2iterator, complexarray, complexarrayCtors, complexarrayDataTypes, constants, convert, convertSame, ctors, datespace, defaults, dtype, dtypes, empty, emptyLike, filled, filledBy, fixedEndianFactory, floatarrayCtors, floatarrayDataTypes, full, fullLike, incrspace, intarrayCtors, intarrayDataTypes, intarraySignedCtors, intarraySignedDataTypes, intarrayUnsignedCtors, intarrayUnsignedDataTypes, iterator2array, linspace, littleEndianFactory, logspace, minDataType, mostlySafeCasts, mskfilter, mskput, mskreject, nans, nansLike, nextDataType, oneTo, oneToLike, ones, onesLike, place, promotionRules, put, realarray, realarrayCtors, realarrayDataTypes, realarrayFloatCtors, realarrayFloatDataTypes, safeCasts, sameKindCasts, scalar2array, shape, slice, sparsearray2iterator, sparsearray2iteratorRight, stridedarray2iterator, take, typedarray, typedarray2json, typedarrayCtors, typedarrayDataTypes, typedarrayReviver, typedarraypool, zeroTo, zeroToLike, zeros, zerosLike } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array@esm/index.mjs';

ns

Arrays.

var o = ns;
// returns {...}

The namespace exports the following array constructors:

  • ArrayBuffer( size ): constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.
  • Float32Array(): typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order.
  • Float64Array(): typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in the platform byte order.
  • Int16Array(): typed array constructor which returns a typed array representing an array of twos-complement 16-bit signed integers in the platform byte order.
  • Int32Array(): typed array constructor which returns a typed array representing an array of twos-complement 32-bit signed integers in the platform byte order.
  • Int8Array(): typed array constructor which returns a typed array representing an array of twos-complement 8-bit signed integers in the platform byte order.
  • SharedArrayBuffer( size ): constructor returning an object used to represent a generic, fixed-length raw binary data buffer which can be used to create views of shared memory.
  • Uint16Array(): typed array constructor which returns a typed array representing an array of 16-bit unsigned integers in the platform byte order.
  • Uint32Array(): typed array constructor which returns a typed array representing an array of 32-bit unsigned integers in the platform byte order.
  • Uint8Array(): typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order.
  • 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.
var arr = new ns.Int32Array( 5 );
// returns <Int32Array>[ 0, 0, 0, 0, 0 ]

Alternatively, use the typedarray function to create a typed array of a given data type:

var arr1 = ns.typedarray( 5 );
// returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ]

var arr2 = ns.typedarray( 5, 'uint8' );
// returns <Uint8Array>[ 0, 0, 0, 0, 0 ]

The namespace contains functions to create arrays pre-filled with spaced values:

You can use the following functions to retrieve a list of available data types:

Furthermore, the namespace contains utility functions to retrieve a given constructor:

var ctor = ns.typedarrayCtors( 'float64' );
// returns <Function>

ctor = ns.typedarrayCtors( 'int' );
// returns null

Lastly, the namespace contains various other functions for dealing with arrays, including functions to convert arrays from one data type to another or to serialize them as JSON and vice versa.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="module">

import objectKeys from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils/keys@esm/index.mjs';
import ns from 'https://cdn.jsdelivr.net/gh/stdlib-js/array@esm/index.mjs';

console.log( objectKeys( ns ) );

</script>
</body>
</html>

Notice

This package is part of stdlib, a standard library 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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.