@stdlib/simulate-iter-awln 0.0.5 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/LICENSE

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

package/NOTICE

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

package/README.md

@@ -18,9 +18,20 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # iterawln
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > Create an [iterator][mdn-iterator-protocol] which introduces additive white Laplacian noise (AWLN).
 
@@ -212,6 +223,21 @@ while ( true ) {
 
 <!-- /.references -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/simulate-iter/awgn`][@stdlib/simulate/iter/awgn]</span><span class="delimiter">: </span><span class="description">create an iterator which introduces additive white Gaussian noise.</span>
+-   <span class="package-name">[`@stdlib/simulate-iter/awun`][@stdlib/simulate/iter/awun]</span><span class="delimiter">: </span><span class="description">create an iterator which introduces additive white uniform noise.</span>
+
+</section>
+
+<!-- /.related -->
+
 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
 
 
@@ -238,7 +264,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -251,22 +277,34 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/simulate-iter-awln.svg
 [npm-url]: https://npmjs.org/package/@stdlib/simulate-iter-awln
 
-[test-image]: https://github.com/stdlib-js/simulate-iter-awln/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/simulate-iter-awln/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/simulate-iter-awln/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/simulate-iter-awln/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/simulate-iter-awln/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/simulate-iter-awln?branch=main
 
+<!--
+
 [dependencies-image]: https://img.shields.io/david/stdlib-js/simulate-iter-awln.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/simulate-iter-awln/main
 
+-->
+
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
 
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/simulate-iter-awln/tree/deno
+[umd-url]: https://github.com/stdlib-js/simulate-iter-awln/tree/umd
+[esm-url]: https://github.com/stdlib-js/simulate-iter-awln/tree/esm
+[branches-url]: https://github.com/stdlib-js/simulate-iter-awln/blob/main/branches.md
+
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/simulate-iter-awln/main/LICENSE
 
 [mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
@@ -275,6 +313,14 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/random/base/mt19937]: https://www.npmjs.com/package/@stdlib/random-base-mt19937
 
+<!-- <related-links> -->
+
+[@stdlib/simulate/iter/awgn]: https://www.npmjs.com/package/@stdlib/simulate-iter-awgn
+
+[@stdlib/simulate/iter/awun]: https://www.npmjs.com/package/@stdlib/simulate-iter-awun
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";var c=function(u,n){return function(){return n||u((n={exports:{}}).exports,n),n.exports}};var m=c(function(_,f){
+function N(){return{copy:!0}}f.exports=N
+});var q=c(function(C,b){
+var i=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),h=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),A=require('@stdlib/assert-is-iterator-like/dist'),F=require('@stdlib/assert-is-positive-number/dist').isPrimitive,G=require('@stdlib/assert-is-plain-object/dist'),p=require('@stdlib/assert-is-function/dist'),j=require('@stdlib/assert-is-boolean/dist').isPrimitive,V=require('@stdlib/assert-is-uint32array/dist'),v=require('@stdlib/assert-has-own-property/dist'),k=require('@stdlib/utils-noop/dist'),U=require('@stdlib/utils-constant-function/dist'),d=require('@stdlib/symbol-iterator/dist'),W=require('@stdlib/random-base-laplace/dist').factory,o=require('@stdlib/error-tools-fmtprodmsg/dist'),z=require('@stdlib/constants-float64-sqrt-two/dist'),B=m();function y(u,n,e){var a,s,r,g;if(!A(u))throw new TypeError(o('0t73v',u));if(!F(n))throw new TypeError(o('0t772',n));if(s=B(),arguments.length>2){if(!G(e))throw new TypeError(o('0t78J',e));if(v(e,"copy")&&(s.copy=e.copy,!j(e.copy)))throw new TypeError(o('0t72o',"copy",e.copy));if(v(e,"prng")){if(!p(e.prng))throw new TypeError(o('0t76u',"prng",e.prng));s.prng=e.prng}else if(v(e,"state")){if(s.state=e.state,!V(e.state))throw new TypeError(o('0t76z',"state",e.state))}else if(v(e,"seed")&&(s.seed=e.seed,e.seed===void 0))throw new TypeError(o('0t774',"seed",e.seed))}return a=W(0,n/z,s),r={},i(r,"next",P),i(r,"return",E),d&&p(u[d])&&i(r,d,R),e&&e.prng?(i(r,"seed",null),i(r,"seedLength",null),h(r,"state",U(null),k),i(r,"stateLength",null),i(r,"byteLength",null),i(r,"PRNG",e.prng)):(l(r,"seed",w),l(r,"seedLength",L),h(r,"state",O,x),l(r,"stateLength",S),l(r,"byteLength",T),i(r,"PRNG",a.PRNG)),r;function w(){return a.seed}function L(){return a.seedLength}function S(){return a.stateLength}function T(){return a.byteLength}function O(){return a.state}function x(t){a.state=t}function P(){var t;return g?{done:!0}:(t=u.next(),t.done?(g=!0,t):(typeof t.value=="number"?t=t.value+a():t=NaN,{value:t,done:!1}))}function E(t){return g=!0,arguments.length?{value:t,done:!0}:{done:!0}}function R(){return y(u[d](),n,s)}}b.exports=y
+});var I=q();module.exports=I;
+/** @license Apache-2.0 */
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/defaults.js", "../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 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// MAIN //\n\n/**\n* Returns default options.\n*\n* @private\n* @returns {Object} default options\n*/\nfunction defaults() {\n\treturn {\n\t\t'copy': true\n\t};\n}\n\n\n// EXPORTS //\n\nmodule.exports = defaults;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2019 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 isIteratorLike = require( '@stdlib/assert-is-iterator-like' );\nvar isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive;\nvar isPlainObject = require( '@stdlib/assert-is-plain-object' );\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;\nvar isUint32Array = require( '@stdlib/assert-is-uint32array' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar noop = require( '@stdlib/utils-noop' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar iteratorSymbol = require( '@stdlib/symbol-iterator' );\nvar laplace = require( '@stdlib/random-base-laplace' ).factory;\nvar format = require( '@stdlib/string-format' );\nvar SQRT_TWO = require( '@stdlib/constants-float64-sqrt-two' );\nvar defaults = require( './defaults.js' );\n\n\n// MAIN //\n\n/**\n* Returns an iterator which introduces additive white Laplacian noise with standard deviation `sigma`.\n*\n* ## Method\n*\n* -   The variance of a Laplace (biexponential or double-exponential) distribution is given by\n*\n*     ```tex\n*     \\operatorname{Var} = 2b^2\n*     ```\n*\n*     where \\\\( b \\\\) is the distribution scale parameter.\n*\n* -   Accordingly, the standard deviation is then\n*\n*     ```tex\n*     \\sigma = b\\sqrt{2}\n*     ```\n*\n* -   Solving for \\\\( b \\\\), we derive the parameter transform necessary for generating a Laplacian random variable with standard deviation \\\\( \\sigma \\\\)\n*\n*     ```tex\n*     b = \\frac{\\sigma}{\\sqrt{2}}\n*     ```\n*\n* @param {Iterator} iterator - input iterator\n* @param {PositiveNumber} sigma - standard deviation of the noise\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers on the interval `[0,1)`\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* @throws {TypeError} first argument must be an iterator\n* @throws {TypeError} second argument must be a positive number\n* @throws {TypeError} third 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 iterSineWave = require( '@stdlib/simulate-iter-sine-wave' );\n*\n* var sine = iterSineWave({\n*     'iter': 100\n* });\n*\n* var it = iterawln( sine, 0.5 );\n*\n* var v = it.next().value;\n* // returns <number>\n*\n* v = it.next().value;\n* // returns <number>\n*\n* v = it.next().value;\n* // returns <number>\n*\n* // ...\n*/\nfunction iterawln( iterator, sigma, options ) {\n\tvar rlaplace;\n\tvar opts;\n\tvar iter;\n\tvar FLG;\n\tif ( !isIteratorLike( iterator ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be an iterator. Value: `%s`.', iterator ) );\n\t}\n\tif ( !isPositiveNumber( sigma ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a positive number. Value: `%s`.', sigma ) );\n\t}\n\topts = defaults();\n\tif ( arguments.length > 2 ) {\n\t\tif ( !isPlainObject( options ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an object. Value: `%s`.', options ) );\n\t\t}\n\t\tif ( hasOwnProp( options, 'copy' ) ) {\n\t\t\topts.copy = options.copy;\n\t\t\tif ( !isBoolean( options.copy ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'copy', options.copy ) );\n\t\t\t}\n\t\t}\n\t\tif ( hasOwnProp( options, 'prng' ) ) {\n\t\t\tif ( !isFunction( options.prng ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be a pseudorandom number generator function. Option: `%s`.', 'prng', options.prng ) );\n\t\t\t}\n\t\t\topts.prng = options.prng;\n\t\t}\n\t\t// If provided a PRNG, ignore the `state` option, as we don't support getting or setting PRNG state.\n\t\telse if ( hasOwnProp( options, 'state' ) ) {\n\t\t\topts.state = options.state;\n\t\t\tif ( !isUint32Array( options.state ) ) {\n\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be a Uint32Array. Option: `%s`.', 'state', options.state ) );\n\t\t\t}\n\t\t}\n\t\t// If provided a PRNG, ignore the `seed` option, as a `seed`, by itself, is insufficient to guarantee reproducibility. If provided a state, ignore the `seed` option, as a PRNG state should contain seed information.\n\t\telse if ( hasOwnProp( options, 'seed' ) ) {\n\t\t\topts.seed = options.seed;\n\t\t\tif ( options.seed === void 0 ) {\n\t\t\t\tthrow new TypeError( format( 'invalid option. `%s` option must be either a positive integer less than or equal to the maximum unsigned 32-bit integer or an array-like object containing integer values less than or equal to the maximum unsigned 32-bit integer. Option: `%s`.', 'seed', options.seed ) );\n\t\t\t}\n\t\t}\n\t}\n\trlaplace = laplace( 0.0, sigma/SQRT_TWO, opts );\n\n\t// Create an iterator protocol-compliant object:\n\titer = {};\n\tsetReadOnly( iter, 'next', next );\n\tsetReadOnly( iter, 'return', end );\n\n\t// If an environment supports `Symbol.iterator` and the provided iterator is iterable, make the iterator iterable:\n\tif ( iteratorSymbol && isFunction( iterator[ iteratorSymbol ] ) ) {\n\t\tsetReadOnly( iter, iteratorSymbol, factory );\n\t}\n\t// If we are provided an \"external\" PRNG, we don't support getting or setting PRNG state, as we'd need to check for compatible state value types, etc, entailing considerable complexity.\n\tif ( options && options.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\tsetReadOnly( iter, 'PRNG', options.prng );\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\tsetReadOnly( iter, 'PRNG', rlaplace.PRNG );\n\t}\n\treturn iter;\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 rlaplace.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 rlaplace.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 rlaplace.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 rlaplace.byteLength;\n\t}\n\n\t/**\n\t* Returns the current PRNG state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rlaplace.state;\n\t}\n\n\t/**\n\t* Sets the PRNG 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\trlaplace.state = s;\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 next() {\n\t\tvar v;\n\t\tif ( FLG ) {\n\t\t\treturn {\n\t\t\t\t'done': true\n\t\t\t};\n\t\t}\n\t\tv = iterator.next();\n\t\tif ( v.done ) {\n\t\t\tFLG = true;\n\t\t\treturn v;\n\t\t}\n\t\tif ( typeof v.value === 'number' ) {\n\t\t\tv = v.value + rlaplace();\n\t\t} else {\n\t\t\tv = NaN;\n\t\t}\n\t\treturn {\n\t\t\t'value': v,\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 iterawln( iterator[ iteratorSymbol ](), sigma, opts );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = iterawln;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2019 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 introduces additive white Laplacian noise (AWLN).\n*\n* @module @stdlib/simulate-iter-awln\n*\n* @example\n* var iterSineWave = require( '@stdlib/simulate-iter-sine-wave' );\n* var iterawln = require( '@stdlib/simulate-iter-awln' );\n*\n* var sine = iterSineWave({\n*     'iter': 100\n* });\n*\n* var it = iterawln( sine, 0.5 );\n*\n* var v = it.next().value;\n* // returns <number>\n*\n* v = it.next().value;\n* // returns <number>\n*\n* v = it.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,cA4BA,SAASC,GAAW,CACnB,MAAO,CACN,KAAQ,EACT,CACD,CAKAD,EAAO,QAAUC,ICrCjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAiB,QAAS,iCAAkC,EAC5DC,EAAmB,QAAS,mCAAoC,EAAE,YAClEC,EAAgB,QAAS,gCAAiC,EAC1DC,EAAa,QAAS,4BAA6B,EACnDC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAgB,QAAS,+BAAgC,EACzDC,EAAa,QAAS,iCAAkC,EACxDC,EAAO,QAAS,oBAAqB,EACrCC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAiB,QAAS,yBAA0B,EACpDC,EAAU,QAAS,6BAA8B,EAAE,QACnDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,IAgEf,SAASC,EAAUC,EAAUC,EAAOC,EAAU,CAC7C,IAAIC,EACAC,EACAC,EACAC,EACJ,GAAK,CAACrB,EAAgBe,CAAS,EAC9B,MAAM,IAAI,UAAWJ,EAAQ,qEAAsEI,CAAS,CAAE,EAE/G,GAAK,CAACd,EAAkBe,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,4EAA6EK,CAAM,CAAE,EAGnH,GADAG,EAAON,EAAS,EACX,UAAU,OAAS,EAAI,CAC3B,GAAK,CAACX,EAAee,CAAQ,EAC5B,MAAM,IAAI,UAAWN,EAAQ,mEAAoEM,CAAQ,CAAE,EAE5G,GAAKX,EAAYW,EAAS,MAAO,IAChCE,EAAK,KAAOF,EAAQ,KACf,CAACb,EAAWa,EAAQ,IAAK,GAC7B,MAAM,IAAI,UAAWN,EAAQ,+DAAgE,OAAQM,EAAQ,IAAK,CAAE,EAGtH,GAAKX,EAAYW,EAAS,MAAO,EAAI,CACpC,GAAK,CAACd,EAAYc,EAAQ,IAAK,EAC9B,MAAM,IAAI,UAAWN,EAAQ,8FAA+F,OAAQM,EAAQ,IAAK,CAAE,EAEpJE,EAAK,KAAOF,EAAQ,IACrB,SAEUX,EAAYW,EAAS,OAAQ,GAEtC,GADAE,EAAK,MAAQF,EAAQ,MAChB,CAACZ,EAAeY,EAAQ,KAAM,EAClC,MAAM,IAAI,UAAWN,EAAQ,mEAAoE,QAASM,EAAQ,KAAM,CAAE,UAIlHX,EAAYW,EAAS,MAAO,IACrCE,EAAK,KAAOF,EAAQ,KACfA,EAAQ,OAAS,QACrB,MAAM,IAAI,UAAWN,EAAQ,qPAAsP,OAAQM,EAAQ,IAAK,CAAE,CAG7S,CACA,OAAAC,EAAWR,EAAS,EAAKM,EAAMJ,EAAUO,CAAK,EAG9CC,EAAO,CAAC,EACRvB,EAAauB,EAAM,OAAQE,CAAK,EAChCzB,EAAauB,EAAM,SAAUG,CAAI,EAG5Bd,GAAkBN,EAAYY,EAAUN,CAAe,CAAE,GAC7DZ,EAAauB,EAAMX,EAAgBe,CAAQ,EAGvCP,GAAWA,EAAQ,MACvBpB,EAAauB,EAAM,OAAQ,IAAK,EAChCvB,EAAauB,EAAM,aAAc,IAAK,EACtCrB,EAAsBqB,EAAM,QAASZ,EAAkB,IAAK,EAAGD,CAAK,EACpEV,EAAauB,EAAM,cAAe,IAAK,EACvCvB,EAAauB,EAAM,aAAc,IAAK,EACtCvB,EAAauB,EAAM,OAAQH,EAAQ,IAAK,IAExCnB,EAAqBsB,EAAM,OAAQK,CAAQ,EAC3C3B,EAAqBsB,EAAM,aAAcM,CAAc,EACvD3B,EAAsBqB,EAAM,QAASO,EAAUC,CAAS,EACxD9B,EAAqBsB,EAAM,cAAeS,CAAe,EACzD/B,EAAqBsB,EAAM,aAAcU,CAAa,EACtDjC,EAAauB,EAAM,OAAQF,EAAS,IAAK,GAEnCE,EAQP,SAASK,GAAU,CAClB,OAAOP,EAAS,IACjB,CAQA,SAASQ,GAAgB,CACxB,OAAOR,EAAS,UACjB,CAQA,SAASW,GAAiB,CACzB,OAAOX,EAAS,WACjB,CAQA,SAASY,GAAe,CACvB,OAAOZ,EAAS,UACjB,CAQA,SAASS,GAAW,CACnB,OAAOT,EAAS,KACjB,CASA,SAASU,EAAUG,EAAI,CACtBb,EAAS,MAAQa,CAClB,CAQA,SAAST,GAAO,CACf,IAAIU,EACJ,OAAKX,EACG,CACN,KAAQ,EACT,GAEDW,EAAIjB,EAAS,KAAK,EACbiB,EAAE,MACNX,EAAM,GACCW,IAEH,OAAOA,EAAE,OAAU,SACvBA,EAAIA,EAAE,MAAQd,EAAS,EAEvBc,EAAI,IAEE,CACN,MAASA,EACT,KAAQ,EACT,GACD,CASA,SAAST,EAAKU,EAAQ,CAErB,OADAZ,EAAM,GACD,UAAU,OACP,CACN,MAASY,EACT,KAAQ,EACT,EAEM,CACN,KAAQ,EACT,CACD,CAQA,SAAST,GAAU,CAClB,OAAOV,EAAUC,EAAUN,CAAe,EAAE,EAAGO,EAAOG,CAAK,CAC5D,CACD,CAKAvB,EAAO,QAAUkB,ICzPjB,IAAIoB,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_defaults", "__commonJSMin", "exports", "module", "defaults", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "isIteratorLike", "isPositiveNumber", "isPlainObject", "isFunction", "isBoolean", "isUint32Array", "hasOwnProp", "noop", "constantFunction", "iteratorSymbol", "laplace", "format", "SQRT_TWO", "defaults", "iterawln", "iterator", "sigma", "options", "rlaplace", "opts", "iter", "FLG", "next", "end", "factory", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "s", "v", "value", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 

package/lib/defaults.js

@@ -0,0 +1,38 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Returns default options.
+*
+* @private
+* @returns {Object} default options
+*/
+function defaults() {
+	return {
+		'copy': true
+	};
+}
+
+
+// EXPORTS //
+
+module.exports = defaults;

package/lib/index.js

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

package/lib/main.js

@@ -30,13 +30,13 @@ var isFunction = require( '@stdlib/assert-is-function' );
 var isBoolean = require( '@stdlib/assert-is-boolean' ).isPrimitive;
 var isUint32Array = require( '@stdlib/assert-is-uint32array' );
 var hasOwnProp = require( '@stdlib/assert-has-own-property' );
-var copy = require( '@stdlib/utils-copy' );
 var noop = require( '@stdlib/utils-noop' );
 var constantFunction = require( '@stdlib/utils-constant-function' );
 var iteratorSymbol = require( '@stdlib/symbol-iterator' );
 var laplace = require( '@stdlib/random-base-laplace' ).factory;
+var format = require( '@stdlib/string-format' );
 var SQRT_TWO = require( '@stdlib/constants-float64-sqrt-two' );
-var DEFAULTS = require( './defaults.json' );
+var defaults = require( './defaults.js' );
 
 
 // MAIN //
@@ -106,25 +106,25 @@ function iterawln( iterator, sigma, options ) {
 	var iter;
 	var FLG;
 	if ( !isIteratorLike( iterator ) ) {
-		throw new TypeError( 'invalid argument. First argument must be an iterator. Value: `' + iterator + '`.' );
+		throw new TypeError( format( 'invalid argument. First argument must be an iterator. Value: `%s`.', iterator ) );
 	}
 	if ( !isPositiveNumber( sigma ) ) {
-		throw new TypeError( 'invalid argument. Second argument must be a positive number. Value: `' + sigma + '`.' );
+		throw new TypeError( format( 'invalid argument. Second argument must be a positive number. Value: `%s`.', sigma ) );
 	}
-	opts = copy( DEFAULTS );
+	opts = defaults();
 	if ( arguments.length > 2 ) {
 		if ( !isPlainObject( options ) ) {
-			throw new TypeError( 'invalid argument. Third argument must be an object. Value: `' + options + '`.' );
+			throw new TypeError( format( 'invalid argument. Third argument must be an object. Value: `%s`.', options ) );
 		}
 		if ( hasOwnProp( options, 'copy' ) ) {
 			opts.copy = options.copy;
 			if ( !isBoolean( options.copy ) ) {
-				throw new TypeError( 'invalid option. `copy` option must be a boolean. Option: `' + options.copy + '`.' );
+				throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'copy', options.copy ) );
 			}
 		}
 		if ( hasOwnProp( options, 'prng' ) ) {
 			if ( !isFunction( options.prng ) ) {
-				throw new TypeError( 'invalid option. `prng` option must be a pseudorandom number generator function. Option: `' + options.prng + '`.' );
+				throw new TypeError( format( 'invalid option. `%s` option must be a pseudorandom number generator function. Option: `%s`.', 'prng', options.prng ) );
 			}
 			opts.prng = options.prng;
 		}
@@ -132,14 +132,14 @@ function iterawln( iterator, sigma, options ) {
 		else if ( hasOwnProp( options, 'state' ) ) {
 			opts.state = options.state;
 			if ( !isUint32Array( options.state ) ) {
-				throw new TypeError( 'invalid option. `state` option must be a Uint32Array. Option: `' + options.state + '`.' );
+				throw new TypeError( format( 'invalid option. `%s` option must be a Uint32Array. Option: `%s`.', 'state', options.state ) );
 			}
 		}
 		// If provided a PRNG, ignore the `seed` option, as a `seed`, by itself, is insufficient to guarantee reproducibility. If provided a state, ignore the `seed` option, as a PRNG state should contain seed information.
 		else if ( hasOwnProp( options, 'seed' ) ) {
 			opts.seed = options.seed;
 			if ( options.seed === void 0 ) {
-				throw new TypeError( 'invalid option. `seed` option must be either a positive integer less than or equal to the maximum unsigned 32-bit integer or an array-like object containing integer values less than or equal to the maximum unsigned 32-bit integer. Option: `' + options.seed + '`.' );
+				throw new TypeError( format( 'invalid option. `%s` option must be either a positive integer less than or equal to the maximum unsigned 32-bit integer or an array-like object containing integer values less than or equal to the maximum unsigned 32-bit integer. Option: `%s`.', 'seed', options.seed ) );
 			}
 		}
 	}
@@ -240,27 +240,26 @@ function iterawln( iterator, sigma, options ) {
 	* @returns {Object} iterator protocol-compliant object
 	*/
 	function next() {
-		var out;
 		var v;
 		if ( FLG ) {
 			return {
 				'done': true
 			};
 		}
-		out = {};
 		v = iterator.next();
-		if ( typeof v.value === 'number' ) {
-			out.value = v.value + rlaplace();
-		} else if ( hasOwnProp( v, 'value' ) ) {
-			out.value = NaN;
-		}
 		if ( v.done ) {
 			FLG = true;
-			out.done = true;
+			return v;
+		}
+		if ( typeof v.value === 'number' ) {
+			v = v.value + rlaplace();
 		} else {
-			out.done = false;
+			v = NaN;
 		}
-		return out;
+		return {
+			'value': v,
+			'done': false
+		};
 	}
 
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/simulate-iter-awln",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "Create an iterator which introduces additive white Laplacian noise.",
   "license": "Apache-2.0",
   "author": {
@@ -37,38 +37,39 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.x",
-    "@stdlib/assert-is-boolean": "^0.0.x",
-    "@stdlib/assert-is-function": "^0.0.x",
-    "@stdlib/assert-is-iterator-like": "^0.0.x",
-    "@stdlib/assert-is-plain-object": "^0.0.x",
-    "@stdlib/assert-is-positive-number": "^0.0.x",
-    "@stdlib/assert-is-uint32array": "^0.0.x",
-    "@stdlib/constants-float64-sqrt-two": "^0.0.x",
-    "@stdlib/random-base-laplace": "^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-boolean": "^0.1.0",
+    "@stdlib/assert-is-function": "^0.1.0",
+    "@stdlib/assert-is-iterator-like": "^0.1.0",
+    "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/assert-is-positive-number": "^0.1.0",
+    "@stdlib/assert-is-uint32array": "^0.1.0",
+    "@stdlib/constants-float64-sqrt-two": "^0.1.0",
+    "@stdlib/random-base-laplace": "^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-float64": "^0.0.x",
-    "@stdlib/array-to-iterator": "^0.0.x",
-    "@stdlib/array-uint32": "^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-shuffle": "^0.0.x",
-    "@stdlib/random-iter-randu": "^0.0.x",
-    "@stdlib/simulate-iter-sine-wave": "^0.0.x",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/array-to-iterator": "^0.1.0",
+    "@stdlib/array-uint32": "^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-shuffle": "^0.0.6",
+    "@stdlib/random-iter-randu": "^0.0.6",
+    "@stdlib/simulate-iter-sine-wave": "^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",
@@ -107,7 +108,7 @@
     "iter"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,85 +0,0 @@
-
-{{alias}}( iterator, sigma[, options] )
-    Returns an iterator which introduces additive white Laplacian noise (AWLN)
-    with standard deviation `sigma`.
-
-    If an environment supports Symbol.iterator and the provided iterator is
-    iterable, the returned iterator is iterable.
-
-    Parameters
-    ----------
-    iterator: Object
-        Input iterator.
-
-    sigma: number
-        Standard deviation of the noise.
-
-    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.
-
-    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
-        Pseudorandom random number generator state.
-
-    iterator.stateLength: integer|null
-        Length of generator state.
-
-    iterator.byteLength: integer|null
-        Size (in bytes) of generator state.
-
-    Examples
-    --------
-    > var src = {{alias:@stdlib/simulate/iter/sine-wave}}();
-    > var it = {{alias}}( src, 0.5 );
-    > var v = it.next().value
-    <number>
-    > v = it.next().value
-    <number>
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,150 +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 iterawln = require( './index' );
-
-/**
-* Returns an iterator protocol-compliant object.
-*
-* @returns iterator protocol-compliant object
-*/
-function iterator() {
-	return {
-		'next': next
-	};
-
-	/**
-	* Implements the iterator protocol `next` method.
-	*
-	* @returns iterator protocol-compliant object
-	*/
-	function next() {
-		return {
-			'value': true,
-			'done': false
-		};
-	}
-}
-
-
-// TESTS //
-
-// The function returns an iterator...
-{
-	iterawln( iterator(), 0.2 ); // $ExpectType ExtendedIterator
-	iterawln( iterator(), 0.2, {} ); // $ExpectType ExtendedIterator
-	iterawln( iterator(), 0.2, { 'seed': 12345 } ); // $ExpectType ExtendedIterator
-}
-
-// The compiler throws an error if the function is provided a first argument which is not an iterator protocol-compliant object...
-{
-	iterawln( '5', 1.0 ); // $ExpectError
-	iterawln( 5, 1.0 ); // $ExpectError
-	iterawln( true, 1.0 ); // $ExpectError
-	iterawln( false, 1.0 ); // $ExpectError
-	iterawln( null, 1.0 ); // $ExpectError
-	iterawln( undefined, 1.0 ); // $ExpectError
-	iterawln( [], 1.0 ); // $ExpectError
-	iterawln( {}, 1.0 ); // $ExpectError
-	iterawln( ( x: number ): number => x, 1.0 ); // $ExpectError
-
-	iterawln( '5', 1.0, {} ); // $ExpectError
-	iterawln( 5, 1.0, {} ); // $ExpectError
-	iterawln( true, 1.0, {} ); // $ExpectError
-	iterawln( false, 1.0, {} ); // $ExpectError
-	iterawln( null, 1.0, {} ); // $ExpectError
-	iterawln( undefined, 1.0, {} ); // $ExpectError
-	iterawln( [], 1.0, {} ); // $ExpectError
-	iterawln( {}, 1.0, {} ); // $ExpectError
-	iterawln( ( x: number ): number => x, 1.0, {} ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a number...
-{
-	iterawln( iterator(), '5' ); // $ExpectError
-	iterawln( iterator(), true ); // $ExpectError
-	iterawln( iterator(), false ); // $ExpectError
-	iterawln( iterator(), null ); // $ExpectError
-	iterawln( iterator(), undefined ); // $ExpectError
-	iterawln( iterator(), [] ); // $ExpectError
-	iterawln( iterator(), {} ); // $ExpectError
-	iterawln( iterator(), ( x: number ): number => x ); // $ExpectError
-
-	iterawln( iterator(), '5', {} ); // $ExpectError
-	iterawln( iterator(), true, {} ); // $ExpectError
-	iterawln( iterator(), false, {} ); // $ExpectError
-	iterawln( iterator(), null, {} ); // $ExpectError
-	iterawln( iterator(), undefined, {} ); // $ExpectError
-	iterawln( iterator(), [], {} ); // $ExpectError
-	iterawln( iterator(), {}, {} ); // $ExpectError
-	iterawln( iterator(), ( x: number ): number => x, {} ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not an object...
-{
-	iterawln( iterator(), 1.0, null ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid `seed` option...
-{
-	iterawln( iterator(), 1.0, { 'seed': '5' } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'seed': true } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'seed': false } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'seed': null } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'seed': {} } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'seed': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid `prng` option...
-{
-	iterawln( iterator(), 1.0, { 'prng': '5' } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'prng': 5 } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'prng': true } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'prng': false } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'prng': null } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'prng': [] } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'prng': {} } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid `state` option...
-{
-	iterawln( iterator(), 1.0, { 'state': '5' } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': 5 } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': true } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': false } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': null } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': [] } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': {} } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'state': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an invalid `copy` option...
-{
-	iterawln( iterator(), 1.0, { 'copy': '5' } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'copy': 5 } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'copy': null } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'copy': [] } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'copy': {} } ); // $ExpectError
-	iterawln( iterator(), 1.0, { 'copy': ( x: number ): number => x } ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided insufficient arguments...
-{
-	iterawln(); // $ExpectError
-	iterawln( iterator() ); // $ExpectError
-}

package/lib/defaults.json

@@ -1,3 +0,0 @@
-{
-	"copy": true
-}