@stdlib/array-to-circular-iterator 0.0.6 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -175,307 +175,3 @@
175
175
  of your accepting any such warranty or additional liability.
176
176
 
177
177
  END OF TERMS AND CONDITIONS
178
-
179
-
180
-
181
- Boost Software License - Version 1.0 - August 17th, 2003
182
-
183
- Permission is hereby granted, free of charge, to any person or organization
184
- obtaining a copy of the software and accompanying documentation covered by this
185
- license (the "Software") to use, reproduce, display, distribute, execute, and
186
- transmit the Software, and to prepare derivative works of the Software, and to
187
- permit third-parties to whom the Software is furnished to do so, all subject to
188
- the following:
189
-
190
- The copyright notices in the Software and this entire statement, including the
191
- above license grant, this restriction and the following disclaimer, must be
192
- included in all copies of the Software, in whole or in part, and all derivative
193
- works of the Software, unless such copies or derivative works are solely in the
194
- form of machine-executable object code generated by a source language processor.
195
-
196
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
197
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
198
- FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
199
- COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
200
- OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
201
- OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
202
-
203
-
204
-
205
-
206
- DEPENDENCIES
207
-
208
- The library links against the following external libraries, which have their own
209
- licenses:
210
-
211
- * OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
212
- def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
213
-
214
- Copyright (c) 2011-2014, The OpenBLAS Project
215
- All rights reserved.
216
-
217
- Redistribution and use in source and binary forms, with or without
218
- modification, are permitted provided that the following conditions are
219
- met:
220
-
221
- 1. Redistributions of source code must retain the above copyright
222
- notice, this list of conditions and the following disclaimer.
223
-
224
- 2. Redistributions in binary form must reproduce the above copyright
225
- notice, this list of conditions and the following disclaimer in
226
- the documentation and/or other materials provided with the
227
- distribution.
228
-
229
- 3. Neither the name of the OpenBLAS project nor the names of
230
- its contributors may be used to endorse or promote products
231
- derived from this software without specific prior written
232
- permission.
233
-
234
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
235
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
236
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
237
- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
238
- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
239
- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
240
- GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
241
- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
242
- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
243
- THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
244
-
245
-
246
- * Electron <https://raw.githubusercontent.com/electron/electron/
247
- c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
248
-
249
- Copyright (c) 2013-2017 GitHub Inc.
250
-
251
- Permission is hereby granted, free of charge, to any person obtaining
252
- a copy of this software and associated documentation files (the
253
- "Software"), to deal in the Software without restriction, including
254
- without limitation the rights to use, copy, modify, merge, publish,
255
- distribute, sublicense, and/or sell copies of the Software, and to
256
- permit persons to whom the Software is furnished to do so, subject to
257
- the following conditions:
258
-
259
- The above copyright notice and this permission notice shall be
260
- included in all copies or substantial portions of the Software.
261
-
262
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
263
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
264
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
265
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
266
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
267
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
268
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
269
-
270
-
271
- * Boost <http://www.boost.org/LICENSE_1_0.txt>
272
-
273
- Boost Software License - Version 1.0 - August 17th, 2003
274
-
275
- Permission is hereby granted, free of charge, to any person or organization
276
- obtaining a copy of the software and accompanying documentation covered by
277
- this license (the "Software") to use, reproduce, display, distribute,
278
- execute, and transmit the Software, and to prepare derivative works of the
279
- Software, and to permit third-parties to whom the Software is furnished to
280
- do so, all subject to the following:
281
-
282
- The copyright notices in the Software and this entire statement, including
283
- the above license grant, this restriction and the following disclaimer,
284
- must be included in all copies of the Software, in whole or in part, and
285
- all derivative works of the Software, unless such copies or derivative
286
- works are solely in the form of machine-executable object code generated by
287
- a source language processor.
288
-
289
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
290
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
291
- FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
292
- SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
293
- FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
294
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
295
- DEALINGS IN THE SOFTWARE.
296
-
297
-
298
- * Cephes <http://www.netlib.org/cephes/readme>
299
-
300
- Copyright (c) 1984-2000 Stephen L. Moshier
301
-
302
- Some software in this archive may be from the book _Methods and Programs for
303
- Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
304
- or from the Cephes Mathematical Library, a commercial product. In either event,
305
- it is copyrighted by the author. What you see here may be used freely but it
306
- comes with no support or guarantee.
307
-
308
- Stephen L. Moshier
309
- moshier@na-net.ornl.gov
310
-
311
-
312
-
313
- ATTRIBUTION
314
-
315
- The library contains implementations from the following external libraries,
316
- which have their own licenses:
317
-
318
- * FreeBSD <https://svnweb.freebsd.org/>
319
-
320
- Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
321
-
322
- Developed at SunPro, a Sun Microsystems, Inc. business.
323
- Permission to use, copy, modify, and distribute this
324
- software is freely granted, provided that this notice
325
- is preserved.
326
-
327
-
328
- * FDLIBM <http://www.netlib.org/fdlibm/>
329
-
330
- Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
331
-
332
- Developed at SunPro, a Sun Microsystems, Inc. business.
333
- Permission to use, copy, modify, and distribute this
334
- software is freely granted, provided that this notice
335
- is preserved.
336
-
337
-
338
- * Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
339
-
340
- Copyright (c) 2009 The Go Authors. All rights reserved.
341
-
342
- Redistribution and use in source and binary forms, with or without
343
- modification, are permitted provided that the following conditions are
344
- met:
345
-
346
- * Redistributions of source code must retain the above copyright
347
- notice, this list of conditions and the following disclaimer.
348
- * Redistributions in binary form must reproduce the above
349
- copyright notice, this list of conditions and the following disclaimer
350
- in the documentation and/or other materials provided with the
351
- distribution.
352
- * Neither the name of Google Inc. nor the names of its
353
- contributors may be used to endorse or promote products derived from
354
- this software without specific prior written permission.
355
-
356
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
357
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
358
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
359
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
360
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
361
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
362
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
363
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
364
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
365
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
366
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
367
-
368
-
369
- * SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
370
-
371
- Public domain.
372
-
373
-
374
- * ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
375
-
376
- Copyright JS Foundation and other contributors, https://js.foundation
377
-
378
- Permission is hereby granted, free of charge, to any person obtaining a copy
379
- of this software and associated documentation files (the "Software"), to deal
380
- in the Software without restriction, including without limitation the rights
381
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
382
- copies of the Software, and to permit persons to whom the Software is
383
- furnished to do so, subject to the following conditions:
384
-
385
- The above copyright notice and this permission notice shall be included in
386
- all copies or substantial portions of the Software.
387
-
388
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
389
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
390
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
391
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
392
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
393
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
394
- THE SOFTWARE.
395
-
396
-
397
- * StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
398
- e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
399
-
400
- Copyright (c) 2015: Dahua Lin.
401
-
402
- Permission is hereby granted, free of charge, to any person obtaining
403
- a copy of this software and associated documentation files (the
404
- "Software"), to deal in the Software without restriction, including
405
- without limitation the rights to use, copy, modify, merge, publish,
406
- distribute, sublicense, and/or sell copies of the Software, and to
407
- permit persons to whom the Software is furnished to do so, subject to
408
- the following conditions:
409
-
410
- The above copyright notice and this permission notice shall be
411
- included in all copies or substantial portions of the Software.
412
-
413
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
414
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
415
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
416
- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
417
- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
418
- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
419
- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
420
-
421
-
422
- * SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
423
- SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
424
-
425
- The MIT License (MIT)
426
-
427
- Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
428
-
429
- https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
430
-
431
- Permission is hereby granted, free of charge, to any person obtaining a copy
432
- of this software and associated documentation files (the "Software"), to deal
433
- in the Software without restriction, including without limitation the rights
434
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
435
- copies of the Software, and to permit persons to whom the Software is
436
- furnished to do so, subject to the following conditions:
437
-
438
- The above copyright notice and this permission notice shall be included in all
439
- copies or substantial portions of the Software.
440
-
441
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
442
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
443
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
444
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
445
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
446
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
447
- SOFTWARE.
448
-
449
-
450
- * MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
451
- mt19937ar.c>
452
-
453
- Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
454
- All rights reserved.
455
-
456
- Redistribution and use in source and binary forms, with or without
457
- modification, are permitted provided that the following conditions
458
- are met:
459
-
460
- 1. Redistributions of source code must retain the above copyright
461
- notice, this list of conditions and the following disclaimer.
462
-
463
- 2. Redistributions in binary form must reproduce the above copyright
464
- notice, this list of conditions and the following disclaimer in the
465
- documentation and/or other materials provided with the distribution.
466
-
467
- 3. The names of its contributors may not be used to endorse or promote
468
- products derived from this software without specific prior written
469
- permission.
470
-
471
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
472
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
473
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
474
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
475
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
476
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
477
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
478
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
479
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
480
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
481
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
1
+ Copyright (c) 2016-2024 The Stdlib Authors.
package/README.md CHANGED
@@ -18,6 +18,17 @@ limitations under the License.
18
18
 
