@stdlib/random-iter-gamma 0.0.6 → 0.2.0

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-2024 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>
+
 # Gamma 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] -->
@@ -223,7 +234,7 @@ while ( true ) {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/random/base/gamma`][@stdlib/random/base/gamma]</span><span class="delimiter">: </span><span class="description">gamma distributed pseudorandom numbers.</span>
+-   <span class="package-name">[`@stdlib/random-base/gamma`][@stdlib/random/base/gamma]</span><span class="delimiter">: </span><span class="description">gamma distributed pseudorandom numbers.</span>
 
 </section>
 
@@ -255,7 +266,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -268,8 +279,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/random-iter-gamma.svg
 [npm-url]: https://npmjs.org/package/@stdlib/random-iter-gamma
 
-[test-image]: https://github.com/stdlib-js/random-iter-gamma/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/random-iter-gamma/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/random-iter-gamma/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/random-iter-gamma/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-iter-gamma/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/random-iter-gamma?branch=main
@@ -281,19 +292,23 @@ 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-gamma/tree/deno
+[deno-readme]: https://github.com/stdlib-js/random-iter-gamma/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/random-iter-gamma/tree/umd
+[umd-readme]: https://github.com/stdlib-js/random-iter-gamma/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/random-iter-gamma/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
+[esm-readme]: https://github.com/stdlib-js/random-iter-gamma/blob/esm/README.md
+[branches-url]: https://github.com/stdlib-js/random-iter-gamma/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-iter-gamma/main/LICENSE
 

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

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 E=function(u,n){return function(){return n||u((n={exports:{}}).exports,n),n.exports}};var L=E(function(M,y){
+var i=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),a=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),l=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),x=require('@stdlib/utils-constant-function/dist'),A=require('@stdlib/utils-noop/dist'),T=require('@stdlib/object-assign/dist'),c=require('@stdlib/assert-is-positive-number/dist').isPrimitive,V=require('@stdlib/assert-is-plain-object/dist'),F=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-has-own-property/dist'),d=require('@stdlib/constants-float64-max/dist'),m=require('@stdlib/random-base-gamma/dist').factory,q=require('@stdlib/symbol-iterator/dist'),s=require('@stdlib/error-tools-fmtprodmsg/dist');function h(u,n,o){var r,e,t,f,g;if(!c(u))throw new TypeError(s('0pj71',u));if(!c(n))throw new TypeError(s('0pj72',n));if(arguments.length>2){if(!V(o))throw new TypeError(s('0pj2V',o));if(r=T({},o),j(r,"iter")){if(!F(r.iter))throw new TypeError(s('0pj2t',"iter",r.iter))}else r.iter=d;t=m(u,n,r),r.prng===void 0&&r.copy!==!1&&(r.state=t.state)}else t=m(u,n),r={iter:d,state:t.state};return g=0,e={},i(e,"next",p),i(e,"return",P),r&&r.prng?(i(e,"seed",null),i(e,"seedLength",null),l(e,"state",x(null),A),i(e,"stateLength",null),i(e,"byteLength",null)):(a(e,"seed",R),a(e,"seedLength",b),l(e,"state",S,O),a(e,"stateLength",w),a(e,"byteLength",G)),i(e,"PRNG",t.PRNG),q&&i(e,q,N),e;function p(){return g+=1,f||g>r.iter?{done:!0}:{value:t(),done:!1}}function P(v){return f=!0,arguments.length?{value:v,done:!0}:{done:!0}}function N(){return h(u,n,r)}function R(){return t.PRNG.seed}function b(){return t.PRNG.seedLength}function w(){return t.PRNG.stateLength}function G(){return t.PRNG.byteLength}function S(){return t.PRNG.state}function O(v){t.PRNG.state=v}}y.exports=h
+});var z=L();module.exports=z;
+/** @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 isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive;\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 rgamma = require( '@stdlib/random-base-gamma' ).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 gamma distribution.\n*\n* @param {PositiveNumber} alpha - shape parameter\n* @param {PositiveNumber} beta  - rate parameter\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} `alpha` must be a positive number\n* @throws {TypeError} `beta` must be a positive number\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( 2.0, 5.0 );\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( alpha, beta, options ) {\n\tvar opts;\n\tvar iter;\n\tvar rand;\n\tvar FLG;\n\tvar i;\n\tif ( !isPositiveNumber( alpha ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a positive number. Value: `%s`.', alpha ) );\n\t}\n\tif ( !isPositiveNumber( beta ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a positive number. Value: `%s`.', beta ) );\n\t}\n\tif ( arguments.length > 2 ) {\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 = rgamma( alpha, beta, 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 = rgamma( alpha, beta );\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( alpha, beta, 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 gamma distribution.\n*\n* @module @stdlib/random-iter-gamma\n*\n* @example\n* var iterator = require( '@stdlib/random-iter-gamma' );\n*\n* var iter = iterator( 2.0, 5.0 );\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,EAAmB,QAAS,mCAAoC,EAAE,YAClEC,EAAW,QAAS,gCAAiC,EACrDC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,iCAAkC,EACxDC,EAAY,QAAS,+BAAgC,EACrDC,EAAS,QAAS,2BAA4B,EAAE,QAChDC,EAAiB,QAAS,yBAA0B,EACpDC,EAAS,QAAS,uBAAwB,EAqC9C,SAASC,EAAUC,EAAOC,EAAMC,EAAU,CACzC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACJ,GAAK,CAAChB,EAAkBS,CAAM,EAC7B,MAAM,IAAI,UAAWF,EAAQ,2EAA4EE,CAAM,CAAE,EAElH,GAAK,CAACT,EAAkBU,CAAK,EAC5B,MAAM,IAAI,UAAWH,EAAQ,4EAA6EG,CAAK,CAAE,EAElH,GAAK,UAAU,OAAS,EAAI,CAC3B,GAAK,CAACT,EAAUU,CAAQ,EACvB,MAAM,IAAI,UAAWJ,EAAQ,qEAAsEI,CAAQ,CAAE,EAG9G,GADAC,EAAOb,EAAQ,CAAC,EAAGY,CAAQ,EACtBR,EAAYS,EAAM,MAAO,GAC7B,GAAK,CAACV,EAAsBU,EAAK,IAAK,EACrC,MAAM,IAAI,UAAWL,EAAQ,2EAA4E,OAAQK,EAAK,IAAK,CAAE,OAG9HA,EAAK,KAAOR,EAEbU,EAAOT,EAAQI,EAAOC,EAAME,CAAK,EAC5BA,EAAK,OAAS,QAAUA,EAAK,OAAS,KAC1CA,EAAK,MAAQE,EAAK,MAEpB,MACCA,EAAOT,EAAQI,EAAOC,CAAK,EAC3BE,EAAO,CACN,KAAQR,EACR,MAASU,EAAK,KACf,EAED,OAAAE,EAAI,EAGJH,EAAO,CAAC,EACRnB,EAAamB,EAAM,OAAQI,CAAK,EAChCvB,EAAamB,EAAM,SAAUK,CAAI,EAE5BN,GAAQA,EAAK,MACjBlB,EAAamB,EAAM,OAAQ,IAAK,EAChCnB,EAAamB,EAAM,aAAc,IAAK,EACtCjB,EAAsBiB,EAAM,QAAShB,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAamB,EAAM,cAAe,IAAK,EACvCnB,EAAamB,EAAM,aAAc,IAAK,IAEtClB,EAAqBkB,EAAM,OAAQM,CAAQ,EAC3CxB,EAAqBkB,EAAM,aAAcO,CAAc,EACvDxB,EAAsBiB,EAAM,QAASQ,EAAUC,CAAS,EACxD3B,EAAqBkB,EAAM,cAAeU,CAAe,EACzD5B,EAAqBkB,EAAM,aAAcW,CAAa,GAEvD9B,EAAamB,EAAM,OAAQC,EAAK,IAAK,EAGhCR,GACJZ,EAAamB,EAAMP,EAAgBmB,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,OAAOjB,EAAUC,EAAOC,EAAME,CAAK,CACpC,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,EAAUK,EAAI,CACtBb,EAAK,KAAK,MAAQa,CACnB,CACD,CAKAlC,EAAO,QAAUe,IC7MjB,IAAIoB,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "assign", "isPositiveNumber", "isObject", "isNonNegativeInteger", "hasOwnProp", "MAX_VALUE", "rgamma", "iteratorSymbol", "format", "iterator", "alpha", "beta", "options", "opts", "iter", "rand", "FLG", "i", "next", "end", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "factory", "value", "s", "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 drawn from a gamma distribution.
 */
-interface RandIter extends Iterator {
+interface Iterator<T> extends TypedIterator<T> {
 	/**
 	* Underlying PRNG.
 	*/
@@ -114,7 +114,7 @@ interface RandIter extends Iterator {
 *
 * // ...
 */
-declare function iterator( alpha: number, beta: number, options?: Options ): RandIter; // tslint:disable-line:max-line-length
+declare function iterator( alpha: number, beta: number, 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,7 +25,7 @@ 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 isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive;
 var isObject = require( '@stdlib/assert-is-plain-object' );
 var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;
@@ -33,6 +33,7 @@ var hasOwnProp = require( '@stdlib/assert-has-own-property' );
 var MAX_VALUE = require( '@stdlib/constants-float64-max' );
 var rgamma = require( '@stdlib/random-base-gamma' ).factory;
 var iteratorSymbol = require( '@stdlib/symbol-iterator' );
+var format = require( '@stdlib/string-format' );
 
 
 // MAIN //
@@ -76,19 +77,19 @@ function iterator( alpha, beta, options ) {
 	var FLG;
 	var i;
 	if ( !isPositiveNumber( alpha ) ) {
-		throw new TypeError( 'invalid argument. First argument must be a positive number. Value: `'+alpha+'`.' );
+		throw new TypeError( format( 'invalid argument. First argument must be a positive number. Value: `%s`.', alpha ) );
 	}
 	if ( !isPositiveNumber( beta ) ) {
-		throw new TypeError( 'invalid argument. Second argument must be a positive number. Value: `'+beta+'`.' );
+		throw new TypeError( format( 'invalid argument. Second argument must be a positive number. Value: `%s`.', beta ) );
 	}
 	if ( arguments.length > 2 ) {
 		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-gamma",
-  "version": "0.0.6",
+  "version": "0.2.0",
   "description": "Create an iterator for generating pseudorandom numbers drawn from a gamma distribution.",
   "license": "Apache-2.0",
   "author": {
@@ -37,35 +37,38 @@
     "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/assert-is-positive-number": "^0.0.x",
-    "@stdlib/constants-float64-max": "^0.0.x",
-    "@stdlib/random-base-gamma": "^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.2.0",
+    "@stdlib/assert-is-nonnegative-integer": "^0.2.0",
+    "@stdlib/assert-is-plain-object": "^0.2.0",
+    "@stdlib/assert-is-positive-number": "^0.2.0",
+    "@stdlib/constants-float64-max": "^0.2.0",
+    "@stdlib/object-assign": "^0.2.0",
+    "@stdlib/random-base-gamma": "^0.1.0",
+    "@stdlib/string-format": "^0.2.0",
+    "@stdlib/symbol-iterator": "^0.2.0",
+    "@stdlib/types": "^0.3.1",
+    "@stdlib/utils-constant-function": "^0.2.0",
+    "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.2.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
+    "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.2.0",
+    "@stdlib/utils-noop": "^0.2.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/array-uint32": "^0.0.x",
-    "@stdlib/assert-is-uint32array": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^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/random-base-randu": "^0.0.x",
-    "@stdlib/time-now": "^0.0.x",
+    "@stdlib/array-uint32": "^0.2.0",
+    "@stdlib/assert-is-uint32array": "^0.2.0",
+    "@stdlib/constants-float64-eps": "^0.2.0",
+    "@stdlib/constants-uint32-max": "^0.2.0",
+    "@stdlib/math-base-assert-is-nan": "^0.2.0",
+    "@stdlib/random-base-minstd": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.1.0",
+    "@stdlib/time-now": "^0.2.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",
+    "@stdlib/bench-harness": "^0.2.0",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -103,7 +106,7 @@
     "iterable"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,89 +0,0 @@
-
-{{alias}}( α, β[, options] )
-    Returns an iterator for generating pseudorandom numbers drawn from a gamma
-    distribution.
-
-    If an environment supports Symbol.iterator, the returned iterator is
-    iterable.
-
-    The function throws an error if `α <= 0` or `β <= 0`.
-
-    Parameters
-    ----------
-    α: number
-        Shape parameter.
-
-    β: number
-        Rate parameter.
-
-    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}}( 1.0, 1.0 );
-    > var r = it.next().value
-    <number>
-    > r = it.next().value
-    <number>
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,42 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 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( 2.0, 5.0 ); // $ExpectType RandIter
-	iterator( 2.0, 5.0, {} ); // $ExpectType RandIter
-	iterator( 2.0, 5.0, { 'iter': 10 } ); // $ExpectType RandIter
-}
-
-// The compiler throws an error if the function is provided invalid input arguments...
-{
-	iterator( '2.0', 5.0 ); // $ExpectError
-	iterator( 2.0, '5.0' ); // $ExpectError
-	iterator( 2.0, 5.0, { 'iter': 'beep' } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided insufficient arguments...
-{
-	iterator(); // $ExpectError
-	iterator( 2.0 ); // $ExpectError
-}