https://github.com/stdlib-js/array-base-accessor-setter
Return an accessor function for setting an element in an array-like object supporting the get/set protocol.
https://github.com/stdlib-js/array-base-accessor-setter
access accessor array generic javascript node node-js nodejs retrieve set setter stdlib
Last synced: 2 months ago
JSON representation
Return an accessor function for setting an element in an array-like object supporting the get/set protocol.
- Host: GitHub
- URL: https://github.com/stdlib-js/array-base-accessor-setter
- Owner: stdlib-js
- License: apache-2.0
- Created: 2022-12-06T03:26:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-04-02T03:26:05.000Z (3 months ago)
- Last Synced: 2026-04-02T16:42:27.999Z (3 months ago)
- Topics: access, accessor, array, generic, javascript, node, node-js, nodejs, retrieve, set, setter, stdlib
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 352 KB
- Stars: 1
- 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!
# accessorSetter
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return an accessor function for setting an element in an array-like object supporting the get/set protocol.
## Installation
```bash
npm install @stdlib/array-base-accessor-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 accessorSetter = require( '@stdlib/array-base-accessor-setter' );
```
#### accessorSetter( dtype )
Returns an accessor function for setting an element in an array-like object supporting the get/set protocol.
```javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
var set = accessorSetter( 'complex64' );
set( arr, 1, new Complex64( 10.0, 11.0 ) );
var v = arr.get( 1 );
// returns [ 10.0, 11.0 ]
```
The returned accessor function accepts the following arguments:
- **arr**: input array.
- **idx**: element index.
- **value**: value to set.
## Notes
- If provided an unsupported [`dtype`][@stdlib/array/dtypes], the function returns a default accessor function for accessing elements from any indexed array-like object supporting the get/set protocol; otherwise, the function returns an accessor function which should **only** be provided an array instance corresponding to `dtype` (e.g., if `dtype` is `'complex64'`, the returned accessor function should only be provided instances of `Complex64Array`).
- Accessor functions do **not** verify that provided input arrays are array instances corresponding to `dtype`, 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** validate input values.
- Accessor functions do **not** verify that provided input arrays actually implement the get/set protocol.
- An array-like object supporting the get/set protocol is a data structure in which one accesses elements using explicit `get` and `set` methods (e.g., `Complex64Array` and `Complex128Array`).
## Examples
```javascript
var Complex128Array = require( '@stdlib/array-complex128' );
var Complex64Array = require( '@stdlib/array-complex64' );
var Complex128 = require( '@stdlib/complex-float64-ctor' );
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var zeroTo = require( '@stdlib/array-base-zero-to' );
var dtype = require( '@stdlib/array-dtype' );
var accessorSetter = require( '@stdlib/array-base-accessor-setter' );
var arr = new Complex128Array( zeroTo( 10 ) );
accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );
var v = arr.get( 2 );
// returns [ 100.0, 101.0 ]
console.log( '%s', v.toString() );
// => '100 + 101i'
arr = new Complex64Array( zeroTo( 10 ) );
accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );
v = arr.get( 4 );
// returns [ 102.0, 103.0 ]
console.log( '%s', v.toString() );
// => '102 + 103i'
```
* * *
## 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/array-base-accessor-setter.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-accessor-setter
[test-image]: https://github.com/stdlib-js/array-base-accessor-setter/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-accessor-setter/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-accessor-setter/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-accessor-setter?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/array-base-accessor-setter/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-accessor-setter/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-accessor-setter/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-accessor-setter/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-accessor-setter/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-accessor-setter/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-accessor-setter/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-accessor-setter/main/LICENSE
[@stdlib/array/dtypes]: https://github.com/stdlib-js/array-dtypes