Random numbers.
npm install @stdlib/randomWe 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. 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. 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. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Random numbers.
``bash`
npm install @stdlib/random
`javascript`
var random = require( '@stdlib/random' );
#### random
Namespace containing random number functionality.
`javascript`
var rand = random;
// returns {...}
The namespace exports the following functions to sample and shuffle elements from an array:
- [sample( x[, options] )][@stdlib/random/sample]: sample elements from an array-like object.
- [shuffle( arr[, options] )][@stdlib/random/shuffle]: shuffle elements of an array-like object.
It also contains the following sub-namespaces:
- [array][@stdlib/random/array]: pseudorandom number generator (PRNG) array creation functions.
- [base][@stdlib/random/base]: base (i.e., lower-level) pseudorandom number generators (PRNGs).
- [iterators][@stdlib/random/iter]: pseudorandom number generator (PRNG) iterators.
- [streams][@stdlib/random/streams]: pseudorandom number generator (PRNG) streams.
- [strided][@stdlib/random/strided]: pseudorandom number generator (PRNG) strided array functions.
`javascript
var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/random' );
console.log( objectKeys( ns ) );
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[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?branch=v0.3.3
[test-url]: https://github.com/stdlib-js/random/actions/workflows/test.yml?query=branch:v0.3.3
[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
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/random/tree/deno
[deno-readme]: https://github.com/stdlib-js/random/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/random/tree/umd
[umd-readme]: https://github.com/stdlib-js/random/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/random/tree/esm
[esm-readme]: https://github.com/stdlib-js/random/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/random/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random/main/LICENSE
[@stdlib/random/array]: https://github.com/stdlib-js/random/tree/main/array
[@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/strided]: https://github.com/stdlib-js/random/tree/main/strided
[@stdlib/random/sample]: https://github.com/stdlib-js/random/tree/main/sample
[@stdlib/random/shuffle]: https://github.com/stdlib-js/random/tree/main/shuffle