<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csRandomGen Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csRandomGen Class Reference</h1><!-- doxytag: class="csRandomGen" -->Portable random number generator class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="randomgen_8h-source.html">csutil/randomgen.h</a>></code>
<p>
<p>
<a href="classcsRandomGen-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#f0f1932d4e0e2ef98c5ce45d2531d3b9">csRandomGen</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> iSeed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the random number generator given a seed. <a href="#f0f1932d4e0e2ef98c5ce45d2531d3b9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#4c378aeb3a4e014eb089ab31381fd072">csRandomGen</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the random number generator using current time(). <a href="#4c378aeb3a4e014eb089ab31381fd072"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#22483151a6b76503e30b597c8d88b5c3">Get</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> iLimit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a uint32 integer random number in range 0 <= num < iLimit. <a href="#22483151a6b76503e30b597c8d88b5c3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#28a9e3845b8a7acaa455cfddc6bb360e">Get</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a floating-point random number in range 0 <= num < 1. <a href="#28a9e3845b8a7acaa455cfddc6bb360e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#016b4329e05a13622a2f1b11f9fdab27">Initialize</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> iSeed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select the random sequence number (942,438,978 sequences available). <a href="#016b4329e05a13622a2f1b11f9fdab27"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#004327899aba9e745079553072c5e152">Initialize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the RNG using current time() as the seed value. <a href="#004327899aba9e745079553072c5e152"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRandomGen.html#ee78e9710e3b7241927dcfc4f6d7d25b">SelfTest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a self-test. <a href="#ee78e9710e3b7241927dcfc4f6d7d25b"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Portable random number generator class.
<p>
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.
<p>Definition at line <a class="el" href="randomgen_8h-source.html#l00058">58</a> of file <a class="el" href="randomgen_8h-source.html">randomgen.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4c378aeb3a4e014eb089ab31381fd072"></a><!-- doxytag: member="csRandomGen::csRandomGen" ref="4c378aeb3a4e014eb089ab31381fd072" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csRandomGen::csRandomGen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the random number generator using current time().
<p>
<p>Definition at line <a class="el" href="randomgen_8h-source.html#l00066">66</a> of file <a class="el" href="randomgen_8h-source.html">randomgen.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="f0f1932d4e0e2ef98c5ce45d2531d3b9"></a><!-- doxytag: member="csRandomGen::csRandomGen" ref="f0f1932d4e0e2ef98c5ce45d2531d3b9" args="(uint32 iSeed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csRandomGen::csRandomGen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>iSeed</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the random number generator given a seed.
<p>
<p>Definition at line <a class="el" href="randomgen_8h-source.html#l00069">69</a> of file <a class="el" href="randomgen_8h-source.html">randomgen.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="22483151a6b76503e30b597c8d88b5c3"></a><!-- doxytag: member="csRandomGen::Get" ref="22483151a6b76503e30b597c8d88b5c3" args="(uint32 iLimit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> csRandomGen::Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>iLimit</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a uint32 integer random number in range 0 <= num < iLimit.
<p>
</div>
</div><p>
<a class="anchor" name="28a9e3845b8a7acaa455cfddc6bb360e"></a><!-- doxytag: member="csRandomGen::Get" ref="28a9e3845b8a7acaa455cfddc6bb360e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float csRandomGen::Get </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a floating-point random number in range 0 <= num < 1.
<p>
<p>Definition at line <a class="el" href="randomgen_8h-source.html#l00078">78</a> of file <a class="el" href="randomgen_8h-source.html">randomgen.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="016b4329e05a13622a2f1b11f9fdab27"></a><!-- doxytag: member="csRandomGen::Initialize" ref="016b4329e05a13622a2f1b11f9fdab27" args="(uint32 iSeed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csRandomGen::Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>iSeed</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Select the random sequence number (942,438,978 sequences available).
<p>
</div>
</div><p>
<a class="anchor" name="004327899aba9e745079553072c5e152"></a><!-- doxytag: member="csRandomGen::Initialize" ref="004327899aba9e745079553072c5e152" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csRandomGen::Initialize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the RNG using current time() as the seed value.
<p>
</div>
</div><p>
<a class="anchor" name="ee78e9710e3b7241927dcfc4f6d7d25b"></a><!-- doxytag: member="csRandomGen::SelfTest" ref="ee78e9710e3b7241927dcfc4f6d7d25b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csRandomGen::SelfTest </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform a self-test.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="randomgen_8h-source.html">randomgen.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
930
