Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/array-base-to-accessor-array

Convert an array-like object to a minimal array-like object supporting the accessor protocol.
https://github.com/stdlib-js/array-base-to-accessor-array

accessor accessors array array-like convert data javascript node node-js nodejs object protocol stdlib structure types wrap wrapper

Last synced: 2 months ago
JSON representation

Convert an array-like object to a minimal array-like object supporting the accessor protocol.

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!



# toAccessorArray



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Convert an array-like object to a minimal array-like object supporting the accessor protocol.



## Installation



```bash

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

```



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 toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );

```



#### toAccessorArray( arr )



Converts an array-like object to a minimal array-like object supporting the accessor protocol.



```javascript

var arr1 = [ 1, 2, 3 ];



var arr2 = toAccessorArray( arr1 );

// returns 



var v = arr2.get( 1 );

// returns 2



var bool = ( arr2 === arr1 );

// returns false

```



If the provided array-like object already supports the accessor protocol, the function returns the input array unchanged.



```javascript

var Complex128Array = require( '@stdlib/array-complex128' );



var arr1 = new Complex128Array( 10 );

// returns 



var arr2 = toAccessorArray( arr1 );

// returns 



var bool = ( arr2 === arr1 );

// returns true

```



* * *



## Examples



```javascript

var Complex128Array = require( '@stdlib/array-complex128' );

var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );



// Define a function for printing the contents of an array and which assumes accessor protocol support:

function printArray( name, x ) {

    var i;

    for ( i = 0; i < x.length; i++ ) {

        console.log( '%s[%d] = %s', name, i, x.get( i ).toString() );

    }

}



// Create an array of complex numbers:

var buf = [ 0, 0, 0, 0, 1, 0, 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 0 ];

var cmplx = new Complex128Array( buf );



// Create an array of the real components:

var real = [ 0, 0, 1, 2, 0, 0, 0, 0, 3, 0 ];



// Ensure the arrays support the accessor protocol to allow for uniform iteration:

cmplx = toAccessorArray( cmplx );

real = toAccessorArray( real );



// Print the contents of each array:

printArray( 'complx', cmplx );

printArray( 'real', real );

```



* * *



## 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].



[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-to-accessor-array.svg

[npm-url]: https://npmjs.org/package/@stdlib/array-base-to-accessor-array



[test-image]: https://github.com/stdlib-js/array-base-to-accessor-array/actions/workflows/test.yml/badge.svg?branch=v0.2.2

[test-url]: https://github.com/stdlib-js/array-base-to-accessor-array/actions/workflows/test.yml?query=branch:v0.2.2



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-to-accessor-array/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/array-base-to-accessor-array?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[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-to-accessor-array/tree/deno

[deno-readme]: https://github.com/stdlib-js/array-base-to-accessor-array/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/array-base-to-accessor-array/tree/umd

[umd-readme]: https://github.com/stdlib-js/array-base-to-accessor-array/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/array-base-to-accessor-array/tree/esm

[esm-readme]: https://github.com/stdlib-js/array-base-to-accessor-array/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/array-base-to-accessor-array/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-to-accessor-array/main/LICENSE