@stdlib/array-to-iterator 0.0.5 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+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

package/LICENSE

@@ -175,307 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by this
-license (the "Software") to use, reproduce, display, distribute, execute, and
-transmit the Software, and to prepare derivative works of the Software, and to
-permit third-parties to whom the Software is furnished to do so, all subject to
-the following:
-
-The copyright notices in the Software and this entire statement, including the
-above license grant, this restriction and the following disclaimer, must be
-included in all copies of the Software, in whole or in part, and all derivative
-works of the Software, unless such copies or derivative works are solely in the
-form of machine-executable object code generated by a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
-OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
-OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-
-DEPENDENCIES
-
-The library links against the following external libraries, which have their own
-licenses:
-
-* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
-def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
-
-Copyright (c) 2011-2014, The OpenBLAS Project
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   1. Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
-
-   3. Neither the name of the OpenBLAS project nor the names of
-      its contributors may be used to endorse or promote products
-      derived from this software without specific prior written
-      permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
-THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* Electron <https://raw.githubusercontent.com/electron/electron/
-c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
-
-Copyright (c) 2013-2017 GitHub Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-
-
-* Cephes <http://www.netlib.org/cephes/readme>
-
-Copyright (c) 1984-2000 Stephen L. Moshier
-
-Some software in this archive may be from the book _Methods and Programs for
-Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
-or from the Cephes Mathematical Library, a commercial product. In either event,
-it is copyrighted by the author. What you see here may be used freely but it
-comes with no support or guarantee.
-
-Stephen L. Moshier
-moshier@na-net.ornl.gov
-
-
-
-ATTRIBUTION
-
-The library contains implementations from the following external libraries,
-which have their own licenses:
-
-* FreeBSD <https://svnweb.freebsd.org/>
-
-Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* FDLIBM <http://www.netlib.org/fdlibm/>
-
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
-
-Public domain.
-
-
-* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
-
-Copyright JS Foundation and other contributors, https://js.foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
-* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
-e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
-
-Copyright (c) 2015: Dahua Lin.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
-SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
-
-The MIT License (MIT)
-
-Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
-
-https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
-mt19937ar.c>
-
-Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
- 1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-
- 3. The names of its contributors may not be used to endorse or promote
-    products derived from this software without specific prior written
-    permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,9 +18,20 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>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.</p>
+  <p>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.</p>
+  <p>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.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # array2iterator
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > Create an iterator from an array-like object.
 
@@ -101,9 +112,9 @@ v = it.next().value;
 
 The invoked function is provided three arguments:
 
--   `value`: iterated value
--   `index`: iterated value index
--   `src`: source array-like object
+-   **value**: iterated value.
+-   **index**: iterated value index.
+-   **src**: source array-like object.
 
 ```javascript
 function fcn( v, i ) {
@@ -164,9 +175,10 @@ var count = ctx.count;
 ## Notes
 
 -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
--   If provided a generic `array`, the returned iterator does **not** ignore holes. To achieve greater performance for sparse arrays, use [`@stdlib/array/to-sparse-iterator`][@stdlib/array/to-sparse-iterator].
+-   If provided a generic `array`, the returned iterator does **not** ignore holes. To achieve greater performance for sparse arrays, use [`@stdlib/array-to-sparse-iterator`][@stdlib/array/to-sparse-iterator].
 -   A returned iterator does **not** copy a provided array-like `object`. To ensure iterable reproducibility, copy a provided array-like `object` **before** creating an iterator. Otherwise, any changes to the contents of an array-like `object` will be reflected in the returned iterator.
 -   In environments supporting `Symbol.iterator`, the function **explicitly** does **not** invoke an array's `@@iterator` method, regardless of whether this method is defined. To convert an array to an implementation defined iterator, invoke this method directly.
+-   The returned iterator supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array-complex64`][@stdlib/array/complex64]).
 
 </section>
 
