https://github.com/stdlib-js/ndarray-vector-int8
Create a signed 8-bit integer vector (i.e., a one-dimensional ndarray).
https://github.com/stdlib-js/ndarray-vector-int8
constructor ctor data int8 javascript ndarray node node-js nodejs stdlib structure types vec vector
Last synced: about 1 month ago
JSON representation
Create a signed 8-bit integer vector (i.e., a one-dimensional ndarray).
- Host: GitHub
- URL: https://github.com/stdlib-js/ndarray-vector-int8
- Owner: stdlib-js
- License: apache-2.0
- Created: 2025-05-19T08:32:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-21T05:29:31.000Z (about 1 month ago)
- Last Synced: 2026-04-21T07:29:15.218Z (about 1 month ago)
- Topics: constructor, ctor, data, int8, javascript, ndarray, node, node-js, nodejs, stdlib, structure, types, vec, vector
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.09 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
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!
# Int8Vector
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Create a signed 8-bit integer vector (i.e., a one-dimensional [ndarray][@stdlib/ndarray/ctor]).
## Installation
```bash
npm install @stdlib/ndarray-vector-int8
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var Int8Vector = require( '@stdlib/ndarray-vector-int8' );
```
#### Int8Vector( \[options] )
Returns a one-dimensional signed 8-bit integer [ndarray][@stdlib/ndarray/ctor].
```javascript
var numel = require( '@stdlib/ndarray-numel' );
var arr = new Int8Vector();
// 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'`.
- **mode**: specifies how to handle indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`.
- **readonly**: boolean indicating whether an array should be **read-only**. Default: `false`.
#### Int8Vector( length\[, options] )
Returns a one-dimensional signed 8-bit integer [ndarray][@stdlib/ndarray/ctor] having a specified `length`.
```javascript
var numel = require( '@stdlib/ndarray-numel' );
var arr = new Int8Vector( 5 );
// returns
var len1 = numel( arr );
// returns 5
```
#### Int8Vector( obj\[, options] )
Creates a one-dimensional signed 8-bit integer [ndarray][@stdlib/ndarray/ctor] from an array-like object or iterable.
```javascript
var numel = require( '@stdlib/ndarray-numel' );
var arr = new Int8Vector( [ 1, 2, 3 ] );
// returns
var len1 = numel( arr );
// returns 3
```
#### Int8Vector( buffer\[, byteOffset\[, length]]\[, options] )
Returns a one-dimensional signed 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 Int8Vector( buf );
// returns
var len1 = numel( arr1 );
// returns 32
var arr2 = new Int8Vector( buf, 16 );
// returns
var len2 = numel( arr2 );
// returns 16
var arr3 = new Int8Vector( buf, 16, 1 );
// returns
var len3 = numel( arr3 );
// returns 1
```
## Examples
```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var sum = require( '@stdlib/blas-ext-sum' );
var map = require( '@stdlib/ndarray-map' );
var Int8Vector = require( '@stdlib/ndarray-vector-int8' );
// Create a vector containing random values:
var x = new Int8Vector( 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][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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-vector-int8.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-vector-int8
[test-image]: https://github.com/stdlib-js/ndarray-vector-int8/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/ndarray-vector-int8/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-vector-int8/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-vector-int8?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-int8/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-vector-int8/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-vector-int8/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-vector-int8/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-vector-int8/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-vector-int8/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-vector-int8/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-int8/main/LICENSE
[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor