@stdlib/random-streams-improved-ziggurat 0.0.6 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/NOTICE +1 -1
  2. package/README.md +46 -4
  3. package/package.json +1 -1
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2021 The Stdlib Authors.
1
+ Copyright (c) 2016-2022 The Stdlib Authors.
package/README.md CHANGED
@@ -20,7 +20,7 @@ limitations under the License.
20
20
 
21
21
  # Standard Normal Random Numbers
22
22
 
23
- [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
23
+ [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
24
24
 
25
25
  > Create a [readable stream][readable-stream] for generating pseudorandom numbers drawn from a [standard normal][normal] distribution using the [Improved Ziggurat][@stdlib/random/base/improved-ziggurat] algorithm.
26
26
 
@@ -467,6 +467,8 @@ npm install -g @stdlib/random-streams-improved-ziggurat
467
467
  ```
468
468
 
469
469
  </section>
470
+ <!-- CLI usage documentation. -->
471
+
470
472
 
471
473
  <section class="usage">
472
474
 
@@ -537,6 +539,25 @@ $ random-improved-ziggurat -n 10 --seed 1234
537
539
 
538
540
  <!-- /.references -->
539
541
 
542
+ <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
543
+
544
+ <section class="related">
545
+
546
+ * * *
547
+
548
+ ## See Also
549
+
550
+ - <span class="package-name">[`@stdlib/random/base/improved-ziggurat`][@stdlib/random/base/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">normally distributed pseudorandom numbers using the improved Ziggurat method.</span>
551
+ - <span class="package-name">[`@stdlib/random/iter/improved-ziggurat`][@stdlib/random/iter/improved-ziggurat]</span><span class="delimiter">: </span><span class="description">create an iterator for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.</span>
552
+ - <span class="package-name">[`@stdlib/random/streams/box-muller`][@stdlib/random/streams/box-muller]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Box-Muller transform.</span>
553
+ - <span class="package-name">[`@stdlib/random/streams/randn`][@stdlib/random/streams/randn]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution.</span>
554
+
555
+ </section>
556
+
557
+ <!-- /.related -->
558
+
559
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
560
+
540
561
 
541
562
  <section class="main-repo" >
542
563
 
@@ -561,7 +582,7 @@ See [LICENSE][stdlib-license].
561
582
 
562
583
  ## Copyright
563
584
 
564
- Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
585
+ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
565
586
 
566
587
  </section>
567
588
 
@@ -580,9 +601,20 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
580
601
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-improved-ziggurat/main.svg
581
602
  [coverage-url]: https://codecov.io/github/stdlib-js/random-streams-improved-ziggurat?branch=main
582
603
 
604
+ <!--
605
+
583
606
  [dependencies-image]: https://img.shields.io/david/stdlib-js/random-streams-improved-ziggurat.svg
584
607
  [dependencies-url]: https://david-dm.org/stdlib-js/random-streams-improved-ziggurat/main
585
608
 
609
+ -->
610
+
611
+ [umd]: https://github.com/umdjs/umd
612
+ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
613
+
614
+ [deno-url]: https://github.com/stdlib-js/random-streams-improved-ziggurat/tree/deno
615
+ [umd-url]: https://github.com/stdlib-js/random-streams-improved-ziggurat/tree/umd
616
+ [esm-url]: https://github.com/stdlib-js/random-streams-improved-ziggurat/tree/esm
617
+
586
618
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
587
619
  [chat-url]: https://gitter.im/stdlib-js/stdlib/
588
620
 
@@ -602,14 +634,24 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
602
634
 
603
635
  [@stdlib/array/uint32]: https://www.npmjs.com/package/@stdlib/array-uint32
604
636
 
605
- [@stdlib/random/base/improved-ziggurat]: https://www.npmjs.com/package/@stdlib/random-base-improved-ziggurat
606
-
607
637
  [@doornik:2005]: https://www.doornik.com/research/ziggurat.pdf
608
638
 
609
639
  [@marsaglia:2000b]: http://dx.doi.org/10.18637/jss.v005.i08
610
640
 
611
641
  [@marsaglia:1964b]: https://doi.org/10.1080/00401706.1964.10490150
612
642
 
643
+ <!-- <related-links> -->
644
+
645
+ [@stdlib/random/base/improved-ziggurat]: https://www.npmjs.com/package/@stdlib/random-base-improved-ziggurat
646
+
647
+ [@stdlib/random/iter/improved-ziggurat]: https://www.npmjs.com/package/@stdlib/random-iter-improved-ziggurat
648
+
649
+ [@stdlib/random/streams/box-muller]: https://www.npmjs.com/package/@stdlib/random-streams-box-muller
650
+
651
+ [@stdlib/random/streams/randn]: https://www.npmjs.com/package/@stdlib/random-streams-randn
652
+
653
+ <!-- </related-links> -->
654
+
613
655
  </section>
614
656
 
615
657
  <!-- /.links -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/random-streams-improved-ziggurat",
3
- "version": "0.0.6",
3
+ "version": "0.0.7",
4
4
  "description": "Create a readable stream for generating pseudorandom numbers drawn from a standard normal distribution using the Improved Ziggurat algorithm.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {