<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Crypto++: RandomNumberGenerator Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</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> </div> <div class="contents"> <h1>RandomNumberGenerator Class Reference</h1><!-- doxytag: class="RandomNumberGenerator" --><!-- doxytag: inherits="Algorithm" --> <p>interface for random number generators <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>></code></p> <div class="dynheader"> Inheritance diagram for RandomNumberGenerator:</div> <div class="dynsection"> <div class="center"> <img src="class_random_number_generator.gif" usemap="#RandomNumberGenerator_map" alt=""/> <map id="RandomNumberGenerator_map" name="RandomNumberGenerator_map"> <area href="class_algorithm.html" alt="Algorithm" shape="rect" coords="0,56,587,80"/> <area href="class_clonable.html" alt="Clonable" shape="rect" coords="0,0,587,24"/> <area href="class_additive_cipher_template.html" alt="AdditiveCipherTemplate< BASE >" shape="rect" coords="597,168,1184,192"/> <area href="class_additive_cipher_template.html" alt="AdditiveCipherTemplate< AbstractPolicyHolder< AdditiveCipherAbstractPolicy, CTR_ModePolicy > >" shape="rect" coords="597,224,1184,248"/> <area href="class_auto_seeded_x917_r_n_g.html" alt="AutoSeededX917RNG< BLOCK_CIPHER >" shape="rect" coords="597,280,1184,304"/> <area href="class_blocking_rng.html" alt="BlockingRng" shape="rect" coords="597,336,1184,360"/> <area href="class_class_null_r_n_g.html" alt="ClassNullRNG" shape="rect" coords="597,392,1184,416"/> <area href="class_fixed_r_n_g.html" alt="FixedRNG" shape="rect" coords="597,448,1184,472"/> <area href="class_k_d_f2___r_n_g.html" alt="KDF2_RNG" shape="rect" coords="597,504,1184,528"/> <area href="class_l_c___r_n_g.html" alt="LC_RNG" shape="rect" coords="597,560,1184,584"/> <area href="class_nonblocking_rng.html" alt="NonblockingRng" shape="rect" coords="597,616,1184,640"/> <area href="class_public_blum_blum_shub.html" alt="PublicBlumBlumShub" shape="rect" coords="597,672,1184,696"/> <area href="class_random_pool.html" alt="RandomPool" shape="rect" coords="597,728,1184,752"/> <area href="class_weak1_1_1_a_r_c4___base.html" alt="Weak1::ARC4_Base" shape="rect" coords="597,784,1184,808"/> <area href="class_x917_r_n_g.html" alt="X917RNG" shape="rect" coords="597,840,1184,864"/> </map> </div> </div> <p><a href="class_random_number_generator-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6feb4f0afedb62a495b7a9ae311fa1cb"></a><!-- doxytag: member="RandomNumberGenerator::IncorporateEntropy" ref="a6feb4f0afedb62a495b7a9ae311fa1cb" args="(const byte *input, size_t length)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a6feb4f0afedb62a495b7a9ae311fa1cb">IncorporateEntropy</a> (const byte *input, size_t length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">update RNG state with additional unpredictable values <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85b1db1d40b57d18a320dba6cfb2e4b6"></a><!-- doxytag: member="RandomNumberGenerator::CanIncorporateEntropy" ref="a85b1db1d40b57d18a320dba6cfb2e4b6" args="() const " --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a85b1db1d40b57d18a320dba6cfb2e4b6">CanIncorporateEntropy</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if IncorporateEntropy is implemented <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada0f7c437b0c8e6ba94ebcd75bff4bda"></a><!-- doxytag: member="RandomNumberGenerator::GenerateByte" ref="ada0f7c437b0c8e6ba94ebcd75bff4bda" args="()" --> virtual byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda">GenerateByte</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate new random byte and return it <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ace592244cfbd6c18398ea6c75857532e">GenerateBit</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate new random bit and return it <a href="#ace592244cfbd6c18398ea6c75857532e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac06c9f5e66f35d643e4192f231b8a4cd"></a><!-- doxytag: member="RandomNumberGenerator::GenerateWord32" ref="ac06c9f5e66f35d643e4192f231b8a4cd" args="(word32 a=0, word32 b=0xffffffffL)" --> virtual word32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#ac06c9f5e66f35d643e4192f231b8a4cd">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/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a497145546d24e6d4abaf10b7e0f1ba17"></a><!-- doxytag: member="RandomNumberGenerator::GenerateBlock" ref="a497145546d24e6d4abaf10b7e0f1ba17" args="(byte *output, size_t size)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a497145546d24e6d4abaf10b7e0f1ba17">GenerateBlock</a> (byte *output, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate random array of bytes <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44f70ad8fed869a4ee55f50ef8e6e699"></a><!-- doxytag: member="RandomNumberGenerator::DiscardBytes" ref="a44f70ad8fed869a4ee55f50ef8e6e699" args="(size_t n)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a44f70ad8fed869a4ee55f50ef8e6e699">DiscardBytes</a> (size_t n)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate and discard n bytes <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5cc474006e2c7383ec20cc4d0c2abbaf"></a><!-- doxytag: member="RandomNumberGenerator::GenerateIntoBufferedTransformation" ref="a5cc474006e2c7383ec20cc4d0c2abbaf" args="(BufferedTransformation &target, const std::string &channel, lword length)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a5cc474006e2c7383ec20cc4d0c2abbaf">GenerateIntoBufferedTransformation</a> (<a class="el" href="class_buffered_transformation.html">BufferedTransformation</a> &target, const std::string &channel, lword length)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">generate random bytes as input to a <a class="el" href="class_buffered_transformation.html" title="interface for buffered transformations">BufferedTransformation</a> <br/></td></tr> <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="a9ef5090c556d086e7aa240acf7a131b4"></a><!-- doxytag: member="RandomNumberGenerator::Shuffle" ref="a9ef5090c556d086e7aa240acf7a131b4" args="(IT begin, IT end)" --> template<class IT > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_random_number_generator.html#a9ef5090c556d086e7aa240acf7a131b4">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/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd21c6715add4884fa043eaf51655039"></a><!-- doxytag: member="RandomNumberGenerator::AlgorithmName" ref="acd21c6715add4884fa043eaf51655039" args="() const " --> virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_algorithm.html#acd21c6715add4884fa043eaf51655039">AlgorithmName</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">returns name of this algorithm, not universally implemented yet <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24b43349a71e1f98508eeb10b31a0a62"></a><!-- doxytag: member="RandomNumberGenerator::Clone" ref="a24b43349a71e1f98508eeb10b31a0a62" args="() const " --> virtual <a class="el" href="class_clonable.html">Clonable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_clonable.html#a24b43349a71e1f98508eeb10b31a0a62">Clone</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">this is not implemented by most classes yet <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>interface for random number generators </p> <p>All return values are uniformly distributed over the range specified. </p> <p>Definition at line <a class="el" href="cryptlib_8h_source.html#l00680">680</a> of file <a class="el" href="cryptlib_8h_source.html">cryptlib.h</a>.</p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ace592244cfbd6c18398ea6c75857532e"></a><!-- doxytag: member="RandomNumberGenerator::GenerateBit" ref="ace592244cfbd6c18398ea6c75857532e" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int RandomNumberGenerator::GenerateBit </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>generate new random bit and return it </p> <p>Default implementation is to call <a class="el" href="class_random_number_generator.html#ada0f7c437b0c8e6ba94ebcd75bff4bda" title="generate new random byte and return it">GenerateByte()</a> and return its lowest bit. </p> <p>Reimplemented in <a class="el" href="class_public_blum_blum_shub.html#a6871d5e2ba162f32574d6b43e2473286">PublicBlumBlumShub</a>.</p> <p>Definition at line <a class="el" href="cryptlib_8cpp_source.html#l00229">229</a> of file <a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a>.</p> <p>References <a class="el" href="cryptlib_8cpp_source.html#l00234">GenerateByte()</a>.</p> </div> </div> <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> <li><a class="el" href="cryptlib_8cpp_source.html">cryptlib.cpp</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on 9 Dec 2009 for Crypto++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>