Uint8ClampedVector

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

Installation

npm install @stdlib/ndarray-vector-uint8c

Usage

var Uint8ClampedVector = require( '@stdlib/ndarray-vector-uint8c' );

Uint8ClampedVector( [options] )

Returns a one-dimensional clamped unsigned 8-bit integer ndarray.

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

var arr = new Uint8ClampedVector();
// 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.

Uint8ClampedVector( length[, options] )

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

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

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

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

Uint8ClampedVector( obj[, options] )

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

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

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

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

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

Returns a one-dimensional clamped unsigned 8-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 Uint8ClampedVector( buf );
// returns <ndarray>

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

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

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

var arr3 = new Uint8ClampedVector( 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 Uint8ClampedVector = require( '@stdlib/ndarray-vector-uint8c' );

// Create a vector containing random values:
var x = new Uint8ClampedVector( 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.

Copyright

Copyright © 2016-2026. The Stdlib Authors.