Data

Tools

Indexes

Applications

Experiments

Open Source Science

@stdlib/ndarray-at

Return an ndarray element.

https://github.com/stdlib-js/ndarray-at

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.2%) to scientific vocabulary

Keywords

access accessor data get getter javascript matrix ndarray node node-js nodejs retrieve stdlib structure types vector
Last synced: 6 months ago · JSON representation ·

Repository

Return an ndarray element.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
access accessor data get getter javascript matrix ndarray node node-js nodejs retrieve stdlib structure types vector
Created about 2 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

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!

at

NPM version Build Status Coverage Status <!-- dependencies -->

Return an ndarray element.

## Installation ```bash npm install @stdlib/ndarray-at ``` 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 at = require( '@stdlib/ndarray-at' ); ``` #### at( x\[, ...indices] ) Returns an [`ndarray`][@stdlib/ndarray/ctor] element. ```javascript var array = require( '@stdlib/ndarray-array' ); var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); // returns var v = at( x, 0, 0 ); // returns 1 v = at( x, 0, 1 ); // returns 2 v = at( x, 1, 0 ); // returns 3 v = at( x, 1, 1 ); // returns 4 ``` The function accepts the following arguments: - **x**: input [`ndarray`][@stdlib/ndarray/ctor]. - **indices**: index arguments. The number of index arguments **must** equal the number of dimensions.
## Notes - If provided out-of-bounds indices, the function always returns `undefined`. ```javascript var array = require( '@stdlib/ndarray-array' ); var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); // returns var v = at( x, 10, 20 ); // returns undefined ``` - Negative indices are resolved relative to the last element along the respective dimension, with the last element corresponding to `-1`. ```javascript var array = require( '@stdlib/ndarray-array' ); var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); // returns var v = at( x, -1, -1 ); // returns 4 v = at( x, -2, -2 ); // returns 1 ```
## Examples ```javascript var cartesianProduct = require( '@stdlib/array-cartesian-product' ); var zeroTo = require( '@stdlib/array-zero-to' ); var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); var array = require( '@stdlib/ndarray-array' ); var at = require( '@stdlib/ndarray-at' ); // Define a two-dimensional array: var shape = [ 5, 5 ]; var x = array( discreteUniform( 25, -100, 100 ), { 'shape': shape }); // Define lists of dimension indices: var i0 = zeroTo( shape[ 0 ], 'generic' ); var i1 = zeroTo( shape[ 1 ], 'generic' ); // Create a list of index pairs: var indices = cartesianProduct( i0, i1 ); // Print array contents... var idx; var i; for ( i = 0; i < x.length; i++ ) { idx = indices[ i ]; console.log( 'x[%d,%d] = %d', idx[ 0 ], idx[ 1 ], at( x, idx[ 0 ], idx[ 1 ] ) ); } ```
* * * ## See Also - [`@stdlib/ndarray-array`][@stdlib/ndarray/array]: multidimensional arrays. - [`@stdlib/ndarray-slice`][@stdlib/ndarray/slice]: return a read-only view of an input ndarray.
* * * ## 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

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
  • Push event: 29
Last Year
  • Push event: 29

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 6 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 4
npmjs.org: @stdlib/ndarray-at

Return an ndarray element.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6 Last month
Rankings
Dependent repos count: 33.2%
Average: 40.3%
Dependent packages count: 47.3%
Maintainers (4)
planeshifter rreusser stdlib-bot kgryte
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 7 months ago