Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Stub out some documentation for the new Random library
- Loading branch information
1 parent
1cca843
commit fc85ad2
Showing
1 changed file
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
layout: rosella | ||
title: Rosella Random | ||
--- | ||
|
||
## Overview | ||
|
||
The Rosella Random library provides tools for generating and using random | ||
numbers. | ||
|
||
## Concepts | ||
|
||
### Pseudo-Random Numbers | ||
|
||
## Namespaces | ||
|
||
### Rosella.Random | ||
|
||
The Rosella.Random namespace provides a series of utilities for working with | ||
random numbers. | ||
|
||
// Get a default uniform distribution number generator | ||
var prng = Rosella.Random.default_uniform_random() | ||
|
||
// Get a default normal distribution number generator | ||
prng = Rosella.Random.default_normal_random() | ||
|
||
// Shuffle the array contents randomly | ||
Rosella.Random.shuffle_array([1, 2, 3, 4, 5]); | ||
|
||
## Classes | ||
|
||
### Random.RandomNumber | ||
|
||
Abstract parent class of pseudo-random number generators. This class provides | ||
the basic interface for PRNGs. Do not use this class directly, use a subclass | ||
instead. | ||
|
||
### Random.RandomNumber.MersenneTwister | ||
|
||
An implementation of the Mersenne Twister algorithm. It is a generator of | ||
uniformly-distributed random numbers. | ||
|
||
### Random.RandomNumber.BoxMullerNormal | ||
|
||
An implementation of the Box-Muller transform. It is a generator of | ||
normally-distributed random numbers. | ||
|
||
## Examples | ||
|
||
### Winxed | ||
|
||
### NQP-rx | ||
|
||
## Users | ||
|
||
The Rosella Query library uses the Random library for the .shuffle() method |