stdlib-js/array-base-accessor-setterPublic

NotificationsYou must be signed in to change notification settings
Fork0
Star1

Return an accessor function for setting an element in an array-like object supporting the get/set protocol.

License

Apache-2.0 license

1 star 0 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 38 Commits
.github		.github
benchmark		benchmark
dist		dist
docs		docs
examples		examples
lib		lib
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
.npmrc		.npmrc
CHANGELOG.md		CHANGELOG.md
CITATION.cff		CITATION.cff
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS		CONTRIBUTORS
LICENSE		LICENSE
Makefile		Makefile
NOTICE		NOTICE
README.md		README.md
SECURITY.md		SECURITY.md
branches.md		branches.md
package.json		package.json

Repository files navigation

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 considerfinancially supporting stdlib. We greatly appreciate your continued support!

accessorSetter

Return an accessor function for setting an element in an array-like object supporting the get/set protocol.

Installation

npm install @stdlib/array-base-accessor-setter

Alternatively,

To load the package in a website via ascript tag without installation and bundlers, use theES Module available on theesm branch (seeREADME).
If you are using Deno, visit thedeno branch (seeREADME for usage intructions).
For use in Observable, or in browser/node environments, use theUniversal Module Definition (UMD) build available on theumd branch (seeREADME).

Thebranches.md 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

varaccessorSetter=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.

varComplex64Array=require('@stdlib/array-complex64');varComplex64=require('@stdlib/complex-float32-ctor');varrealf=require('@stdlib/complex-float32-real');varimagf=require('@stdlib/complex-float32-imag');vararr=newComplex64Array([1,2,3,4]);varset=accessorSetter('complex64');set(arr,1,newComplex64(10.0,11.0));varv=arr.get(1);// returns <Complex64>varre=realf(v);// returns 10.0varim=imagf(v);// returns 11.0

The returned accessor function accepts the following arguments:

arr: input array.
idx: element index.
value: value to set.

Notes

If provided an unsupporteddtype, 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 shouldonly be provided an array instance corresponding todtype (e.g., ifdtype is'complex64', the returned accessor function should only be provided instances ofComplex64Array).
Accessor functions donot verify that provided input arrays are array instances corresponding todtype, 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 donot perform bounds checking.
Accessor functions donot validate input values.
Accessor functions donot 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 explicitget andset methods (e.g.,Complex64Array andComplex128Array).

Examples

varComplex128Array=require('@stdlib/array-complex128');varComplex64Array=require('@stdlib/array-complex64');varComplex128=require('@stdlib/complex-float64-ctor');varComplex64=require('@stdlib/complex-float32-ctor');varzeroTo=require('@stdlib/array-base-zero-to');vardtype=require('@stdlib/array-dtype');varaccessorSetter=require('@stdlib/array-base-accessor-setter');vararr=newComplex128Array(zeroTo(10));accessorSetter(dtype(arr))(arr,2,newComplex128(100.0,101.0));varv=arr.get(2);// returns <Complex128>console.log('%s',v.toString());// => '100 + 101i'arr=newComplex64Array(zeroTo(10));accessorSetter(dtype(arr))(arr,4,newComplex64(102.0,103.0));v=arr.get(4);// returns <Complex64>console.log('%s',v.toString());// => '102 + 103i'

Notice

This package is part ofstdlib, 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 developstdlib, see the main projectrepository.