@stdlib/random-streams-mt19937-cli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/.github/workflows/publish_cli.yml +165 -0
  2. package/CONTRIBUTORS +39 -0
  3. package/LICENSE +177 -0
  4. package/NOTICE +1 -0
  5. package/README.md +256 -0
  6. package/bin/cli +186 -0
  7. package/docs/usage.txt +16 -0
  8. package/etc/cli_opts.json +25 -0
  9. package/package.json +86 -0
  10. package/test/fixtures/bad_state.txt +0 -0
  11. package/test/fixtures/state.txt +0 -0
  12. package/test/fixtures/write_error.js.txt +39 -0
  13. package/test/test.cli.js +499 -0
package/.github/workflows/publish_cli.yml ADDED
@@ -0,0 +1,165 @@
1
+ #/
2
+ # @license Apache-2.0
3
+ #
4
+ # Copyright (c) 2023 The Stdlib Authors.
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #/
18
+
19
+ # Workflow name:
20
+ name: publish_cli
21
+
22
+ # Workflow triggers:
23
+ on:
24
+ # Allow the workflow to be manually run:
25
+ workflow_dispatch:
26
+ # Workflow inputs:
27
+ inputs:
28
+ version:
29
+ description: 'Version Increment'
30
+ type: choice
31
+ default: 'none'
32
+ options:
33
+ - 'none'
34
+ - 'major'
35
+ - 'minor'
36
+ - 'patch'
37
+ - 'premajor'
38
+ - 'preminor'
39
+ - 'prepatch'
40
+ - 'prerelease'
41
+
42
+ # Workflow jobs:
43
+ jobs:
44
+
45
+ # Define job to publish package to npm:
46
+ publish:
47
+
48
+ # Define display name:
49
+ name: 'Publish CLI package to npm'
50
+
51
+ # Define the type of virtual host machine on which to run the job:
52
+ runs-on: ubuntu-latest
53
+
54
+ # Define environment variables:
55
+ env:
56
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
57
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
58
+
59
+ # Define the sequence of job steps...
60
+ steps:
61
+
62
+ # Checkout cli branch:
63
+ - name: 'Checkout cli branch'
64
+ uses: actions/checkout@v3
65
+ with:
66
+ ref: cli
67
+
68
+ # Install Node.js:
69
+ - name: 'Install Node.js'
70
+ uses: actions/setup-node@v3
71
+ with:
72
+ node-version: 16
73
+ timeout-minutes: 5
74
+
75
+ # Configure git:
76
+ - name: 'Configure git'
77
+ run: |
78
+ git config --local user.email "noreply@stdlib.io"
79
+ git config --local user.name "stdlib-bot"
80
+
81
+ # Increment package version (if requested):
82
+ - name: 'Increment package version (if requested)'
83
+ if: ${{ github.event.inputs.version != 'none' }}
84
+ run: |
85
+ # Save NPM_TOKEN to user's .npmrc:
86
+ echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
87
+
88
+ # Increment package version:
89
+ npm version ${{ github.event.inputs.version }} --no-git-tag-version
90
+
91
+ # Define variable for new version:
92
+ NEW_VERSION=$(node -p "require('./package.json').version")
93
+
94
+ # Replace branch in README.md link definitions for badges with the new version:
95
+ find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g"
96
+
97
+ # Create a new commit and tag:
98
+ git add package.json README.md
99
+ git commit -m "Release v${NEW_VERSION}"
100
+ git tag -a "v${NEW_VERSION}-cli" -m "Release v${NEW_VERSION}"
101
+
102
+ # Push changes to GitHub:
103
+ SLUG=${{ github.repository }}
104
+ git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" --follow-tags
105
+
106
+ # Replace GitHub MathJax equations with SVGs:
107
+ - name: 'Replace GitHub MathJax equations with SVGs'
108
+ run: |
109
+ find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g'
110
+ find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/<!-- <div class="equation"(.*)(<\/div>\s*-->)/<div class="equation"$1<\/div>/sg'
111
+
112
+ # Replace GitHub links to individual packages with npm links:
113
+ - name: 'Replace all GitHub links to individual packages with npm links'
114
+ run: |
115
+ find . -type f -name '*.md' -print0 | xargs -0 sed -Ei '/tree\/main/b; s/@stdlib\/([^:]*)\]: https:\/\/github.com\/stdlib-js/@stdlib\/\1\]: https:\/\/www.npmjs.com\/package\/@stdlib/g'
116
+ SLUG=${{ github.repository }}
117
+ ESCAPED_SLUG=${SLUG//\//\\\/}
118
+ REPO=${SLUG#*/}
119
+ find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/https:\/\/github.com\/${ESCAPED_SLUG}\/tree\/main/https:\/\/www.npmjs.com\/package\/@stdlib\/${REPO}/g"
120
+
121
+ # Publish package to npm:
122
+ - name: 'Publish package to npm'
123
+ uses: JS-DevTools/npm-publish@v2
124
+ with:
125
+ token: ${{ secrets.NPM_TOKEN }}
126
+ access: public
127
+
128
+ # Discard any uncommitted changes:
129
+ - name: 'Discard any uncommitted changes'
130
+ run: |
131
+ git reset --hard
132
+
133
+ # Send status to Slack channel if job fails:
134
+ - name: 'Send status to Slack channel in case of failure'
135
+ uses: act10ns/slack@v2
136
+ with:
137
+ status: ${{ job.status }}
138
+ steps: ${{ toJson(steps) }}
139
+ channel: '#npm-ci'
140
+ if: failure()
141
+
142
+ # Define job to cancel any running or queued workflow runs...
143
+ cancel:
144
+
145
+ # Define the type of virtual host machine on which to run the job:
146
+ runs-on: ubuntu-latest
147
+
148
+ # Time out the job after 3 minutes:
149
+ timeout-minutes: 3
150
+
151
+ # Define the sequence of job steps...
152
+ steps:
153
+
154
+ # Cancel any running or queued workflow runs:
155
+ - name: 'Cancel running or queued workflow runs'
156
+ uses: styfle/cancel-workflow-action@0.11.0
157
+ with:
158
+ workflow_id: >-
159
+ benchmark.yml,
160
+ examples.yml,
161
+ test.yml,
162
+ test_coverage.yml,
163
+ test_install.yml,
164
+ publish.yml
165
+ access_token: ${{ github.token }}
package/CONTRIBUTORS ADDED
@@ -0,0 +1,39 @@
1
+ # This file is generated by tools/scripts/update_contributors.
2
+ #
3
+ # Contributors listed in alphabetical order.
4
+
5
+ Ali Salesi <ali_sal1381@yahoo.com>
6
+ Amit Jimiwal <amitjimiwal45@gmail.com>
7
+ Athan Reines <kgryte@gmail.com>
8
+ Brendan Graetz <bguiz@users.noreply.github.com>
9
+ Bruno Fenzl <brunofenzl@gmail.com>
10
+ Christopher Dambamuromo <chridam@gmail.com>
11
+ Dan Rose <danoftheroses@gmail.com>
12
+ Dominik Moritz <domoritz@gmail.com>
13
+ Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
14
+ Frank Kovacs <fran70kk@gmail.com>
15
+ Harshita Kalani <harshitakalani02@gmail.com>
16
+ James Gelok <jdgelok@gmail.com>
17
+ Jithin KS <jithinks112@gmail.com>
18
+ Joey Reed <joeyrreed@gmail.com>
19
+ Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
20
+ Joris Labie <joris.labie1@gmail.com>
21
+ Justin Dennison <justin1dennison@gmail.com>
22
+ Marcus Fantham <mfantham@users.noreply.github.com>
23
+ Matt Cochrane <matthew.cochrane.eng@gmail.com>
24
+ Milan Raj <rajsite@users.noreply.github.com>
25
+ Momtchil Momtchev <momtchil@momtchev.com>
26
+ Naresh Jagadeesan <naresh.naresh000@gmail.com>
27
+ Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
28
+ Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
29
+ Philipp Burckhardt <pburckhardt@outlook.com>
30
+ Pranav Goswami <goswami.4@iitj.ac.in>
31
+ Ricky Reusser <rsreusser@gmail.com>
32
+ Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
33
+ Ryan Seal <splrk@users.noreply.github.com>
34
+ Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
35
+ Shraddheya Shendre <shendreshraddheya@gmail.com>
36
+ Stephannie Jiménez Gacha <steff456@hotmail.com>
37
+ Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
38
+ orimiles5 <97595296+orimiles5@users.noreply.github.com>
39
+ rei2hu <reimu@reimu.ws>
package/LICENSE ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
package/NOTICE ADDED
@@ -0,0 +1 @@
1
+ Copyright (c) 2016-2023 The Stdlib Authors.
package/README.md ADDED
@@ -0,0 +1,256 @@
1
+ <!--
2
+
3
+ @license Apache-2.0
4
+
5
+ Copyright (c) 2018 The Stdlib Authors.
6
+
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at
10
+
11
+ http://www.apache.org/licenses/LICENSE-2.0
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
18
+
19
+ -->
20
+
21
+
22
+ <details>
23
+ <summary>
24
+ About stdlib...
25
+ </summary>
26
+ <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
27
+ <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
28
+ <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
29
+ <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
30
+ </details>
31
+
32
+ # MT19937
33
+
34
+ [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
35
+
36
+ > Create a [readable stream][readable-stream] for a 32-bit [Mersenne Twister][@stdlib/random/base/mt19937] pseudorandom number generator.
37
+
38
+
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <!-- Section for describing a command-line interface. -->
47
+
48
+
49
+
50
+ <section class="cli">
51
+
52
+
53
+
54
+ <section class="installation">
55
+
56
+ ## Installation
57
+
58
+ To use as a general utility, install the CLI package globally
59
+
60
+ ```bash
61
+ npm install -g @stdlib/random-streams-mt19937-cli
62
+ ```
63
+
64
+ </section>
65
+ <!-- CLI usage documentation. -->
66
+
67
+
68
+ <section class="usage">
69
+
70
+ ## Usage
71
+
72
+ ```text
73
+ Usage: random-mt19937 [options]
74
+
75
+ Options:
76
+
77
+ -h, --help Print this message.
78
+ -V, --version Print the package version.
79
+ --sep sep Separator used to join streamed data. Default: '\n'.
80
+ -n, --iter iterations Number of pseudorandom numbers.
81
+ --normalized Generate pseudorandom numbers on the interval [0,1).
82
+ --seed seed Pseudorandom number generator seed.
83
+ --state filepath Path to a file containing the pseudorandom number
84
+ generator state.
85
+ --snapshot filepath Output file path for saving the pseudorandom number
86
+ generator state upon exit.
87
+ ```
88
+
89
+ </section>
90
+
91
+ <!-- /.usage -->
92
+
93
+ <!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
94
+
95
+ <section class="notes">
96
+
97
+ ## Notes
98
+
99
+ - In accordance with POSIX convention, a trailing newline is **always** appended to generated output prior to exit.
100
+ - Specifying a "snapshot" file path is useful when wanting to resume pseudorandom number generation due to, e.g., a downstream failure in an analysis pipeline. Before exiting, the process will store the pseudorandom number generator state in a file specified according to a provided file path. Upon loading a snapshot (state), the process will generate pseudorandom numbers starting from the loaded state, thus avoiding having to seed and replay an entire analysis.
101
+
102
+ </section>
103
+
104
+ <!-- /.notes -->
105
+
106
+ <!-- CLI usage examples. -->
107
+
108
+ <section class="examples">
109
+
110
+ ## Examples
111
+
112
+ ```bash
113
+ $ random-mt19937 -n 10 --seed 1234
114
+ ```
115
+
116
+ </section>
117
+
118
+ <!-- /.examples -->
119
+
120
+ </section>
121
+
122
+ <!-- /.cli -->
123
+
124
+ * * *
125
+
126
+ <section class="references">
127
+
128
+ ## References
129
+
130
+ - Matsumoto, Makoto, and Takuji Nishimura. 1998. "Mersenne Twister: A 623-dimensionally Equidistributed Uniform Pseudo-random Number Generator." _ACM Transactions on Modeling and Computer Simulation_ 8 (1). New York, NY, USA: ACM: 3–30. doi:[10.1145/272991.272995][@matsumoto:1998a].
131
+ - Harase, Shin. 2017. "Conversion of Mersenne Twister to double-precision floating-point numbers." _ArXiv_ abs/1708.06018 (September). <https://arxiv.org/abs/1708.06018>.
132
+
133
+ </section>
134
+
135
+ <!-- /.references -->
136
+
137
+ <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
138
+
139
+ <section class="related">
140
+
141
+ ## See Also
142
+
143
+ - <span class="package-name">[`@stdlib/random-streams-mt19937`][@stdlib/random-streams-mt19937]</span><span class="delimiter">: </span><span class="description">create a readable stream for a 32-bit Mersenne Twister pseudorandom number generator.</span>
144
+ - <span class="package-name">[`@stdlib/random-base/mt19937`][@stdlib/random/base/mt19937]</span><span class="delimiter">: </span><span class="description">A 32-bit Mersenne Twister pseudorandom number generator.</span>
145
+ - <span class="package-name">[`@stdlib/random-iter/mt19937`][@stdlib/random/iter/mt19937]</span><span class="delimiter">: </span><span class="description">create an iterator for a 32-bit Mersenne Twister pseudorandom number generator.</span>
146
+ - <span class="package-name">[`@stdlib/random-streams/minstd`][@stdlib/random/streams/minstd]</span><span class="delimiter">: </span><span class="description">create a readable stream for a linear congruential pseudorandom number generator (LCG) based on Park and Miller.</span>
147
+ - <span class="package-name">[`@stdlib/random-streams/minstd-shuffle`][@stdlib/random/streams/minstd-shuffle]</span><span class="delimiter">: </span><span class="description">create a readable stream for a linear congruential pseudorandom number generator (LCG) whose output is shuffled.</span>
148
+ - <span class="package-name">[`@stdlib/random-streams/randi`][@stdlib/random/streams/randi]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating pseudorandom numbers having integer values.</span>
149
+ - <span class="package-name">[`@stdlib/random-streams/randu`][@stdlib/random/streams/randu]</span><span class="delimiter">: </span><span class="description">create a readable stream for generating uniformly distributed pseudorandom numbers between 0 and 1.</span>
150
+
151
+ </section>
152
+
153
+ <!-- /.related -->
154
+
155
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
156
+
157
+
158
+ <section class="main-repo" >
159
+
160
+ * * *
161
+
162
+ ## Notice
163
+
164
+ This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
165
+
166
+ For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
167
+
168
+ ### Community
169
+
170
+ [![Chat][chat-image]][chat-url]
171
+
172
+ ---
173
+
174
+ ## License
175
+
176
+ See [LICENSE][stdlib-license].
177
+
178
+
179
+ ## Copyright
180
+
181
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
182
+
183
+ </section>
184
+
185
+ <!-- /.stdlib -->
186
+
187
+ <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
188
+
189
+ <section class="links">
190
+
191
+ [npm-image]: http://img.shields.io/npm/v/@stdlib/random-streams-mt19937-cli.svg
192
+ [npm-url]: https://npmjs.org/package/@stdlib/random-streams-mt19937-cli
193
+
194
+ [test-image]: https://github.com/stdlib-js/random-streams-mt19937/actions/workflows/test.yml/badge.svg?branch=v0.1.0
195
+ [test-url]: https://github.com/stdlib-js/random-streams-mt19937/actions/workflows/test.yml?query=branch:v0.1.0
196
+
197
+ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-streams-mt19937/main.svg
198
+ [coverage-url]: https://codecov.io/github/stdlib-js/random-streams-mt19937?branch=main
199
+
200
+ <!--
201
+
202
+ [dependencies-image]: https://img.shields.io/david/stdlib-js/random-streams-mt19937.svg
203
+ [dependencies-url]: https://david-dm.org/stdlib-js/random-streams-mt19937/main
204
+
205
+ -->
206
+
207
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
208
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
209
+
210
+ [stdlib]: https://github.com/stdlib-js/stdlib
211
+
212
+ [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
213
+
214
+ [cli-section]: https://github.com/stdlib-js/random-streams-mt19937#cli
215
+ [cli-url]: https://github.com/stdlib-js/random-streams-mt19937/tree/cli
216
+ [@stdlib/random-streams-mt19937]: https://www.npmjs.com/package/@stdlib/random-streams-mt19937
217
+
218
+ [umd]: https://github.com/umdjs/umd
219
+ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
220
+
221
+ [deno-url]: https://github.com/stdlib-js/random-streams-mt19937/tree/deno
222
+ [umd-url]: https://github.com/stdlib-js/random-streams-mt19937/tree/umd
223
+ [esm-url]: https://github.com/stdlib-js/random-streams-mt19937/tree/esm
224
+ [branches-url]: https://github.com/stdlib-js/random-streams-mt19937/blob/main/branches.md
225
+
226
+ [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-streams-mt19937/main/LICENSE
227
+
228
+ [stream]: https://nodejs.org/api/stream.html
229
+
230
+ [object-mode]: https://nodejs.org/api/stream.html#stream_object_mode
231
+
232
+ [readable-stream]: https://nodejs.org/api/stream.html
233
+
234
+ [@stdlib/array/uint32]: https://www.npmjs.com/package/@stdlib/array-uint32
235
+
236
+ [@matsumoto:1998a]: https://doi.org/10.1145/272991.272995
237
+
238
+ <!-- <related-links> -->
239
+
240
+ [@stdlib/random/base/mt19937]: https://www.npmjs.com/package/@stdlib/random-base-mt19937
241
+
242
+ [@stdlib/random/iter/mt19937]: https://www.npmjs.com/package/@stdlib/random-iter-mt19937
243
+
244
+ [@stdlib/random/streams/minstd]: https://www.npmjs.com/package/@stdlib/random-streams-minstd
245
+
246
+ [@stdlib/random/streams/minstd-shuffle]: https://www.npmjs.com/package/@stdlib/random-streams-minstd-shuffle
247
+
248
+ [@stdlib/random/streams/randi]: https://www.npmjs.com/package/@stdlib/random-streams-randi
249
+
250
+ [@stdlib/random/streams/randu]: https://www.npmjs.com/package/@stdlib/random-streams-randu
251
+
252
+ <!-- </related-links> -->
253
+
254
+ </section>
255
+
256
+ <!-- /.links -->