CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csRandomGen Class Reference

Portable random number generator class. More...

#include <randomgen.h>

List of all members.

Public Methods

 csRandomGen ()
 Initialize the random number generator using current time(). More...

 csRandomGen (uint32 iSeed)
 Initialize the random number generator given a seed. More...

void Initialize ()
 Initialize the RNG using current time() as the seed value. More...

void Initialize (uint32 iSeed)
 Select the random sequence number (942,438,978 sequences available). More...

float Get ()
 Get a floating-point random number in range 0 <= num < 1. More...

uint32 Get (uint32 iLimit)
 Get a uint32 integer random number in range 0 <= num < iLimit. More...

bool SelfTest ()
 Perform a self-test. More...


Detailed Description

Portable random number generator class.

The reason for using this class if that you may want a consistent random number generator across all platforms supported by Crystal Space. Besides, in general it is a better quality RNG than the one supplied in most C runtime libraries. Personally I observed a significant improvement in a random terrain generator I made after I switched to this RNG.

Definition at line 38 of file randomgen.h.


Constructor & Destructor Documentation

csRandomGen::csRandomGen   [inline]
 

Initialize the random number generator using current time().

Definition at line 46 of file randomgen.h.

References Initialize.

csRandomGen::csRandomGen uint32    iSeed [inline]
 

Initialize the random number generator given a seed.

Definition at line 49 of file randomgen.h.

References Initialize, and uint32.


Member Function Documentation

uint32 csRandomGen::Get uint32    iLimit
 

Get a uint32 integer random number in range 0 <= num < iLimit.

float csRandomGen::Get   [inline]
 

Get a floating-point random number in range 0 <= num < 1.

Definition at line 58 of file randomgen.h.

void csRandomGen::Initialize uint32    iSeed
 

Select the random sequence number (942,438,978 sequences available).

void csRandomGen::Initialize  
 

Initialize the RNG using current time() as the seed value.

Referenced by csRandomGen.

bool csRandomGen::SelfTest  
 

Perform a self-test.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14