@@ -219,6 +231,23 @@ while ( true ) {
 
 <!-- /.references -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array-from-iterator`][@stdlib/array/from-iterator]</span><span class="delimiter">: </span><span class="description">create (or fill) an array from an iterator.</span>
+-   <span class="package-name">[`@stdlib/array-to-circular-iterator`][@stdlib/array/to-circular-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator which repeatedly iterates over the elements of an array-like object.</span>
+-   <span class="package-name">[`@stdlib/array-to-iterator-right`][@stdlib/array/to-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object, iterating from right to left.</span>
+-   <span class="package-name">[`@stdlib/array-to-strided-iterator`][@stdlib/array/to-strided-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from a strided array-like object.</span>
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 
@@ -245,7 +274,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -258,26 +287,52 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/array-to-iterator.svg
 [npm-url]: https://npmjs.org/package/@stdlib/array-to-iterator
 
-[test-image]: https://github.com/stdlib-js/array-to-iterator/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/array-to-iterator/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/array-to-iterator/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/array-to-iterator/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-to-iterator/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/array-to-iterator?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/array-to-iterator.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/array-to-iterator/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[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-to-iterator/tree/deno
+[umd-url]: https://github.com/stdlib-js/array-to-iterator/tree/umd
+[esm-url]: https://github.com/stdlib-js/array-to-iterator/tree/esm
+[branches-url]: https://github.com/stdlib-js/array-to-iterator/blob/main/branches.md
+
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-to-iterator/main/LICENSE
 
 [@stdlib/array/to-sparse-iterator]: https://www.npmjs.com/package/@stdlib/array-to-sparse-iterator
 
+[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64
+
+<!-- <related-links> -->
+
+[@stdlib/array/from-iterator]: https://www.npmjs.com/package/@stdlib/array-from-iterator
+
+[@stdlib/array/to-circular-iterator]: https://www.npmjs.com/package/@stdlib/array-to-circular-iterator
+
+[@stdlib/array/to-iterator-right]: https://www.npmjs.com/package/@stdlib/array-to-iterator-right
+
+[@stdlib/array/to-strided-iterator]: https://www.npmjs.com/package/@stdlib/array-to-strided-iterator
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import array2iterator from '../docs/types/index';
+export = array2iterator;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var x=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var d=x(function(T,g){
+var i=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),p=require('@stdlib/assert-is-function/dist'),b=require('@stdlib/assert-is-collection/dist'),w=require('@stdlib/array-base-assert-is-accessor-array/dist'),f=require('@stdlib/symbol-iterator/dist'),A=require('@stdlib/array-base-accessor-getter/dist'),F=require('@stdlib/array-base-getter/dist'),E=require('@stdlib/array-dtype/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist');function v(e){var r,a,o,n,u,l,t;if(!b(e))throw new TypeError(s('01Z2O',e));if(arguments.length>1){if(n=arguments[1],!p(n))throw new TypeError(s('01Z2H',n));r=arguments[2]}return t=-1,a={},n?i(a,"next",m):i(a,"next",q),i(a,"return",c),f&&i(a,f,y),l=E(e),w(e)?u=A(l):u=F(l),a;function m(){return t+=1,o||t>=e.length?{done:!0}:{value:n.call(r,u(e,t),t,e),done:!1}}function q(){return t+=1,o||t>=e.length?{done:!0}:{value:u(e,t),done:!1}}function c(h){return o=!0,arguments.length?{value:h,done:!0}:{done:!0}}function y(){return n?v(e,n,r):v(e)}}g.exports=v
+});var G=d();module.exports=G;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' );\nvar iteratorSymbol = require( '@stdlib/symbol-iterator' );\nvar accessorGetter = require( '@stdlib/array-base-accessor-getter' );\nvar getter = require( '@stdlib/array-base-getter' );\nvar dtype = require( '@stdlib/array-dtype' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Returns an iterator which iterates over each element in an array-like object.\n*\n* @param {Collection} src - input value\n* @param {Function} [mapFcn] - function to invoke for each iterated value\n* @param {*} [thisArg] - execution context\n* @throws {TypeError} first argument must be an array-like object\n* @throws {TypeError} second argument must be a function\n* @returns {Iterator} iterator\n*\n* @example\n* var iter = array2iterator( [ 1, 2, 3, 4 ] );\n*\n* var v = iter.next().value;\n* // returns 1\n*\n* v = iter.next().value;\n* // returns 2\n*\n* v = iter.next().value;\n* // returns 3\n*\n* // ...\n*/\nfunction array2iterator( src ) {\n\tvar thisArg;\n\tvar iter;\n\tvar FLG;\n\tvar fcn;\n\tvar get;\n\tvar dt;\n\tvar i;\n\tif ( !isCollection( src ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', src ) );\n\t}\n\tif ( arguments.length > 1 ) {\n\t\tfcn = arguments[ 1 ];\n\t\tif ( !isFunction( fcn ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', fcn ) );\n\t\t}\n\t\tthisArg = arguments[ 2 ];\n\t}\n\ti = -1;\n\n\t// Create an iterator protocol-compliant object:\n\titer = {};\n\tif ( fcn ) {\n\t\tsetReadOnly( iter, 'next', next1 );\n\t} else {\n\t\tsetReadOnly( iter, 'next', next2 );\n\t}\n\tsetReadOnly( iter, 'return', end );\n\n\t// If an environment supports `Symbol.iterator`, make the iterator iterable:\n\tif ( iteratorSymbol ) {\n\t\tsetReadOnly( iter, iteratorSymbol, factory );\n\t}\n\t// Resolve an accessor for retrieving array elements (e.g., to accommodate `Complex64Array`, etc):\n\tdt = dtype( src );\n\tif ( isAccessorArray( src ) ) {\n\t\tget = accessorGetter( dt );\n\t} else {\n\t\tget = getter( dt );\n\t}\n\treturn iter;\n\n\t/**\n\t* Returns an iterator protocol-compliant object containing the next iterated value.\n\t*\n\t* @private\n\t* @returns {Object} iterator protocol-compliant object\n\t*/\n\tfunction next1() {\n\t\ti += 1;\n\t\tif ( FLG || i >= src.length ) {\n\t\t\treturn {\n\t\t\t\t'done': true\n\t\t\t};\n\t\t}\n\t\treturn {\n\t\t\t'value': fcn.call( thisArg, get( src, i ), i, src ),\n\t\t\t'done': false\n\t\t};\n\t}\n\n\t/**\n\t* Returns an iterator protocol-compliant object containing the next iterated value.\n\t*\n\t* @private\n\t* @returns {Object} iterator protocol-compliant object\n\t*/\n\tfunction next2() {\n\t\ti += 1;\n\t\tif ( FLG || i >= src.length ) {\n\t\t\treturn {\n\t\t\t\t'done': true\n\t\t\t};\n\t\t}\n\t\treturn {\n\t\t\t'value': get( src, i ),\n\t\t\t'done': false\n\t\t};\n\t}\n\n\t/**\n\t* Finishes an iterator.\n\t*\n\t* @private\n\t* @param {*} [value] - value to return\n\t* @returns {Object} iterator protocol-compliant object\n\t*/\n\tfunction end( value ) {\n\t\tFLG = true;\n\t\tif ( arguments.length ) {\n\t\t\treturn {\n\t\t\t\t'value': value,\n\t\t\t\t'done': true\n\t\t\t};\n\t\t}\n\t\treturn {\n\t\t\t'done': true\n\t\t};\n\t}\n\n\t/**\n\t* Returns a new iterator.\n\t*\n\t* @private\n\t* @returns {Iterator} iterator\n\t*/\n\tfunction factory() {\n\t\tif ( fcn ) {\n\t\t\treturn array2iterator( src, fcn, thisArg );\n\t\t}\n\t\treturn array2iterator( src );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = array2iterator;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Create an iterator from an array-like object.\n*\n* @module @stdlib/array-to-iterator\n*\n* @example\n* var array2iterator = require( '@stdlib/array-to-iterator' );\n*\n* var iter = array2iterator( [ 1, 2, 3, 4 ] );\n*\n* var v = iter.next().value;\n* // returns 1\n*\n* v = iter.next().value;\n* // returns 2\n*\n* v = iter.next().value;\n* // returns 3\n*\n* // ...\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAa,QAAS,4BAA6B,EACnDC,EAAe,QAAS,8BAA+B,EACvDC,EAAkB,QAAS,6CAA8C,EACzEC,EAAiB,QAAS,yBAA0B,EACpDC,EAAiB,QAAS,oCAAqC,EAC/DC,EAAS,QAAS,2BAA4B,EAC9CC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EA6B9C,SAASC,EAAgBC,EAAM,CAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACJ,GAAK,CAACf,EAAcQ,CAAI,EACvB,MAAM,IAAI,UAAWF,EAAQ,8EAA+EE,CAAI,CAAE,EAEnH,GAAK,UAAU,OAAS,EAAI,CAE3B,GADAI,EAAM,UAAW,CAAE,EACd,CAACb,EAAYa,CAAI,EACrB,MAAM,IAAI,UAAWN,EAAQ,qEAAsEM,CAAI,CAAE,EAE1GH,EAAU,UAAW,CAAE,CACxB,CACA,OAAAM,EAAI,GAGJL,EAAO,CAAC,EACHE,EACJd,EAAaY,EAAM,OAAQM,CAAM,EAEjClB,EAAaY,EAAM,OAAQO,CAAM,EAElCnB,EAAaY,EAAM,SAAUQ,CAAI,EAG5BhB,GACJJ,EAAaY,EAAMR,EAAgBiB,CAAQ,EAG5CL,EAAKT,EAAOG,CAAI,EACXP,EAAiBO,CAAI,EACzBK,EAAMV,EAAgBW,CAAG,EAEzBD,EAAMT,EAAQU,CAAG,EAEXJ,EAQP,SAASM,GAAQ,CAEhB,OADAD,GAAK,EACAJ,GAAOI,GAAKP,EAAI,OACb,CACN,KAAQ,EACT,EAEM,CACN,MAASI,EAAI,KAAMH,EAASI,EAAKL,EAAKO,CAAE,EAAGA,EAAGP,CAAI,EAClD,KAAQ,EACT,CACD,CAQA,SAASS,GAAQ,CAEhB,OADAF,GAAK,EACAJ,GAAOI,GAAKP,EAAI,OACb,CACN,KAAQ,EACT,EAEM,CACN,MAASK,EAAKL,EAAKO,CAAE,EACrB,KAAQ,EACT,CACD,CASA,SAASG,EAAKE,EAAQ,CAErB,OADAT,EAAM,GACD,UAAU,OACP,CACN,MAASS,EACT,KAAQ,EACT,EAEM,CACN,KAAQ,EACT,CACD,CAQA,SAASD,GAAU,CAClB,OAAKP,EACGL,EAAgBC,EAAKI,EAAKH,CAAQ,EAEnCF,EAAgBC,CAAI,CAC5B,CACD,CAKAX,EAAO,QAAUU,ICpIjB,IAAIc,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isFunction", "isCollection", "isAccessorArray", "iteratorSymbol", "accessorGetter", "getter", "dtype", "format", "array2iterator", "src", "thisArg", "iter", "FLG", "fcn", "get", "dt", "i", "next1", "next2", "end", "factory", "value", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
@@ -58,7 +58,7 @@ type Binary = ( value: any, index: number ) => any;
 * @param src - source array-like object
 * @returns iterator value
 */
-type Tertiary = ( value: any, index: number, src: ArrayLike<any> ) => any;
+type Ternary = ( value: any, index: number, src: ArrayLike<any> ) => any;
 
 /**
 * Map function invoked for each iterated value.
@@ -68,7 +68,7 @@ type Tertiary = ( value: any, index: number, src: ArrayLike<any> ) => any;
 * @param src - source array-like object
 * @returns iterator value
 */
-type MapFunction = Nullary | Unary | Binary | Tertiary;
+type MapFunction = Nullary | Unary | Binary | Ternary;
 
 /**
 * Returns an iterator which iterates over each element in an array-like object.

package/lib/index.js

@@ -42,9 +42,9 @@
 
 // MODULES //
 
-var iterator = require( './main.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = iterator;
+module.exports = main;

package/lib/main.js

@@ -23,7 +23,12 @@
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
 var isFunction = require( '@stdlib/assert-is-function' );
 var isCollection = require( '@stdlib/assert-is-collection' );
+var isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' );
 var iteratorSymbol = require( '@stdlib/symbol-iterator' );
+var accessorGetter = require( '@stdlib/array-base-accessor-getter' );
+var getter = require( '@stdlib/array-base-getter' );
+var dtype = require( '@stdlib/array-dtype' );
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -57,14 +62,16 @@ function array2iterator( src ) {
 	var iter;
 	var FLG;
 	var fcn;
+	var get;
+	var dt;
 	var i;
 	if ( !isCollection( src ) ) {
-		throw new TypeError( 'invalid argument. First argument must be an array-like object. Value: `' + src + '`.' );
+		throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', src ) );
 	}
 	if ( arguments.length > 1 ) {
 		fcn = arguments[ 1 ];
 		if ( !isFunction( fcn ) ) {
-			throw new TypeError( 'invalid argument. Second argument must be a function. Value: `' + fcn + '`.' );
+			throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', fcn ) );
 		}
 		thisArg = arguments[ 2 ];
 	}
@@ -83,6 +90,13 @@ function array2iterator( src ) {
 	if ( iteratorSymbol ) {
 		setReadOnly( iter, iteratorSymbol, factory );
 	}
+	// Resolve an accessor for retrieving array elements (e.g., to accommodate `Complex64Array`, etc):
+	dt = dtype( src );
+	if ( isAccessorArray( src ) ) {
+		get = accessorGetter( dt );
+	} else {
+		get = getter( dt );
+	}
 	return iter;
 
 	/**
@@ -99,7 +113,7 @@ function array2iterator( src ) {
 			};
 		}
 		return {
-			'value': fcn.call( thisArg, src[ i ], i, src ),
+			'value': fcn.call( thisArg, get( src, i ), i, src ),
 			'done': false
 		};
 	}
@@ -118,7 +132,7 @@ function array2iterator( src ) {
 			};
 		}
 		return {
-			'value': src[ i ],
+			'value': get( src, i ),
 			'done': false
 		};
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/array-to-iterator",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Create an iterator from an array-like object.",
   "license": "Apache-2.0",
   "author": {
@@ -37,24 +37,34 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-collection": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/symbol-iterator": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/array-base-accessor-getter": "^0.1.0",
+    "@stdlib/array-base-assert-is-accessor-array": "^0.1.0",
+    "@stdlib/array-base-getter": "^0.1.0",
+    "@stdlib/array-dtype": "^0.1.0",
+    "@stdlib/assert-is-collection": "^0.1.0",
+    "@stdlib/assert-is-function": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/symbol-iterator": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/assert-is-iterator-like": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
-    "@stdlib/utils-inmap": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x",
+    "@stdlib/array-complex64": "^0.1.0",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/assert-is-iterator-like": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/complex-float32": "^0.1.0",
+    "@stdlib/complex-imagf": "^0.1.0",
+    "@stdlib/complex-realf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
+    "@stdlib/utils-inmap": "^0.1.0",
+    "@stdlib/utils-noop": "^0.1.0",
     "proxyquire": "^2.0.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -91,7 +101,7 @@
     "convert"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,54 +0,0 @@
-
-{{alias}}( src[, mapFcn[, thisArg]] )
-    Returns an iterator which iterates over the elements of an array-like
-    object.
-
-    When invoked, an input function is provided three arguments:
-
-    - value: iterated value
-    - index: iterated value index
-    - src: source array-like object
-
-    If an environment supports Symbol.iterator, the returned iterator is
-    iterable.
-
-    If an environment supports Symbol.iterator, the function explicitly does not
-    not invoke an array's `@@iterator` method, regardless of whether this method
-    is defined. To convert an array to an implementation defined iterator,
-    invoke this method directly.
-
-    Parameters
-    ----------
-    src: ArrayLikeObject
-        Array-like object from which to create the iterator.
-
-    mapFcn: Function (optional)
-        Function to invoke for each iterated value.
-
-    thisArg: any (optional)
-        Execution context.
-
-    Returns
-    -------
-    iterator: Object
-        Iterator.
-
-    iterator.next(): Function
-        Returns an iterator protocol-compliant object containing the next
-        iterated value (if one exists) and a boolean flag indicating whether the
-        iterator is finished.
-
-    iterator.return( [value] ): Function
-        Finishes an iterator and returns a provided value.
-
-    Examples
-    --------
-    > var it = {{alias}}( [ 1, 2, 3, 4 ] );
-    > var v = it.next().value
-    1
-    > v = it.next().value
-    2
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,66 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2020 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import array2iterator = require( './index' );
-
-/**
-* Multiplies a value by 10.
-*
-* @param v - iterated value
-* @returns new value
-*/
-function times10( v: number ): number {
-	return v * 10.0;
-}
-
-
-// TESTS //
-
-// The function returns an iterator...
-{
-	array2iterator( [ 1, 2, 3, 4 ] ); // $ExpectType Iterator
-	array2iterator( [ 1, 2, 3, 4 ], times10 ); // $ExpectType Iterator
-	array2iterator( [ 1, 2, 3, 4 ], times10, {} ); // $ExpectType Iterator
-}
-
-// The compiler throws an error if the function is provided a first argument which is not array-like...
-{
-	array2iterator( 123 );  // $ExpectError
-	array2iterator( true ); // $ExpectError
-	array2iterator( false ); // $ExpectError
-	array2iterator( {} ); // $ExpectError
-	array2iterator( null ); // $ExpectError
-	array2iterator( undefined ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a map function...
-{
-	array2iterator( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], 123 ); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], [] ); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], {} ); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], true ); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], false ); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], null ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	array2iterator(); // $ExpectError
-	array2iterator( [ 1, 2, 3, 4 ], times10, {}, 123 ); // $ExpectError
-}