<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crypto++: RandomNumberGenerator class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.3.7 --> <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> <h1>RandomNumberGenerator Class Reference</h1><code>#include <<a class="el" href="cryptlib_8h-source.html">cryptlib.h</a>></code> <p> <p>Inheritance diagram for RandomNumberGenerator: <p><center><img src="class_random_number_generator.png" usemap="#RandomNumberGenerator_map" border="0" alt=""></center> <map name="RandomNumberGenerator_map"> <area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,255,80"> <area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,255,24"> <area href="class_a_r_c4___base.html" alt="ARC4_Base" shape="rect" coords="265,168,520,192"> <area href="class_auto_seeded_x917_r_n_g.html" alt="AutoSeededX917RNG< BLOCK_CIPHER >" shape="rect" coords="265,224,520,248"> <area href="class_blocking_rng.html" alt="BlockingRng" shape="rect" coords="265,280,520,304"> <area href="class_class_null_r_n_g.html" alt="ClassNullRNG" shape="rect" coords="265,336,520,360"> <area href="class_l_c___r_n_g.html" alt="LC_RNG" shape="rect" coords="265,504,520,528"> <area href="class_nonblocking_rng.html" alt="NonblockingRng" shape="rect" coords="265,560,520,584"> <area href="class_public_blum_blum_shub.html" alt="PublicBlumBlumShub" shape="rect" coords="265,616,520,640"> <area href="class_random_pool.html" alt="RandomPool" shape="rect" coords="265,672,520,696"> <area href="class_x917_r_n_g.html" alt="X917RNG" shape="rect" coords="265,728,520,752"> </map> <a href="class_random_number_generator-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> interface for random number generators <p> All return values are uniformly distributed over the range specified. <p> <p> Definition at line <a class="el" href="cryptlib_8h-source.html#l00618">618</a> of file <a class="el" href="cryptlib_8h-source.html">cryptlib.h</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><a class="anchor" name="_random_number_generatora0" doxytag="RandomNumberGenerator::GenerateByte" ></a> virtual byte </td><td class="memItemRight" valign=bottom><a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate new random byte and return it <br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual unsigned int </td><td class="memItemRight" valign=bottom><a class="el" href="class_random_number_generator.html#_x917_r_n_ga2">GenerateBit</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate new random bit and return it <a href="#_x917_r_n_ga2"></a><br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="_x917_r_n_ga3" doxytag="RandomNumberGenerator::GenerateWord32" ></a> virtual word32 </td><td class="memItemRight" valign=bottom><a class="el" href="class_random_number_generator.html#_x917_r_n_ga3">GenerateWord32</a> (word32 a=0, word32 b=0xffffffffL)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate a random 32 bit word in the range min to max, inclusive <br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_random_number_generator.html#_x917_r_n_ga4">GenerateBlock</a> (byte *output, unsigned int size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate random array of bytes <a href="#_x917_r_n_ga4"></a><br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="class_random_number_generator.html#_x917_r_n_ga5">DiscardBytes</a> (unsigned int n)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate and discard n bytes <a href="#_x917_r_n_ga5"></a><br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="_x917_r_n_ga6" doxytag="RandomNumberGenerator::Shuffle" ></a> template<class IT> void </td><td class="memItemRight" valign=bottom><a class="el" href="class_random_number_generator.html#_x917_r_n_ga6">Shuffle</a> (IT begin, IT end)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">randomly shuffle the specified array, resulting permutation is uniformly distributed <br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="_zlib_decompressora17" doxytag="RandomNumberGenerator::AlgorithmName" ></a> virtual std::string </td><td class="memItemRight" valign=bottom><a class="el" href="class_algorithm.html#_zlib_decompressora17">AlgorithmName</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="_zlib_decompressora18" doxytag="RandomNumberGenerator::Clone" ></a> virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="class_clonable.html#_zlib_decompressora18">Clone</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br><br></td></tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="_x917_r_n_ga2" doxytag="RandomNumberGenerator::GenerateBit" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> unsigned int RandomNumberGenerator::GenerateBit </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> generate new random bit and return it <p> Default implementation is to call <a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte()</a> and return its parity. <p> Reimplemented in <a class="el" href="class_public_blum_blum_shub.html#_public_blum_blum_shuba1">PublicBlumBlumShub</a>. <p> Definition at line <a class="el" href="cryptlib_8cpp-source.html#l00111">111</a> of file <a class="el" href="cryptlib_8cpp-source.html">cryptlib.cpp</a>. <p> References <a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte()</a>. </td> </tr> </table> <a class="anchor" name="_x917_r_n_ga4" doxytag="RandomNumberGenerator::GenerateBlock" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void RandomNumberGenerator::GenerateBlock </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">byte * </td> <td class="mdname" nowrap> <em>output</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>unsigned int </td> <td class="mdname" nowrap> <em>size</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> generate random array of bytes <p> Default implementation is to call <a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte()</a> size times. <p> Reimplemented in <a class="el" href="class_nonblocking_rng.html#_nonblocking_rnga3">NonblockingRng</a>, <a class="el" href="class_blocking_rng.html#_blocking_rnga3">BlockingRng</a>, and <a class="el" href="class_random_pool.html#_random_poola7">RandomPool</a>. <p> Definition at line <a class="el" href="cryptlib_8cpp-source.html#l00116">116</a> of file <a class="el" href="cryptlib_8cpp-source.html">cryptlib.cpp</a>. <p> References <a class="el" href="cryptlib_8cpp-source.html#l00116">GenerateBlock()</a>, and <a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte()</a>. <p> Referenced by <a class="el" href="cryptlib_8cpp-source.html#l00116">GenerateBlock()</a>, and <a class="el" href="gfpcrypt_8cpp-source.html#l00026">DL_GroupParameters_DSA::GenerateRandom()</a>. </td> </tr> </table> <a class="anchor" name="_x917_r_n_ga5" doxytag="RandomNumberGenerator::DiscardBytes" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void RandomNumberGenerator::DiscardBytes </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">unsigned int </td> <td class="mdname1" valign="top" nowrap> <em>n</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> generate and discard n bytes <p> Default implementation is to call <a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte()</a> n times. <p> Reimplemented in <a class="el" href="class_a_r_c4___base.html#_symmetric_cipher_final_3_01_m_a_r_c4___base_01_4a13">ARC4_Base</a>. <p> Definition at line <a class="el" href="cryptlib_8cpp-source.html#l00142">142</a> of file <a class="el" href="cryptlib_8cpp-source.html">cryptlib.cpp</a>. <p> References <a class="el" href="cryptlib_8cpp-source.html#l00142">DiscardBytes()</a>, and <a class="el" href="class_random_number_generator.html#_random_number_generatora0">GenerateByte()</a>. <p> Referenced by <a class="el" href="cryptlib_8cpp-source.html#l00142">DiscardBytes()</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="cryptlib_8h-source.html">cryptlib.h</a><li><a class="el" href="cryptlib_8cpp-source.html">cryptlib.cpp</a></ul> <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 7 08:24:08 2004 for Crypto++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address> </body> </html>