@stdlib/array-base-resolve-setter

Return an accessor function for setting an element in an array-like object.

https://github.com/stdlib-js/array-base-resolve-setter

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

Keywords

access accessor array generic javascript node node-js nodejs set setter stdlib
Last synced: 6 months ago · JSON representation ·

Repository

Return an accessor function for setting an element in an array-like object.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
access accessor array generic javascript node node-js nodejs set setter stdlib
Created about 2 years ago · Last pushed about 1 year 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!

resolveSetter

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

Return an accessor function for setting an element in an array-like object.

## Installation ```bash npm install @stdlib/array-base-resolve-setter ``` 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 resolveSetter = require( '@stdlib/array-base-resolve-setter' ); ``` #### resolveSetter( x ) Returns an accessor function for setting an element in an array-like object. ```javascript var x = [ 1, 2, 3, 4 ]; var set = resolveSetter( x ); // returns set( x, 2, 10 ); var v = x[ 2 ]; // returns 10 ``` The returned accessor function accepts the following arguments: - **arr**: input array. - **idx**: element index. - **value**: value to set.
## Notes - If provided an array-like object having an unsupported [data type][@stdlib/array/dtypes], the function returns a default accessor function for accessing elements in any array-like object; otherwise, the function returns an accessor function which should **only** be provided an array instance having the same data type (e.g., if provided a `Float64Array`, the returned accessor function should only be provided instances of `Float64Array`). - Accessor functions do **not** verify that provided input arrays are array instances having a specific data type, as doing so would introduce performance overhead. If array instances corresponding to other data types are provided to an accessor function, JavaScript runtimes will consider the function polymorphic, potentially triggering de-optimization. In order to ensure maximum performance, **always** ensure that an accessor function is monomorphic. - Accessor functions do **not** perform bounds checking. - Accessor functions do **not** verify that provided input arrays implement the get/set protocol. - An _indexed_ array-like object is a data structure in which one retrieves elements via integer indices using bracket `[]` notation (e.g., `Float64Array`, `Int32Array`, `Array`, etc). This is in contrast to an _accessor_ array-like object in which one retrieves elements using `get` and `set` methods (e.g., `Complex64Array` and `Complex128Array`).
## Examples ```javascript var filled = require( '@stdlib/array-filled' ); var resolveSetter = require( '@stdlib/array-base-resolve-setter' ); var arr = filled( 1.0, 10, 'float64' ); resolveSetter( arr )( arr, 2, 100.0 ); console.log( arr ); arr = filled( 2.0, 10, 'float32' ); resolveSetter( arr )( arr, 2, 100.0 ); console.log( arr ); arr = filled( 3, 10, 'int32' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); arr = filled( 4, 10, 'int16' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); arr = filled( 5, 10, 'int8' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); arr = filled( 6, 10, 'uint32' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); arr = filled( 7, 10, 'uint16' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); arr = filled( 8, 10, 'uint8' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); arr = filled( 9, 10, 'uint8c' ); resolveSetter( arr )( arr, 2, 100 ); console.log( arr ); ```
* * * ## 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-2024. 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: 5
Last Year
  • Push event: 5

Issues and Pull Requests

Last synced: 6 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
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 12 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 4
npmjs.org: @stdlib/array-base-resolve-setter

Return an accessor function for setting an element in an array-like object.

  • 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: 12 Last month
Rankings
Dependent repos count: 34.1%
Average: 41.4%
Dependent packages count: 48.7%
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 6 months ago