ndarray-vector-ctor

Create a vector (i.e., a one-dimensional ndarray).

https://github.com/stdlib-js/ndarray-vector-ctor

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (16.4%) to scientific vocabulary

Keywords

constructor ctor data javascript ndarray node node-js nodejs stdlib structure types vec vector

Last synced: 6 months ago · JSON representation ·

Repository

Create a vector (i.e., a one-dimensional ndarray).

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 544 KB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Topics

constructor ctor data javascript ndarray node node-js nodejs stdlib structure types vec vector

Created 9 months ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

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!

Vector

Create a vector (i.e., a one-dimensional ndarray).

## Installation ```bash npm install @stdlib/ndarray-vector-ctor ``` 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 vector = require( '@stdlib/ndarray-vector-ctor' ); ``` #### vector( \[dtype]\[, options] ) Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] having a specified [data type][@stdlib/ndarray/dtypes]. ```javascript var getDType = require( '@stdlib/ndarray-dtype' ); var numel = require( '@stdlib/ndarray-numel' ); var arr = vector(); // returns var len = numel( arr ); // returns 0 var dt = getDType( arr ); // returns 'float64' ``` By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [`float64`][@stdlib/ndarray/dtypes] data type. To specify an alternative [data type][@stdlib/ndarray/dtypes], provide a `dtype` argument. ```javascript var getDType = require( '@stdlib/ndarray-dtype' ); var numel = require( '@stdlib/ndarray-numel' ); var arr = vector( 'int32' ); // returns var len = numel( arr ); // returns 0 var dt = getDType( arr ); // returns 'int32' ``` 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`. #### vector( length\[, dtype]\[, options] ) Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] having a specified `length`. ```javascript var numel = require( '@stdlib/ndarray-numel' ); var arr1 = vector( 5 ); // returns var len1 = numel( arr1 ); // returns 5 var arr2 = vector( 5, 'uint8' ); // returns var len2 = numel( arr2 ); // returns 5 ``` #### vector( obj\[, dtype]\[, options] ) Creates a one-dimensional [ndarray][@stdlib/ndarray/ctor] from an array-like object or iterable. ```javascript var numel = require( '@stdlib/ndarray-numel' ); var arr1 = vector( [ 0.5, 0.5, 0.5 ] ); // returns var len1 = numel( arr1 ); // returns 3 var arr2 = vector( [ 0.5, 0.5, 0.5 ], 'float32' ); // returns var len2 = numel( arr2 ); // returns 3 ``` #### vector( buffer\[, byteOffset\[, length]]\[, dtype]\[, options] ) Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] view of an [`ArrayBuffer`][@stdlib/array/buffer]. ```javascript var ArrayBuffer = require( '@stdlib/array-buffer' ); var getDType = require( '@stdlib/ndarray-dtype' ); var numel = require( '@stdlib/ndarray-numel' ); var buf = new ArrayBuffer( 32 ); var arr1 = vector( buf ); // returns var len1 = numel( arr1 ); // returns 4 var dt1 = getDType( arr1 ); // returns 'float64' var arr2 = vector( buf, 'float32' ); // returns var len2 = numel( arr2 ); // returns 8 var dt2 = getDType( arr2 ); // returns 'float32' var arr3 = vector( buf, 16 ); // returns var len3 = numel( arr3 ); // returns 2 var dt3 = getDType( arr3 ); // returns 'float64' var arr4 = vector( buf, 16, 'float32' ); // returns var len4 = numel( arr4 ); // returns 4 var dt4 = getDType( arr4 ); // returns 'float32' var arr5 = vector( buf, 16, 1 ); // returns var len5 = numel( arr5 ); // returns 1 var dt5 = getDType( arr5 ); // returns 'float64' var arr6 = vector( buf, 10, 4, 'int16' ); // returns var len6 = numel( arr6 ); // returns 4 var dt6 = getDType( arr6 ); // returns 'int16' ``` #### vector.factory( dtype\[, options] ) Returns a function for creating a one-dimensional [ndarray][@stdlib/ndarray/ctor]. ```javascript var getDType = require( '@stdlib/ndarray-dtype' ); var numel = require( '@stdlib/ndarray-numel' ); var Float32Vector = vector.factory( 'float32' ); var arr = new Float32Vector( [ 1, 2, 3 ] ); // returns var dt = getDType( arr ); // returns 'float32' var len = numel( arr ); // returns 3 ``` The function supports the following parameters: - **dtype**: [data type][@stdlib/ndarray/dtypes]. - **options**: function options (_optional_). The function accepts the following options: - **order**: specifies whether the default memory layout for a returned [ndarray][@stdlib/ndarray/ctor] should be `'row-major'` (C-style) or `'column-major'` (Fortran-style). Default: `'row-major'`. - **mode**: specifies the default behavior when handling indices which exceed array dimensions (see [`ndarray`][@stdlib/ndarray/ctor]). Default: `'throw'`. - **readonly**: boolean indicating whether to return a **read-only** [ndarray][@stdlib/ndarray/ctor] by default. Default: `false`. The function returned by the `factory` method supports the same arguments and options as `vector` above, except for the `dtype` argument, as the returned function always returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] having the same [data type][@stdlib/ndarray/dtypes]. When providing options to the returned function, the provided option values override the defaults established during function creation.

