<!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>linbox: RandomPrimeIter 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.7.4 --> <script type="text/javascript"> function hasClass(ele,cls) { return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)')); } function addClass(ele,cls) { if (!this.hasClass(ele,cls)) ele.className += " "+cls; } function removeClass(ele,cls) { if (hasClass(ele,cls)) { var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)'); ele.className=ele.className.replace(reg,' '); } } function toggleVisibility(linkObj) { var base = linkObj.getAttribute('id'); var summary = document.getElementById(base + '-summary'); var content = document.getElementById(base + '-content'); var trigger = document.getElementById(base + '-trigger'); if ( hasClass(linkObj,'closed') ) { summary.style.display = 'none'; content.style.display = 'block'; trigger.src = 'open.png'; removeClass(linkObj,'closed'); addClass(linkObj,'opened'); } else if ( hasClass(linkObj,'opened') ) { summary.style.display = 'block'; content.style.display = 'none'; trigger.src = 'closed.png'; removeClass(linkObj,'opened'); addClass(linkObj,'closed'); } return false; } </script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">linbox</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_lin_box.html">LinBox</a> </li> <li class="navelem"><a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">RandomPrimeIter Class Reference<div class="ingroups"><a class="el" href="group__primes.html">Primes</a> | <a class="el" href="group__randiter.html">randiter</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="LinBox::RandomPrimeIter" --> <p>Random Prime Iterator. <a href="class_lin_box_1_1_random_prime_iter.html#details">More...</a></p> <p><code>#include <random-prime.h></code></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-types"></a> Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a265899fe33582f7001d31f157e2cdb78"></a><!-- doxytag: member="LinBox::RandomPrimeIter::Prime_Type" ref="a265899fe33582f7001d31f157e2cdb78" args="" --> typedef <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#a265899fe33582f7001d31f157e2cdb78">Prime_Type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">prime type <br/></td></tr> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#a99f7f05b3d7962cb9fcc6c8ccceb4c39">RandomPrimeIter</a> (unsigned int bits=30, unsigned long seed=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a99f7f05b3d7962cb9fcc6c8ccceb4c39"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2834b83016f1f792e10bd95037ae0eb"></a><!-- doxytag: member="LinBox::RandomPrimeIter::~RandomPrimeIter" ref="aa2834b83016f1f792e10bd95037ae0eb" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#aa2834b83016f1f792e10bd95037ae0eb">~RandomPrimeIter</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">destructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#a55acaeec189c54ae4656552e8e446c01">RandomPrimeIter</a> (const <a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> &R)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor. <a href="#a55acaeec189c54ae4656552e8e446c01"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#a1cf365785002f21e15b95cd34b00270b">operator=</a> (const <a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> &R)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">copy. <a href="#a1cf365785002f21e15b95cd34b00270b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#aadfc46c0dc3fb6fbd624eaf2c5447434">random</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &a) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get a random prime of maximum size <code>_bits</code> . <a href="#aadfc46c0dc3fb6fbd624eaf2c5447434"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#acc6f19d25798f3e4e19e8283abb90579">random_exact</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &a) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iter.html#a0b5df60a2e7e225b5fc000827b1282cf">random_between</a> (<a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &a, unsigned long _low_bits) const </td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Random Prime Iterator. </p> <p>Generates prime of size smaller than a prescribed one. This class is closer to the <a class="el" href="class_lin_box_1_1_rand_iter_archetype.html" title="Random field element generator archetype.">LinBox::RandIterArchetype</a>. </p> <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000032">Todo:</a></b></dt><dd>one could create the same one on a <a class="el" href="class_lin_box_1_1_p_i_d__double.html" title="NO DOC.">LinBox::PID_double</a> ? </dd></dl> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a99f7f05b3d7962cb9fcc6c8ccceb4c39"></a><!-- doxytag: member="LinBox::RandomPrimeIter::RandomPrimeIter" ref="a99f7f05b3d7962cb9fcc6c8ccceb4c39" args="(unsigned int bits=30, unsigned long seed=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>bits</em> = <code>30</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>seed</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">bits</td><td>max size of primes (in bits). Default is 30 so it can fit in a <code>Linbox::Modular<double></code>. </td></tr> <tr><td class="paramname">seed</td><td>if <code>0</code> a seed will be generated, otherwise, the provided seed will be use. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a55acaeec189c54ae4656552e8e446c01"></a><!-- doxytag: member="LinBox::RandomPrimeIter::RandomPrimeIter" ref="a55acaeec189c54ae4656552e8e446c01" args="(const RandomPrimeIter &R)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> & </td> <td class="paramname"><em>R</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>copy constructor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">R</td><td>random iterator to be copied. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a1cf365785002f21e15b95cd34b00270b"></a><!-- doxytag: member="LinBox::RandomPrimeIter::operator=" ref="a1cf365785002f21e15b95cd34b00270b" args="(const RandomPrimeIter &R)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a>& operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="class_lin_box_1_1_random_prime_iter.html">RandomPrimeIter</a> & </td> <td class="paramname"><em>R</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>copy. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">R</td><td>random iterator to be copied. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aadfc46c0dc3fb6fbd624eaf2c5447434"></a><!-- doxytag: member="LinBox::RandomPrimeIter::random" ref="aadfc46c0dc3fb6fbd624eaf2c5447434" args="(integer &a) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a>& random </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td> <td class="paramname"><em>a</em></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>get a random prime of maximum size <code>_bits</code> . </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">a</td><td>a prime number </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="acc6f19d25798f3e4e19e8283abb90579"></a><!-- doxytag: member="LinBox::RandomPrimeIter::random_exact" ref="acc6f19d25798f3e4e19e8283abb90579" args="(integer &a) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a>& random_exact </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td> <td class="paramname"><em>a</em></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000033">Todo:</a></b></dt><dd>uses random_exact when givaro is released. </dd></dl> </p> </div> </div> <a class="anchor" id="a0b5df60a2e7e225b5fc000827b1282cf"></a><!-- doxytag: member="LinBox::RandomPrimeIter::random_between" ref="a0b5df60a2e7e225b5fc000827b1282cf" args="(integer &a, unsigned long _low_bits) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a>& random_between </td> <td>(</td> <td class="paramtype"><a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td> <td class="paramname"><em>a</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"><em>_low_bits</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000034">Todo:</a></b></dt><dd>uses random_between when givaro is released. </dd></dl> </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="random-prime_8h.html">random-prime.h</a></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated on Tue Aug 30 2011 for linbox by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>