19
19
  -->
20
20
 
21
+
22
+ <details>
23
+ <summary>
24
+ About stdlib...
25
+ </summary>
26
+ <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>
27
+ <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>
28
+ <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>
29
+ <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>
30
+ </details>
31
+
21
32
  # circarray2iterator
22
33
 
23
34
  [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -246,7 +257,7 @@ var count = ctx.count;
246
257
  - If provided a generic `array`, the returned iterator does **not** ignore holes. To achieve greater performance for sparse arrays, use a custom iterator.
247
258
  - 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.
248
259
  - 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.
249
- - The returned iterator supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/complex64`][@stdlib/array/complex64]).
260
+ - The returned iterator supports array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array-complex64`][@stdlib/array/complex64]).
250
261
 
251
262
  </section>
252
263
 
@@ -310,8 +321,8 @@ while ( true ) {
310
321
 
311
322
  ## See Also
312
323
 
313
- - <span class="package-name">[`@stdlib/array/to-iterator`][@stdlib/array/to-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object.</span>
314
- - <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>
324
+ - <span class="package-name">[`@stdlib/array-to-iterator`][@stdlib/array/to-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object.</span>
325
+ - <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>
315
326
 
316
327
  </section>
317
328
 
@@ -343,7 +354,7 @@ See [LICENSE][stdlib-license].
343
354
 
344
355
  ## Copyright
345
356
 
346
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
357
+ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
347
358
 
348
359
  </section>
349
360
 
@@ -356,8 +367,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
356
367
  [npm-image]: http://img.shields.io/npm/v/@stdlib/array-to-circular-iterator.svg
357
368
  [npm-url]: https://npmjs.org/package/@stdlib/array-to-circular-iterator
358
369
 
359
- [test-image]: https://github.com/stdlib-js/array-to-circular-iterator/actions/workflows/test.yml/badge.svg
360
- [test-url]: https://github.com/stdlib-js/array-to-circular-iterator/actions/workflows/test.yml
370
+ [test-image]: https://github.com/stdlib-js/array-to-circular-iterator/actions/workflows/test.yml/badge.svg?branch=v0.2.0
371
+ [test-url]: https://github.com/stdlib-js/array-to-circular-iterator/actions/workflows/test.yml?query=branch:v0.2.0
361
372
 
362
373
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-to-circular-iterator/main.svg
363
374
  [coverage-url]: https://codecov.io/github/stdlib-js/array-to-circular-iterator?branch=main
@@ -369,19 +380,23 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
369
380
 
370
381
  -->
371
382
 
383
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
384
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
385
+
386
+ [stdlib]: https://github.com/stdlib-js/stdlib
387
+
388
+ [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
389
+
372
390
  [umd]: https://github.com/umdjs/umd
373
391
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
374
392
 
375
393
  [deno-url]: https://github.com/stdlib-js/array-to-circular-iterator/tree/deno
394
+ [deno-readme]: https://github.com/stdlib-js/array-to-circular-iterator/blob/deno/README.md
376
395
  [umd-url]: https://github.com/stdlib-js/array-to-circular-iterator/tree/umd
396
+ [umd-readme]: https://github.com/stdlib-js/array-to-circular-iterator/blob/umd/README.md
377
397
  [esm-url]: https://github.com/stdlib-js/array-to-circular-iterator/tree/esm
378
-
379
- [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
380
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
381
-
382
- [stdlib]: https://github.com/stdlib-js/stdlib
383
-
384
- [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
398
+ [esm-readme]: https://github.com/stdlib-js/array-to-circular-iterator/blob/esm/README.md
399
+ [branches-url]: https://github.com/stdlib-js/array-to-circular-iterator/blob/main/branches.md
385
400
 
386
401
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-to-circular-iterator/main/LICENSE
387
402
 
package/SECURITY.md ADDED
@@ -0,0 +1,5 @@
1
+ # Security
2
+
3
+ > Policy for reporting security vulnerabilities.
4
+
5
+ See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import circarray2iterator from '../docs/types/index';
3
+ export = circarray2iterator;
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ "use strict";var j=function(e,a){return function(){return a||e((a={exports:{}}).exports,a),a.exports}};var b=j(function(I,q){
2
+ var f=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),m=require('@stdlib/assert-has-own-property/dist'),h=require('@stdlib/assert-is-function/dist'),A=require('@stdlib/assert-is-collection/dist'),F=require('@stdlib/assert-is-plain-object/dist'),V=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,k=require('@stdlib/array-base-assert-is-accessor-array/dist'),p=require('@stdlib/symbol-iterator/dist'),C=require('@stdlib/array-base-accessor-getter/dist'),G=require('@stdlib/array-base-getter/dist'),N=require('@stdlib/array-dtype/dist'),g=require('@stdlib/error-tools-fmtprodmsg/dist');function d(e){var a,u,t,n,o,v,i,l,s,r;if(!A(e))throw new TypeError(g('01V2O',e));if(n={iter:1e308,dir:1},arguments.length>1)if(F(arguments[1])){if(u=arguments[1],arguments.length>2){if(i=arguments[2],!h(i))throw new TypeError(g('01V2b',i));a=arguments[3]}if(m(u,"iter")&&(n.iter=u.iter,!V(u.iter)))throw new TypeError(g('01V2t',"iter",u.iter));if(m(u,"dir")&&(n.dir=u.dir,u.dir!==1&&u.dir!==-1))throw new TypeError(g('01V2v',"dir",u.dir))}else{if(i=arguments[1],!h(i))throw new TypeError(g('01V2w',i));a=arguments[2]}return t=0,o={},i?n.dir===1?(r=-1,f(o,"next",y)):(r=e.length,f(o,"next",w)):n.dir===1?(r=-1,f(o,"next",x)):(r=e.length,f(o,"next",c)),f(o,"return",E),p&&f(o,p,O),s=N(e),k(e)?l=C(s):l=G(s),o;function y(){return r=(r+1)%e.length,t+=1,v||t>n.iter||e.length===0?{done:!0}:{value:i.call(a,l(e,r),r,t,e),done:!1}}function w(){return r-=1,r<0&&(r+=e.length),t+=1,v||t>n.iter||e.length===0?{done:!0}:{value:i.call(a,l(e,r),r,t,e),done:!1}}function x(){return r=(r+1)%e.length,t+=1,v||t>n.iter||e.length===0?{done:!0}:{value:l(e,r),done:!1}}function c(){return r-=1,r<0&&(r+=e.length),t+=1,v||t>n.iter||e.length===0?{done:!0}:{value:l(e,r),done:!1}}function E(T){return v=!0,arguments.length?{value:T,done:!0}:{done:!0}}function O(){return i?d(e,n,i,a):d(e,n)}}q.exports=d
3
+ });var P=b();module.exports=P;
4
+ /** @license Apache-2.0 */
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../lib/main.js", "../lib/index.js"],
4
+ "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 hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\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 repeatedly iterates over each element in an array-like object.\n*\n* @param {Collection} src - input value\n* @param {Options} [options] - function options\n* @param {NonNegativeInteger} [options.iter] - number of iterations\n* @param {integer} [options.dir=1] - iteration direction\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} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {TypeError} callback argument must be a function\n* @returns {Iterator} iterator\n*\n* @example\n* var iter = circarray2iterator( [ 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 circarray2iterator( src ) {\n\tvar thisArg;\n\tvar options;\n\tvar count;\n\tvar opts;\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\topts = {\n\t\t'iter': 1e308, // ~infinity\n\t\t'dir': 1 // left to right iteration\n\t};\n\tif ( arguments.length > 1 ) {\n\t\tif ( isObject( arguments[ 1 ] ) ) {\n\t\t\toptions = arguments[ 1 ];\n\t\t\tif ( arguments.length > 2 ) {\n\t\t\t\tfcn = arguments[ 2 ];\n\t\t\t\tif ( !isFunction( fcn ) ) {\n\t\t\t\t\tthrow new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', fcn ) );\n\t\t\t\t}\n\t\t\t\tthisArg = arguments[ 3 ];\n\t\t\t}\n\t\t\tif ( hasOwnProp( options, 'iter' ) ) {\n\t\t\t\topts.iter = options.iter;\n\t\t\t\tif ( !isNonNegativeInteger( options.iter ) ) {\n\t\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', options.iter ) );\n\t\t\t\t}\n\t\t\t}\n\t\t\tif ( hasOwnProp( options, 'dir' ) ) {\n\t\t\t\topts.dir = options.dir;\n\t\t\t\tif ( options.dir !== 1 && options.dir !== -1 ) {\n\t\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be either `1` or `-1`. Option: `%s`.', 'dir', options.dir ) );\n\t\t\t\t}\n\t\t\t}\n\t\t} else {\n\t\t\tfcn = arguments[ 1 ];\n\t\t\tif ( !isFunction( fcn ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be either a function or an options object. Value: `%s`.', fcn ) );\n\t\t\t}\n\t\t\tthisArg = arguments[ 2 ];\n\t\t}\n\t}\n\tcount = 0;\n\n\t// Create an iterator protocol-compliant object:\n\titer = {};\n\tif ( fcn ) {\n\t\tif ( opts.dir === 1 ) {\n\t\t\ti = -1;\n\t\t\tsetReadOnly( iter, 'next', next1a );\n\t\t} else {\n\t\t\ti = src.length;\n\t\t\tsetReadOnly( iter, 'next', next1b );\n\t\t}\n\t} else if ( opts.dir === 1 ) {\n\t\ti = -1;\n\t\tsetReadOnly( iter, 'next', next2a );\n\t} else {\n\t\ti = src.length;\n\t\tsetReadOnly( iter, 'next', next2b );\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 next1a() {\n\t\ti = (i+1) % src.length;\n\t\tcount += 1;\n\t\tif ( FLG || count > opts.iter || src.length === 0 ) {\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, count, 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 next1b() {\n\t\ti -= 1;\n\t\tif ( i < 0 ) {\n\t\t\ti += src.length;\n\t\t}\n\t\tcount += 1;\n\t\tif ( FLG || count > opts.iter || src.length === 0 ) {\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, count, 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 next2a() {\n\t\ti = (i+1) % src.length;\n\t\tcount += 1;\n\t\tif ( FLG || count > opts.iter || src.length === 0 ) {\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* 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 next2b() {\n\t\ti -= 1;\n\t\tif ( i < 0 ) {\n\t\t\ti += src.length;\n\t\t}\n\t\tcount += 1;\n\t\tif ( FLG || count > opts.iter || src.length === 0 ) {\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 circarray2iterator( src, opts, fcn, thisArg );\n\t\t}\n\t\treturn circarray2iterator( src, opts );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = circarray2iterator;\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 which repeatedly iterates over the elements of an array-like object.\n*\n* @module @stdlib/array-to-circular-iterator\n*\n* @example\n* var circarray2iterator = require( '@stdlib/array-to-circular-iterator' );\n*\n* var iter = circarray2iterator( [ 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"],
5
+ "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAa,QAAS,iCAAkC,EACxDC,EAAa,QAAS,4BAA6B,EACnDC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,gCAAiC,EACrDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAkB,QAAS,6CAA8C,EACzEC,EAAiB,QAAS,yBAA0B,EACpDC,EAAiB,QAAS,oCAAqC,EAC/DC,EAAS,QAAS,2BAA4B,EAC9CC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAkC9C,SAASC,EAAoBC,EAAM,CAClC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACJ,GAAK,CAACpB,EAAcU,CAAI,EACvB,MAAM,IAAI,UAAWF,EAAQ,8EAA+EE,CAAI,CAAE,EAMnH,GAJAI,EAAO,CACN,KAAQ,MACR,IAAO,CACR,EACK,UAAU,OAAS,EACvB,GAAKb,EAAU,UAAW,CAAE,CAAE,EAAI,CAEjC,GADAW,EAAU,UAAW,CAAE,EAClB,UAAU,OAAS,EAAI,CAE3B,GADAK,EAAM,UAAW,CAAE,EACd,CAAClB,EAAYkB,CAAI,EACrB,MAAM,IAAI,UAAWT,EAAQ,uEAAwES,CAAI,CAAE,EAE5GN,EAAU,UAAW,CAAE,CACxB,CACA,GAAKb,EAAYc,EAAS,MAAO,IAChCE,EAAK,KAAOF,EAAQ,KACf,CAACV,EAAsBU,EAAQ,IAAK,GACxC,MAAM,IAAI,UAAWJ,EAAQ,2EAA4E,OAAQI,EAAQ,IAAK,CAAE,EAGlI,GAAKd,EAAYc,EAAS,KAAM,IAC/BE,EAAK,IAAMF,EAAQ,IACdA,EAAQ,MAAQ,GAAKA,EAAQ,MAAQ,IACzC,MAAM,IAAI,UAAWJ,EAAQ,wEAAyE,MAAOI,EAAQ,GAAI,CAAE,CAG9H,KAAO,CAEN,GADAK,EAAM,UAAW,CAAE,EACd,CAAClB,EAAYkB,CAAI,EACrB,MAAM,IAAI,UAAWT,EAAQ,iGAAkGS,CAAI,CAAE,EAEtIN,EAAU,UAAW,CAAE,CACxB,CAED,OAAAE,EAAQ,EAGRE,EAAO,CAAC,EACHE,EACCH,EAAK,MAAQ,GACjBM,EAAI,GACJvB,EAAakB,EAAM,OAAQM,CAAO,IAElCD,EAAIV,EAAI,OACRb,EAAakB,EAAM,OAAQO,CAAO,GAExBR,EAAK,MAAQ,GACxBM,EAAI,GACJvB,EAAakB,EAAM,OAAQQ,CAAO,IAElCH,EAAIV,EAAI,OACRb,EAAakB,EAAM,OAAQS,CAAO,GAEnC3B,EAAakB,EAAM,SAAUU,CAAI,EAG5BrB,GACJP,EAAakB,EAAMX,EAAgBsB,CAAQ,EAG5CP,EAAKZ,EAAOG,CAAI,EACXP,EAAiBO,CAAI,EACzBQ,EAAMb,EAAgBc,CAAG,EAEzBD,EAAMZ,EAAQa,CAAG,EAEXJ,EAQP,SAASM,GAAS,CAGjB,OAFAD,GAAKA,EAAE,GAAKV,EAAI,OAChBG,GAAS,EACJG,GAAOH,EAAQC,EAAK,MAAQJ,EAAI,SAAW,EACxC,CACN,KAAQ,EACT,EAEM,CACN,MAASO,EAAI,KAAMN,EAASO,EAAKR,EAAKU,CAAE,EAAGA,EAAGP,EAAOH,CAAI,EACzD,KAAQ,EACT,CACD,CAQA,SAASY,GAAS,CAMjB,OALAF,GAAK,EACAA,EAAI,IACRA,GAAKV,EAAI,QAEVG,GAAS,EACJG,GAAOH,EAAQC,EAAK,MAAQJ,EAAI,SAAW,EACxC,CACN,KAAQ,EACT,EAEM,CACN,MAASO,EAAI,KAAMN,EAASO,EAAKR,EAAKU,CAAE,EAAGA,EAAGP,EAAOH,CAAI,EACzD,KAAQ,EACT,CACD,CAQA,SAASa,GAAS,CAGjB,OAFAH,GAAKA,EAAE,GAAKV,EAAI,OAChBG,GAAS,EACJG,GAAOH,EAAQC,EAAK,MAAQJ,EAAI,SAAW,EACxC,CACN,KAAQ,EACT,EAEM,CACN,MAASQ,EAAKR,EAAKU,CAAE,EACrB,KAAQ,EACT,CACD,CAQA,SAASI,GAAS,CAMjB,OALAJ,GAAK,EACAA,EAAI,IACRA,GAAKV,EAAI,QAEVG,GAAS,EACJG,GAAOH,EAAQC,EAAK,MAAQJ,EAAI,SAAW,EACxC,CACN,KAAQ,EACT,EAEM,CACN,MAASQ,EAAKR,EAAKU,CAAE,EACrB,KAAQ,EACT,CACD,CASA,SAASK,EAAKE,EAAQ,CAErB,OADAX,EAAM,GACD,UAAU,OACP,CACN,MAASW,EACT,KAAQ,EACT,EAEM,CACN,KAAQ,EACT,CACD,CAQA,SAASD,GAAU,CAClB,OAAKT,EACGR,EAAoBC,EAAKI,EAAMG,EAAKN,CAAQ,EAE7CF,EAAoBC,EAAKI,CAAK,CACtC,CACD,CAKAlB,EAAO,QAAUa,ICpOjB,IAAImB,EAAO,IAKX,OAAO,QAAUA",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "setReadOnly", "hasOwnProp", "isFunction", "isCollection", "isObject", "isNonNegativeInteger", "isAccessorArray", "iteratorSymbol", "accessorGetter", "getter", "dtype", "format", "circarray2iterator", "src", "thisArg", "options", "count", "opts", "iter", "FLG", "fcn", "get", "dt", "i", "next1a", "next1b", "next2a", "next2b", "end", "factory", "value", "main"]
7
+ }
@@ -16,7 +16,7 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- // TypeScript Version: 2.0
19
+ // TypeScript Version: 4.1
20
20
 
21
21
  /// <reference types="@stdlib/types"/>
22
22
 
@@ -84,7 +84,7 @@ type Ternary = ( value: any, index: number, n: number ) => any;
84
84
  * @param src - source array-like object
85
85
  * @returns iterator value
86
86
  */
87
- type Quaternary = ( value: any, index: number, n: number, src: ArrayLike<any> ) => any; // tslint-disable-line max-line-length
87
+ type Quaternary = ( value: any, index: number, n: number, src: ArrayLike<any> ) => any;
88
88
 
89
89
  /**
90
90
  * Map function invoked for each iterated value.
@@ -120,7 +120,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary | Quaternary;
120
120
  *
121
121
  * // ...
122
122
  */
123
- declare function circarray2iterator( src: ArrayLike<any>, mapFcn?: MapFunction, thisArg?: any ): Iterator; // tslint:disable-line:max-line-length
123
+ declare function circarray2iterator( src: ArrayLike<any>, mapFcn?: MapFunction, thisArg?: any ): Iterator;
124
124
 
125
125
  /**
126
126
  * Returns an iterator which repeatedly iterates over each element in an array-like object.
@@ -150,7 +150,7 @@ declare function circarray2iterator( src: ArrayLike<any>, mapFcn?: MapFunction,
150
150
  * v = it.next().value;
151
151
  * // returns 2
152
152
  */
153
- declare function circarray2iterator( src: ArrayLike<any>, options: Options, mapFcn?: MapFunction, thisArg?: any ): Iterator; // tslint:disable-line:max-line-length
153
+ declare function circarray2iterator( src: ArrayLike<any>, options: Options, mapFcn?: MapFunction, thisArg?: any ): Iterator;
154
154
 
155
155
 
156
156
  // EXPORTS //
package/lib/index.js CHANGED
@@ -42,9 +42,9 @@
42
42
 
43
43
  // MODULES //
44
44
 
45
- var iterator = require( './main.js' );
45
+ var main = require( './main.js' );
46
46
 
47
47
 
48
48
  // EXPORTS //
49
49
 
50
- module.exports = iterator;
50
+ module.exports = main;
package/lib/main.js CHANGED
@@ -26,8 +26,12 @@ var isFunction = require( '@stdlib/assert-is-function' );
26
26
  var isCollection = require( '@stdlib/assert-is-collection' );
27
27
  var isObject = require( '@stdlib/assert-is-plain-object' );
28
28
  var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;
29
+ var isAccessorArray = require( '@stdlib/array-base-assert-is-accessor-array' );
29
30
  var iteratorSymbol = require( '@stdlib/symbol-iterator' );
30
- var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
31
+ var accessorGetter = require( '@stdlib/array-base-accessor-getter' );
32
+ var getter = require( '@stdlib/array-base-getter' );
33
+ var dtype = require( '@stdlib/array-dtype' );
34
+ var format = require( '@stdlib/string-format' );
31
35
 
32
36
 
33
37
  // MAIN //
@@ -70,9 +74,10 @@ function circarray2iterator( src ) {
70
74
  var FLG;
71
75
  var fcn;
72
76
  var get;
77
+ var dt;
73
78
  var i;
74
79
  if ( !isCollection( src ) ) {
75
- throw new TypeError( 'invalid argument. First argument must be an array-like object. Value: `' + src + '`.' );
80
+ throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', src ) );
76
81
  }
77
82
  opts = {
78
83
  'iter': 1e308, // ~infinity
@@ -84,26 +89,26 @@ function circarray2iterator( src ) {
84
89
  if ( arguments.length > 2 ) {
85
90
  fcn = arguments[ 2 ];
86
91
  if ( !isFunction( fcn ) ) {
87
- throw new TypeError( 'invalid argument. Callback argument must be a function. Value: `' + fcn + '`.' );
92
+ throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', fcn ) );
88
93
  }
89
94
  thisArg = arguments[ 3 ];
90
95
  }
91
96
  if ( hasOwnProp( options, 'iter' ) ) {
92
97
  opts.iter = options.iter;
93
98
  if ( !isNonNegativeInteger( options.iter ) ) {
94
- throw new TypeError( 'invalid option. `iter` option must be a nonnegative integer. Option: `' + options.iter + '`.' );
99
+ throw new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', options.iter ) );
95
100
  }
96
101
  }
97
102
  if ( hasOwnProp( options, 'dir' ) ) {
98
103
  opts.dir = options.dir;
99
104
  if ( options.dir !== 1 && options.dir !== -1 ) {
100
- throw new TypeError( 'invalid option. `dir` option must be either `1` or `-1`. Option: `' + options.dir + '`.' );
105
+ throw new TypeError( format( 'invalid option. `%s` option must be either `1` or `-1`. Option: `%s`.', 'dir', options.dir ) );
101
106
  }
102
107
  }
103
108
  } else {
104
109
  fcn = arguments[ 1 ];
105
110
  if ( !isFunction( fcn ) ) {
106
- throw new TypeError( 'invalid argument. Second argument must be either a function or an options object. Value: `' + fcn + '`.' );
111
+ throw new TypeError( format( 'invalid argument. Second argument must be either a function or an options object. Value: `%s`.', fcn ) );
107
112
  }
108
113
  thisArg = arguments[ 2 ];
109
114
  }
@@ -134,8 +139,12 @@ function circarray2iterator( src ) {
134
139
  setReadOnly( iter, iteratorSymbol, factory );
135
140
  }
136
141
  // Resolve an accessor for retrieving array elements (e.g., to accommodate `Complex64Array`, etc):
137
- get = arraylike2object( src ).getter;
138
-
142
+ dt = dtype( src );
143
+ if ( isAccessorArray( src ) ) {
144
+ get = accessorGetter( dt );
145
+ } else {
146
+ get = getter( dt );
147
+ }
139
148
  return iter;
140
149
 
141
150
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/array-to-circular-iterator",
3
- "version": "0.0.6",
3
+ "version": "0.2.0",
4
4
  "description": "Create an iterator which repeatedly iterates over the elements of an array-like object.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,28 +37,34 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/array-base-arraylike2object": "^0.0.x",
41
- "@stdlib/assert-has-own-property": "^0.0.x",
42
- "@stdlib/assert-is-collection": "^0.0.x",
43
- "@stdlib/assert-is-function": "^0.0.x",
44
- "@stdlib/assert-is-nonnegative-integer": "^0.0.x",
45
- "@stdlib/assert-is-plain-object": "^0.0.x",
46
- "@stdlib/symbol-iterator": "^0.0.x",
47
- "@stdlib/types": "^0.0.x",
48
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/array-base-accessor-getter": "^0.2.0",
41
+ "@stdlib/array-base-assert-is-accessor-array": "^0.2.0",
42
+ "@stdlib/array-base-getter": "^0.2.0",
43
+ "@stdlib/array-dtype": "^0.2.0",
44
+ "@stdlib/assert-has-own-property": "^0.2.0",
45
+ "@stdlib/assert-is-collection": "^0.2.0",
46
+ "@stdlib/assert-is-function": "^0.2.0",
47
+ "@stdlib/assert-is-nonnegative-integer": "^0.2.0",
48
+ "@stdlib/assert-is-plain-object": "^0.2.0",
49
+ "@stdlib/string-format": "^0.2.0",
50
+ "@stdlib/symbol-iterator": "^0.2.0",
51
+ "@stdlib/types": "^0.3.1",
52
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
53
+ "@stdlib/error-tools-fmtprodmsg": "^0.2.0"
49
54
  },
50
55
  "devDependencies": {
51
- "@stdlib/array-float64": "^0.0.x",
52
- "@stdlib/assert-is-iterator-like": "^0.0.x",
53
- "@stdlib/bench": "^0.0.x",
54
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
55
- "@stdlib/random-base-randu": "^0.0.x",
56
- "@stdlib/utils-inmap": "^0.0.x",
57
- "@stdlib/utils-noop": "^0.0.x",
56
+ "@stdlib/array-float64": "^0.2.0",
57
+ "@stdlib/assert-is-iterator-like": "^0.2.0",
58
+ "@stdlib/math-base-assert-is-nan": "^0.2.0",
59
+ "@stdlib/random-base-randu": "^0.1.0",
60
+ "@stdlib/utils-inmap": "^0.2.0",
61
+ "@stdlib/utils-noop": "^0.2.0",
58
62
  "proxyquire": "^2.0.0",
59
63
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
60
64
  "istanbul": "^0.4.1",
61
- "tap-spec": "5.x.x"
65
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
66
+ "@stdlib/bench-harness": "^0.2.0",
67
+ "@stdlib/bench": "^0.3.1"
62
68
  },
63
69
  "engines": {
64
70
  "node": ">=0.10.0",
@@ -100,7 +106,7 @@
100
106
  "repeat"
101
107
  ],
102
108
  "funding": {
103
- "type": "patreon",
104
- "url": "https://www.patreon.com/athan"
109
+ "type": "opencollective",
110
+ "url": "https://opencollective.com/stdlib"
105
111
  }
106
112
  }
package/docs/repl.txt DELETED
@@ -1,65 +0,0 @@
1
-
2
- {{alias}}( src[, options][, mapFcn[, thisArg]] )
3
- Returns an iterator which repeatedly iterates over the elements of an array-
4
- like object.
5
-
6
- When invoked, an input function is provided four arguments:
7
-
8
- - value: iterated value
9
- - index: iterated value index
10
- - n: iteration count
11
- - src: source array-like object
12
-
13
- If an environment supports Symbol.iterator, the returned iterator is
14
- iterable.
15
-
16
- If an environment supports Symbol.iterator, the function explicitly does not
17
- not invoke an array's `@@iterator` method, regardless of whether this method
18
- is defined. To convert an array to an implementation defined iterator,
19
- invoke this method directly.
20
-
21
- Parameters
22
- ----------
23
- src: ArrayLikeObject
24
- Array-like object from which to create the iterator.
25
-
26
- options: Object (optional)
27
- Function options.
28
-
29
- options.iter: integer (optional)
30
- Number of iterations. Default: 1e308.
31
-
32
- options.dir: integer (optional)
33
- Iteration direction. If set to `-1`, an iterator iterates over elements
34
- from right-to-left. Default: 1.
35
-
36
- mapFcn: Function (optional)
37
- Function to invoke for each iterated value.
38
-
39
- thisArg: any (optional)
40
- Execution context.
41
-
42
- Returns
43
- -------
44
- iterator: Object
45
- Iterator.
46
-
47
- iterator.next(): Function
48
- Returns an iterator protocol-compliant object containing the next
49
- iterated value (if one exists) and a boolean flag indicating whether the
50
- iterator is finished.
51
-
52
- iterator.return( [value] ): Function
53
- Finishes an iterator and returns a provided value.
54
-
55
- Examples
56
- --------
57
- > var it = {{alias}}( [ 1, 2, 3, 4 ] );
58
- > var v = it.next().value
59
- 1
60
- > v = it.next().value
61
- 2
62
-
63
- See Also
64
- --------
65
-
@@ -1,87 +0,0 @@
1
- /*
2
- * @license Apache-2.0
3
- *
4
- * Copyright (c) 2021 The Stdlib Authors.
5
- *
6
- * Licensed under the Apache License, Version 2.0 (the "License");
7
- * you may not use this file except in compliance with the License.
8
- * You may obtain a copy of the License at
9
- *
10
- * http://www.apache.org/licenses/LICENSE-2.0
11
- *
12
- * Unless required by applicable law or agreed to in writing, software
13
- * distributed under the License is distributed on an "AS IS" BASIS,
14
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- * See the License for the specific language governing permissions and
16
- * limitations under the License.
17
- */
18
-
19
- import circarray2iterator = require( './index' );
20
-
21
- /**
22
- * Multiplies a value by 10.
23
- *
24
- * @param v - iterated value
25
- * @returns new value
26
- */
27
- function times10( v: number ): number {
28
- return v * 10.0;
29
- }
30
-
31
-
32
- // TESTS //
33
-
34
- // The function returns an iterator...
35
- {
36
- circarray2iterator( [ 1, 2, 3, 4 ] ); // $ExpectType Iterator
37
- circarray2iterator( [ 1, 2, 3, 4 ], times10 ); // $ExpectType Iterator
38
- circarray2iterator( [ 1, 2, 3, 4 ], times10, {} ); // $ExpectType Iterator
39
- }
40
-
41
- // The compiler throws an error if the function is provided a first argument which is not array-like...
42
- {
43
- circarray2iterator( 123 ); // $ExpectError
44
- circarray2iterator( true ); // $ExpectError
45
- circarray2iterator( false ); // $ExpectError
46
- circarray2iterator( {} ); // $ExpectError
47
- circarray2iterator( null ); // $ExpectError
48
- circarray2iterator( undefined ); // $ExpectError
49
- }
50
-
51
- // The compiler throws an error if the function is provided a second argument which is not an options object or function...
52
- {
53
- circarray2iterator( [ 1, 2, 3, 4 ], 'abc' ); // $ExpectError
54
- circarray2iterator( [ 1, 2, 3, 4 ], 123 ); // $ExpectError
55
- circarray2iterator( [ 1, 2, 3, 4 ], [] ); // $ExpectError
56
- circarray2iterator( [ 1, 2, 3, 4 ], true ); // $ExpectError
57
- circarray2iterator( [ 1, 2, 3, 4 ], false ); // $ExpectError
58
- circarray2iterator( [ 1, 2, 3, 4 ], null ); // $ExpectError
59
- }
60
-
61
- // The compiler throws an error if the function is provided a `dir` option which is not a number...
62
- {
63
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': 'abc' } ); // $ExpectError
64
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': true } ); // $ExpectError
65
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': false } ); // $ExpectError
66
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': null } ); // $ExpectError
67
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': [] } ); // $ExpectError
68
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': {} } ); // $ExpectError
69
- circarray2iterator( [ 1, 2, 3, 4 ], { 'dir': ( x: number ): number => x } ); // $ExpectError
70
- }
71
-
72
- // The compiler throws an error if the function is provided an `iter` option which is not a number...
73
- {
74
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': 'abc' } ); // $ExpectError
75
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': true } ); // $ExpectError
76
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': false } ); // $ExpectError
77
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': null } ); // $ExpectError
78
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': [] } ); // $ExpectError
79
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': {} } ); // $ExpectError
80
- circarray2iterator( [ 1, 2, 3, 4 ], { 'iter': ( x: number ): number => x } ); // $ExpectError
81
- }
82
-
83
- // The compiler throws an error if the function is provided an unsupported number of arguments...
84
- {
85
- circarray2iterator(); // $ExpectError
86
- circarray2iterator( [ 1, 2, 3, 4 ], times10, {}, 123 ); // $ExpectError
87
- }