@stdlib/random-iter-improved-ziggurat 0.0.6 → 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-2022 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ 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>
+
 # Standard Normal Random Numbers
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -225,7 +236,7 @@ while ( true ) {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/random/base/improved-ziggurat`][@stdlib/random/base/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">normally distributed pseudorandom numbers using the improved Ziggurat method.</span>
+-   <span class="package-name">[`@stdlib/random-base/improved-ziggurat`][@stdlib/random/base/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">normally distributed pseudorandom numbers using the improved Ziggurat method.</span>
 
 </section>
 
@@ -257,7 +268,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -270,8 +281,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/random-iter-improved-ziggurat.svg
 [npm-url]: https://npmjs.org/package/@stdlib/random-iter-improved-ziggurat
 
-[test-image]: https://github.com/stdlib-js/random-iter-improved-ziggurat/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/random-iter-improved-ziggurat/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/random-iter-improved-ziggurat/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/random-iter-improved-ziggurat/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-iter-improved-ziggurat/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/random-iter-improved-ziggurat?branch=main
@@ -283,19 +294,20 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 -->
 
+[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/random-iter-improved-ziggurat/tree/deno
 [umd-url]: https://github.com/stdlib-js/random-iter-improved-ziggurat/tree/umd
 [esm-url]: https://github.com/stdlib-js/random-iter-improved-ziggurat/tree/esm
-
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+[branches-url]: https://github.com/stdlib-js/random-iter-improved-ziggurat/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-iter-improved-ziggurat/main/LICENSE
 

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var S=function(i,e){return function(){return e||i((e={exports:{}}).exports,e),e.exports}};var q=S(function(V,h){
+var n=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),a=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),g=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),O=require('@stdlib/utils-constant-function/dist'),w=require('@stdlib/utils-noop/dist'),x=require('@stdlib/object-assign/dist'),A=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-has-own-property/dist'),v=require('@stdlib/constants-float64-max/dist'),l=require('@stdlib/random-base-improved-ziggurat/dist').factory,f=require('@stdlib/symbol-iterator/dist'),c=require('@stdlib/error-tools-fmtprodmsg/dist');function d(i){var e,t,r,o,u;if(arguments.length>0){if(!A(i))throw new TypeError(c('0pr2V',i));if(e=x({},i),j(e,"iter")){if(!E(e.iter))throw new TypeError(c('0pr2t',"iter",e.iter))}else e.iter=v;r=l(e),e.prng===void 0&&e.copy!==!1&&(e.state=r.state)}else r=l(),e={iter:v,state:r.state};return u=0,t={},n(t,"next",L),n(t,"return",p),e&&e.prng?(n(t,"seed",null),n(t,"seedLength",null),g(t,"state",O(null),w),n(t,"stateLength",null),n(t,"byteLength",null)):(a(t,"seed",y),a(t,"seedLength",R),g(t,"state",G,b),a(t,"stateLength",N),a(t,"byteLength",P)),n(t,"PRNG",r.PRNG),f&&n(t,f,m),t;function L(){return u+=1,o||u>e.iter?{done:!0}:{value:r(),done:!1}}function p(s){return o=!0,arguments.length?{value:s,done:!0}:{done:!0}}function m(){return d(e)}function y(){return r.PRNG.seed}function R(){return r.PRNG.seedLength}function N(){return r.PRNG.stateLength}function P(){return r.PRNG.byteLength}function G(){return r.PRNG.state}function b(s){r.PRNG.state=s}}h.exports=d
+});var F=q();module.exports=F;
+/** @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 setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar assign = require( '@stdlib/object-assign' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar MAX_VALUE = require( '@stdlib/constants-float64-max' );\nvar rnorm = require( '@stdlib/random-base-improved-ziggurat' ).factory;\nvar iteratorSymbol = require( '@stdlib/symbol-iterator' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Returns an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.\n*\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {NonNegativeInteger} [options.iter] - number of iterations\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Iterator} iterator\n*\n* @example\n* var iter = iterator();\n*\n* var r = iter.next().value;\n* // returns <number>\n*\n* r = iter.next().value;\n* // returns <number>\n*\n* r = iter.next().value;\n* // returns <number>\n*\n* // ...\n*/\nfunction iterator( options ) {\n\tvar opts;\n\tvar iter;\n\tvar rand;\n\tvar FLG;\n\tvar i;\n\tif ( arguments.length > 0 ) {\n\t\tif ( !isObject( options ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t\t}\n\t\topts = assign( {}, options );\n\t\tif ( hasOwnProp( opts, 'iter' ) ) {\n\t\t\tif ( !isNonNegativeInteger( opts.iter ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', opts.iter ) );\n\t\t\t}\n\t\t} else {\n\t\t\topts.iter = MAX_VALUE;\n\t\t}\n\t\trand = rnorm( opts );\n\t\tif ( opts.prng === void 0 && opts.copy !== false ) {\n\t\t\topts.state = rand.state; // cache a copy of the PRNG state\n\t\t}\n\t} else {\n\t\trand = rnorm();\n\t\topts = {\n\t\t\t'iter': MAX_VALUE,\n\t\t\t'state': rand.state // cache a copy of the PRNG state\n\t\t};\n\t}\n\ti = 0;\n\n\t// Create an iterator protocol-compliant object:\n\titer = {};\n\tsetReadOnly( iter, 'next', next );\n\tsetReadOnly( iter, 'return', end );\n\n\tif ( opts && opts.prng ) {\n\t\tsetReadOnly( iter, 'seed', null );\n\t\tsetReadOnly( iter, 'seedLength', null );\n\t\tsetReadWriteAccessor( iter, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( iter, 'stateLength', null );\n\t\tsetReadOnly( iter, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( iter, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( iter, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( iter, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( iter, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( iter, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( iter, 'PRNG', rand.PRNG );\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\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 next() {\n\t\ti += 1;\n\t\tif ( FLG || i > opts.iter ) {\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': rand(),\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\treturn iterator( opts );\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = iterator;\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 for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.\n*\n* @module @stdlib/random-iter-improved-ziggurat\n*\n* @example\n* var iterator = require( '@stdlib/random-iter-improved-ziggurat' );\n*\n* var iter = iterator();\n*\n* var r = iter.next().value;\n* // returns <number>\n*\n* r = iter.next().value;\n* // returns <number>\n*\n* r = iter.next().value;\n* // returns <number>\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,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,QAAS,gCAAiC,EACrDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,iCAAkC,EACxDC,EAAY,QAAS,+BAAgC,EACrDC,EAAQ,QAAS,uCAAwC,EAAE,QAC3DC,EAAiB,QAAS,yBAA0B,EACpDC,EAAS,QAAS,uBAAwB,EAiC9C,SAASC,EAAUC,EAAU,CAC5B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACJ,GAAK,UAAU,OAAS,EAAI,CAC3B,GAAK,CAACb,EAAUQ,CAAQ,EACvB,MAAM,IAAI,UAAWF,EAAQ,qEAAsEE,CAAQ,CAAE,EAG9G,GADAC,EAAOV,EAAQ,CAAC,EAAGS,CAAQ,EACtBN,EAAYO,EAAM,MAAO,GAC7B,GAAK,CAACR,EAAsBQ,EAAK,IAAK,EACrC,MAAM,IAAI,UAAWH,EAAQ,2EAA4E,OAAQG,EAAK,IAAK,CAAE,OAG9HA,EAAK,KAAON,EAEbQ,EAAOP,EAAOK,CAAK,EACdA,EAAK,OAAS,QAAUA,EAAK,OAAS,KAC1CA,EAAK,MAAQE,EAAK,MAEpB,MACCA,EAAOP,EAAM,EACbK,EAAO,CACN,KAAQN,EACR,MAASQ,EAAK,KACf,EAED,OAAAE,EAAI,EAGJH,EAAO,CAAC,EACRhB,EAAagB,EAAM,OAAQI,CAAK,EAChCpB,EAAagB,EAAM,SAAUK,CAAI,EAE5BN,GAAQA,EAAK,MACjBf,EAAagB,EAAM,OAAQ,IAAK,EAChChB,EAAagB,EAAM,aAAc,IAAK,EACtCd,EAAsBc,EAAM,QAASb,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAagB,EAAM,cAAe,IAAK,EACvChB,EAAagB,EAAM,aAAc,IAAK,IAEtCf,EAAqBe,EAAM,OAAQM,CAAQ,EAC3CrB,EAAqBe,EAAM,aAAcO,CAAc,EACvDrB,EAAsBc,EAAM,QAASQ,EAAUC,CAAS,EACxDxB,EAAqBe,EAAM,cAAeU,CAAe,EACzDzB,EAAqBe,EAAM,aAAcW,CAAa,GAEvD3B,EAAagB,EAAM,OAAQC,EAAK,IAAK,EAGhCN,GACJX,EAAagB,EAAML,EAAgBiB,CAAQ,EAErCZ,EAQP,SAASI,GAAO,CAEf,OADAD,GAAK,EACAD,GAAOC,EAAIJ,EAAK,KACb,CACN,KAAQ,EACT,EAEM,CACN,MAASE,EAAK,EACd,KAAQ,EACT,CACD,CASA,SAASI,EAAKQ,EAAQ,CAErB,OADAX,EAAM,GACD,UAAU,OACP,CACN,MAASW,EACT,KAAQ,EACT,EAEM,CACN,KAAQ,EACT,CACD,CAQA,SAASD,GAAU,CAClB,OAAOf,EAAUE,CAAK,CACvB,CAQA,SAASO,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAU,EAAI,CACtBR,EAAK,KAAK,MAAQ,CACnB,CACD,CAKAlB,EAAO,QAAUc,IClMjB,IAAIiB,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "assign", "isObject", "isNonNegativeInteger", "hasOwnProp", "MAX_VALUE", "rnorm", "iteratorSymbol", "format", "iterator", "options", "opts", "iter", "rand", "FLG", "i", "next", "end", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "factory", "value", "main"]
+}

package/docs/types/index.d.ts

@@ -16,12 +16,12 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 
 import * as random from '@stdlib/types/random';
-import { Iterator } from '@stdlib/types/iter';
+import { TypedIterator } from '@stdlib/types/iter';
 
 /**
 * Interface defining function options.
@@ -56,7 +56,7 @@ interface Options {
 /**
 * Interface for iterators of pseudorandom numbers having integer values.
 */
-interface RandIter extends Iterator {
+interface Iterator<T> extends TypedIterator<T> {
 	/**
 	* Underlying pseudorandom number generator.
 	*/
@@ -114,7 +114,7 @@ interface RandIter extends Iterator {
 *
 * // ...
 */
-declare function iterator( options?: Options ): RandIter;
+declare function iterator( options?: Options ): Iterator<number>;
 
 
 // EXPORTS //

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

@@ -25,13 +25,14 @@ var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only
 var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );
 var constantFunction = require( '@stdlib/utils-constant-function' );
 var noop = require( '@stdlib/utils-noop' );
-var copy = require( '@stdlib/utils-copy' );
+var assign = require( '@stdlib/object-assign' );
 var isObject = require( '@stdlib/assert-is-plain-object' );
 var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var MAX_VALUE = require( '@stdlib/constants-float64-max' );
 var rnorm = require( '@stdlib/random-base-improved-ziggurat' ).factory;
 var iteratorSymbol = require( '@stdlib/symbol-iterator' );
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -72,12 +73,12 @@ function iterator( options ) {
 	var i;
 	if ( arguments.length > 0 ) {
 		if ( !isObject( options ) ) {
-			throw new TypeError( 'invalid argument. Options argument must be an object. Value: `'+options+'`.' );
+			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
 		}
-		opts = copy( options, 1 );
+		opts = assign( {}, options );
 		if ( hasOwnProp( opts, 'iter' ) ) {
 			if ( !isNonNegativeInteger( opts.iter ) ) {
-				throw new TypeError( 'invalid option. `iter` option must be a nonnegative integer. Option: `'+opts.iter+'`.' );
+				throw new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', opts.iter ) );
 			}
 		} else {
 			opts.iter = MAX_VALUE;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/random-iter-improved-ziggurat",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "description": "Create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.",
   "license": "Apache-2.0",
   "author": {
@@ -37,32 +37,34 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/constants-float64-max": "^0.0.x",
-    "@stdlib/random-base-improved-ziggurat": "^0.0.x",
-    "@stdlib/symbol-iterator": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-copy": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.x",
-    "@stdlib/utils-noop": "^0.0.x"
+    "@stdlib/assert-has-own-property": "^0.1.0",
+    "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
+    "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/constants-float64-max": "^0.1.0",
+    "@stdlib/object-assign": "^0.1.0",
+    "@stdlib/random-base-improved-ziggurat": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/symbol-iterator": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-constant-function": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.0",
+    "@stdlib/utils-noop": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-uint32": "^0.0.x",
-    "@stdlib/assert-is-uint32array": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-uint32-max": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/random-base-minstd": "^0.0.x",
-    "@stdlib/time-now": "^0.0.x",
+    "@stdlib/array-uint32": "^0.1.0",
+    "@stdlib/assert-is-uint32array": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-uint32-max": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/random-base-minstd": "^0.0.6",
+    "@stdlib/time-now": "^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",
@@ -106,7 +108,7 @@
     "iterable"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,81 +0,0 @@
-
-{{alias}}( [options] )
-    Returns an iterator for generating pseudorandom numbers drawn from a
-    standard normal distribution using the Improved Ziggurat algorithm.
-
-    If an environment supports Symbol.iterator, the returned iterator is
-    iterable.
-
-    Parameters
-    ----------
-    options: Object (optional)
-        Options.
-
-    options.prng: Function (optional)
-        Pseudorandom number generator (PRNG) for generating uniformly
-        distributed pseudorandom numbers on the interval `[0,1)`. If provided,
-        the `state` and `seed` options are ignored. In order to seed the
-        returned iterator, one must seed the provided `prng` (assuming the
-        provided `prng` is seedable).
-
-    options.seed: integer|ArrayLikeObject<integer> (optional)
-        Pseudorandom number generator seed. The seed may be either a positive
-        unsigned 32-bit integer or, for arbitrary length seeds, an array-like
-        object containing unsigned 32-bit integers.
-
-    options.state: Uint32Array (optional)
-        Pseudorandom number generator state. If provided, the `seed` option is
-        ignored.
-
-    options.copy: boolean (optional)
-        Boolean indicating whether to copy a provided pseudorandom number
-        generator state. Setting this option to `false` allows sharing state
-        between two or more pseudorandom number generators. Setting this option
-        to `true` ensures that a returned iterator has exclusive control over
-        its internal state. Default: true.
-
-    options.iter: integer (optional)
-        Number of iterations.
-
-    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.
-
-    iterator.PRNG: Function
-        Underlying pseudorandom number generator.
-
-    iterator.seed: Uint32Array|null
-        Pseudorandom number generator seed.
-
-    iterator.seedLength: integer|null
-        Length of generator seed.
-
-    iterator.state: Uint32Array|null
-        Generator state.
-
-    iterator.stateLength: integer|null
-        Length of generator state.
-
-    iterator.byteLength: integer|null
-        Size (in bytes) of generator state.
-
-    Examples
-    --------
-    > var it = {{alias}}();
-    > var r = it.next().value
-    <number>
-    > r = it.next().value
-    <number>
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,97 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2021 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 iterator = require( './index' );
-
-
-// TESTS //
-
-// The function returns an iterator...
-{
-	iterator(); // $ExpectType RandIter
-	iterator( { 'iter': 10 } ); // $ExpectType RandIter
-	iterator( { 'copy': false } ); // $ExpectType RandIter
-}
-
-// The compiler throws an error if the function is provided an options argument which is not an object...
-{
-	iterator( 'abc' ); // $ExpectError
-	iterator( true ); // $ExpectError
-	iterator( false ); // $ExpectError
-	iterator( 123 ); // $ExpectError
-	iterator( [] ); // $ExpectError
-	iterator( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `prng` option which is not a valid PRNG...
-{
-	iterator( { 'prng': true } ); // $ExpectError
-	iterator( { 'prng': false } ); // $ExpectError
-	iterator( { 'prng': 123 } ); // $ExpectError
-	iterator( { 'prng': 'abc' } ); // $ExpectError
-	iterator( { 'prng': null } ); // $ExpectError
-	iterator( { 'prng': [] } ); // $ExpectError
-	iterator( { 'prng': {} } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `seed` option which is not a valid seed...
-{
-	iterator( { 'seed': true } ); // $ExpectError
-	iterator( { 'seed': 'abc' } ); // $ExpectError
-	iterator( { 'seed': null } ); // $ExpectError
-	iterator( { 'seed': [ 'a' ] } ); // $ExpectError
-	iterator( { 'seed': {} } ); // $ExpectError
-	iterator( { 'seed': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `state` option which is not a valid state...
-{
-	iterator( { 'state': 123 } ); // $ExpectError
-	iterator( { 'state': 'abc' } ); // $ExpectError
-	iterator( { 'state': null } ); // $ExpectError
-	iterator( { 'state': [] } ); // $ExpectError
-	iterator( { 'state': {} } ); // $ExpectError
-	iterator( { 'state': true ); // $ExpectError
-	iterator( { 'state': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `copy` option which is not a boolean...
-{
-	iterator( { 'copy': 123 } ); // $ExpectError
-	iterator( { 'copy': 'abc' } ); // $ExpectError
-	iterator( { 'copy': null } ); // $ExpectError
-	iterator( { 'copy': [] } ); // $ExpectError
-	iterator( { 'copy': {} } ); // $ExpectError
-	iterator( { 'copy': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a `iter` option which is not a number...
-{
-	iterator( { 'iter': true } ); // $ExpectError
-	iterator( { 'iter': false } ); // $ExpectError
-	iterator( { 'iter': 'abc' } ); // $ExpectError
-	iterator( { 'iter': null } ); // $ExpectError
-	iterator( { 'iter': [] } ); // $ExpectError
-	iterator( { 'iter': {} } ); // $ExpectError
-	iterator( { 'iter': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid number of arguments...
-{
-	iterator( {}, {} ); // $ExpectError
-}