Package Exports

@stdlib/ndarray-vector-uint32
@stdlib/ndarray-vector-uint32/dist
@stdlib/ndarray-vector-uint32/dist/index.js
@stdlib/ndarray-vector-uint32/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/ndarray-vector-uint32) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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!

Uint32Vector

Create an unsigned 32-bit integer vector (i.e., a one-dimensional ndarray).

Installation

npm install @stdlib/ndarray-vector-uint32

Usage

var Uint32Vector = require( '@stdlib/ndarray-vector-uint32' );

Uint32Vector( [options] )

Returns a one-dimensional unsigned 32-bit integer ndarray.

var numel = require( '@stdlib/ndarray-numel' );

var arr = new Uint32Vector();
// returns <ndarray>

var len = numel( arr );
// returns 0

The function accepts the following options:

order: specifies whether an ndarray is 'row-major' (C-style) or 'column-major' (Fortran-style). Default: 'row-major'.
mode: specifies how to handle indices which exceed array dimensions (see ndarray). Default: 'throw'.
readonly: boolean indicating whether an array should be read-only. Default: false.

Uint32Vector( length[, options] )

Returns a one-dimensional unsigned 32-bit integer ndarray having a specified length.

var numel = require( '@stdlib/ndarray-numel' );

var arr = new Uint32Vector( 5 );
// returns <ndarray>

var len1 = numel( arr );
// returns 5

Uint32Vector( obj[, options] )

Creates a one-dimensional unsigned 32-bit integer ndarray from an array-like object or iterable.

var numel = require( '@stdlib/ndarray-numel' );

var arr = new Uint32Vector( [ 1, 2, 3 ] );
// returns <ndarray>

var len1 = numel( arr );
// returns 3

Uint32Vector( buffer[, byteOffset[, length]][, options] )

Returns a one-dimensional unsigned 32-bit integer ndarray view of an ArrayBuffer.

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

var buf = new ArrayBuffer( 32 );

var arr1 = new Uint32Vector( buf );
// returns <ndarray>

var len1 = numel( arr1 );
// returns 8

var arr2 = new Uint32Vector( buf, 16 );
// returns <ndarray>

var len2 = numel( arr2 );
// returns 4

var arr3 = new Uint32Vector( buf, 16, 1 );
// returns <ndarray>

var len3 = numel( arr3 );
// returns 1

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var sum = require( '@stdlib/blas-ext-sum' );
var map = require( '@stdlib/ndarray-map' );
var Uint32Vector = require( '@stdlib/ndarray-vector-uint32' );

// Create a vector containing random values:
var x = new Uint32Vector( discreteUniform( 10, 0, 100 ) );

// Compute the sum:
var v = sum( x );
console.log( v.get() );

// Define a function which applies a threshold to individual values:
function threshold( v ) {
    return ( v > 10 ) ? v : 0;
}

// Apply threshold:
var y = map( x, threshold );

// Recompute the sum:
v = sum( y );
console.log( v.get() );

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.

@stdlib/ndarray-vector-uint32