random: Remove section from DESIGN

The documentation in the code looks fine, so it doesn't need to be
changed.

Signed-off-by: Anna Schumaker <Anna@OcarinaProject.net>
This commit is contained in:
Anna Schumaker 2014-11-08 11:59:27 -05:00
parent 72e55e8917
commit 09a8e26a6c
1 changed files with 0 additions and 20 deletions

20
DESIGN
View File

@ -390,26 +390,6 @@ Track Tag:
Random:
The random number generator is used by the Queue to pick a song as
randomly as possible. I use two different RNG implementations,
depending on if Ocarina is compiled with CONFIG_TEST or not.
When CONFIG_TEST is enabled, the RNG is a simple counter. Every time
_pick_random() is called, the counter is incremented and returned.
When compiled without CONFIG_TEST we will return values using the
rand() function from stdlib.h.
- API:
void random_seed(unsigned int n);
Seed the random number generator based on n.
void random(unsigned int min, unsigned int max);
Return a random number between min and max, inclusive.
If min >= max: return min.
Queue: Queue:
Queues are lists of songs that the user has requested to play. They Queues are lists of songs that the user has requested to play. They
are the main interface for all music played by Ocarina. are the main interface for all music played by Ocarina.