1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
<!--
@license Apache-2.0
Copyright (c) 2018 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.
-->
# Random
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
> Standard library generic random functions.
<section class="installation">
## Installation
```bash
npm install @stdlib/random
```
</section>
<section class="usage">
## Usage
```javascript
var random = require( '@stdlib/random' );
```
#### random
Standard library generic random functions.
```javascript
var rand = random;
// returns {...}
```
The namespace exports the following functions to sample and shuffle elements from an array:
<!-- <toc pattern="+(sample|shuffle)"> -->
<div class="namespace-toc">
- <span class="signature">[`sample( x[, options] )`][@stdlib/random/sample]</span><span class="delimiter">: </span><span class="description">sample elements from an array-like object.</span>
- <span class="signature">[`shuffle( arr[, options] )`][@stdlib/random/shuffle]</span><span class="delimiter">: </span><span class="description">shuffle elements of an array-like object.</span>
</div>
<!-- </toc> -->
It also contains the following sub-namespaces:
<!-- <toc pattern="+(base|iter|streams)" > -->
<div class="namespace-toc">
- <span class="signature">[`base`][@stdlib/random/base]</span><span class="delimiter">: </span><span class="description">standard library base pseudorandom number generators (PRNGs).</span>
- <span class="signature">[`iterators`][@stdlib/random/iter]</span><span class="delimiter">: </span><span class="description">standard library pseudorandom number generator (PRNG) iterators.</span>
- <span class="signature">[`streams`][@stdlib/random/streams]</span><span class="delimiter">: </span><span class="description">standard library pseudorandom number generator (PRNG) streams.</span>
</div>
<!-- </toc> -->
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- TODO: better examples -->
<!-- eslint no-undef: "error" -->
```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/random' );
console.log( objectKeys( ns ) );
```
</section>
<!-- /.examples -->
<section class="main-repo" >
* * *
## Notice
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.
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].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].
</section>
<!-- /.stdlib -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
[npm-image]: http://img.shields.io/npm/v/@stdlib/random.svg
[npm-url]: https://npmjs.org/package/@stdlib/random
[test-image]: https://github.com/stdlib-js/random/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/random/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/random?branch=main
[dependencies-image]: https://img.shields.io/david/stdlib-js/random.svg
[dependencies-url]: https://david-dm.org/stdlib-js/random/main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random/main/LICENSE
<!-- <toc-links> -->
[@stdlib/random/base]: https://github.com/stdlib-js/random/tree/main/base
[@stdlib/random/iter]: https://github.com/stdlib-js/random/tree/main/iter
[@stdlib/random/streams]: https://github.com/stdlib-js/random/tree/main/streams
[@stdlib/random/sample]: https://github.com/stdlib-js/random/tree/main/sample
[@stdlib/random/shuffle]: https://github.com/stdlib-js/random/tree/main/shuffle
<!-- </toc-links> -->
</section>
<!-- /.links -->
|