## Examples ```javascript var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var cartesianProduct = require( '@stdlib/array-cartesian-product' ); var unzip = require( '@stdlib/utils-unzip' ); var dtypes = require( '@stdlib/ndarray-dtypes' ); var sum = require( '@stdlib/blas-ext-sum' ); var logEachMap = require( '@stdlib/console-log-each-map' ); var vector = require( '@stdlib/ndarray-vector-ctor' ); // Create an array of random array lengths: var lens = discreteUniform( 10, 5, 15, { 'dtype': 'int32' }); // Resolve a list of supported ndarray real-valued data types: var dts = dtypes( 'real_and_generic' ); // Create length-dtype pairs: var pairs = cartesianProduct( lens, dts ); // Split the pairs into individual arguments: var args = unzip( pairs ); // Define a callback to create a random vector and return the sum of all vector elements: function clbk( len, dtype ) { var x = vector( discreteUniform( len, 0, 100 ), dtype ); return sum( x ).get(); } // Apply the callback and print the results: logEachMap( 'len: %2d. dtype: %7s. sum: %d.', args[ 0 ], args[ 1 ], clbk ); ```

* * * ## 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-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Member event: 1
Push event: 28
Create event: 6

Last Year

Member event: 1
Push event: 28
Create event: 6

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request 9c18513d320d7b2c7185fb93396d0c664d5d8448 composite

.github/workflows/examples.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/npm_downloads.yml actions

actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
actions/upload-artifact 5d5d22a31266ced268874388b861e4b58bb5c2f3 composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/productionize.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
JS-DevTools/npm-publish 19c28f1ef146469e409470805ea4279d47c3d35c composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
styfle/cancel-workflow-action 85880fa0301c86cca9da44039ee3bb12d3bedbfa composite

.github/workflows/test.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_bundles.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
denoland/setup-deno 041b854f97b325bd60e53e9dc2de9cb9f9ac0cba composite

.github/workflows/test_coverage.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite
codecov/codecov-action 84508663e988701840491b86de86b666e8a86bed composite
distributhor/workflow-webhook 48a40b380ce4593b6a6676528cd005986ae56629 composite

.github/workflows/test_install.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

.github/workflows/test_published_package.yml actions

8398a7/action-slack 28ba43ae48961b90635b50953d216767a6bea486 composite
actions/checkout 8ade135a41bc03ea155e62e844d188df1ea18608 composite
actions/setup-node b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 composite

package.json npm

@stdlib/array-cartesian-product ^0.2.2 development
@stdlib/assert-is-function ^0.2.2 development
@stdlib/assert-is-method ^0.2.2 development
@stdlib/assert-is-ndarray-like ^0.2.2 development
@stdlib/bench-harness ^0.2.2 development
@stdlib/blas-ext-sum github:stdlib-js/blas-ext-sum#main development
@stdlib/console-log-each-map github:stdlib-js/console-log-each-map#main development
@stdlib/math-base-special-pow ^0.3.0 development
@stdlib/ndarray-dtypes ^0.3.0 development
@stdlib/random-array-discrete-uniform ^0.2.1 development
@stdlib/utils-unzip ^0.2.2 development
istanbul ^0.4.1 development
tap-min git+https://github.com/Planeshifter/tap-min.git development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-copy ^0.2.2
@stdlib/array-from-iterator ^0.2.2
@stdlib/array-typed ^0.3.0
@stdlib/assert-has-own-property ^0.2.2
@stdlib/assert-is-arraybuffer ^0.2.2
@stdlib/assert-is-boolean ^0.2.2
@stdlib/assert-is-buffer ^0.2.2
@stdlib/assert-is-collection ^0.2.2
@stdlib/assert-is-iterable-like ^0.2.2
@stdlib/assert-is-nonnegative-integer ^0.2.2
@stdlib/assert-is-plain-object ^0.2.2
@stdlib/buffer-from-array ^0.2.2
@stdlib/buffer-from-arraybuffer ^0.2.2
@stdlib/buffer-from-buffer ^0.2.2
@stdlib/error-tools-fmtprodmsg ^0.2.2
@stdlib/ndarray-base-assert-is-data-type ^0.2.2
@stdlib/ndarray-base-assert-is-index-mode ^0.2.2
@stdlib/ndarray-base-assert-is-order ^0.2.2
@stdlib/ndarray-base-buffer ^0.3.0
@stdlib/ndarray-base-bytes-per-element ^0.2.2
@stdlib/ndarray-base-strides2offset ^0.2.2
@stdlib/ndarray-ctor ^0.2.2
@stdlib/ndarray-defaults ^0.3.0
@stdlib/object-assign ^0.2.2
@stdlib/string-format ^0.2.2
@stdlib/symbol-iterator ^0.2.2
@stdlib/types ^0.4.3
@stdlib/utils-define-nonenumerable-read-only-property ^0.2.2

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

ndarray-vector-ctor

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Vector

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Dependencies