8000 GitHub - stdlib-js/ndarray-vector-uint8c at esm
[go: up one dir, main page]

Skip to content

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

License

Notifications You must be signed in to change notification settings

stdlib-js/ndarray-vector-uint8c

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 contin 8000 ued support!

Uint8ClampedVector

NPM version Build Status Coverage Status

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

Usage

import Uint8ClampedVector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-uint8c@esm/index.mjs';

Uint8ClampedVector( [options] )

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

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

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.

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

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.

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

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.

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

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

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

import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs';
import sum from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-sum@esm/index.mjs';
import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs';
import Uint8ClampedVector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-uint8c@esm/index.mjs';

// 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() );

</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-2025. The Stdlib Authors.

0