Create a clamped unsigned 8-bit integer vector (i.e., a one-dimensional ndarray).
npm install @stdlib/ndarray-vector-uint8cWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create a clamped unsigned 8-bit integer vector (i.e., a one-dimensional [ndarray][@stdlib/ndarray/ctor]).
``bash`
npm install @stdlib/ndarray-vector-uint8c
`javascript`
var Uint8ClampedVector = require( '@stdlib/ndarray-vector-uint8c' );
#### Uint8ClampedVector( \[options] )
Returns a one-dimensional clamped unsigned 8-bit integer [ndarray][@stdlib/ndarray/ctor].
`javascript
var numel = require( '@stdlib/ndarray-numel' );
var arr = new Uint8ClampedVector();
// returns
var len = numel( arr );
// returns 0
`
The function accepts the following options:
- order: specifies whether an [ndarray][@stdlib/ndarray/ctor] is 'row-major' (C-style) or 'column-major' (Fortran-style). Default: 'row-major'.ndarray
- mode: specifies how to handle indices which exceed array dimensions (see [][@stdlib/ndarray/ctor]). Default: 'throw'.false
- readonly: boolean indicating whether an array should be read-only. Default: .
#### Uint8ClampedVector( length\[, options] )
Returns a one-dimensional clamped unsigned 8-bit integer [ndarray][@stdlib/ndarray/ctor] having a specified length.
`javascript
var numel = require( '@stdlib/ndarray-numel' );
var arr = new Uint8ClampedVector( 5 );
// returns
var len1 = numel( arr );
// returns 5
`
#### Uint8ClampedVector( obj\[, options] )
Creates a one-dimensional clamped unsigned 8-bit integer [ndarray][@stdlib/ndarray/ctor] from an array-like object or iterable.
`javascript
var numel = require( '@stdlib/ndarray-numel' );
var arr = new Uint8ClampedVector( [ 1, 2, 3 ] );
// returns
var len1 = numel( arr );
// returns 3
`
#### Uint8ClampedVector( buffer\[, byteOffset\[, length]]\[, options] )
Returns a one-dimensional clamped unsigned 8-bit integer [ndarray][@stdlib/ndarray/ctor] view of an [ArrayBuffer][@stdlib/array/buffer].
`javascript
var ArrayBuffer = require( '@stdlib/array-buffer' );
var numel = require( '@stdlib/ndarray-numel' );
var buf = new ArrayBuffer( 32 );
var arr1 = new Uint8ClampedVector( buf );
// returns
var len1 = numel( arr1 );
// returns 32
var arr2 = new Uint8ClampedVector( buf, 16 );
// returns
var len2 = numel( arr2 );
// returns 16
var arr3 = new Uint8ClampedVector( buf, 16, 1 );
// returns
var len3 = numel( arr3 );
// returns 1
`
`javascript
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() );
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-vector-uint8c.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-vector-uint8c
[test-image]: https://github.com/stdlib-js/ndarray-vector-uint8c/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/ndarray-vector-uint8c/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-vector-uint8c/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-vector-uint8c?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/ndarray-vector-uint8c/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-vector-uint8c/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-vector-uint8c/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-vector-uint8c/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-vector-uint8c/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-vector-uint8c/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-vector-uint8c/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-uint8c/main/LICENSE
[@stdlib/array/buffer]: https://www.npmjs.com/package/@stdlib/array-buffer
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor