<!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: RandomPrimeIterator 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_iterator.html">RandomPrimeIterator</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">RandomPrimeIterator 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::RandomPrimeIterator" -->
<p>Random Prime Generator.
<a href="class_lin_box_1_1_random_prime_iterator.html#details">More...</a></p>
<p><code>#include <random-prime.h></code></p>
<table class="memberdecls">
<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_iterator.html#abf082000a18a4d6c237d3f810048a1ae">RandomPrimeIterator</a> (unsigned int bits=30, unsigned long seed=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#abf082000a18a4d6c237d3f810048a1ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77ea8d2bc6736064cf790c8a473742e8"></a><!-- doxytag: member="LinBox::RandomPrimeIterator::operator++" ref="a77ea8d2bc6736064cf790c8a473742e8" args="()" -->
<a class="el" href="class_lin_box_1_1_random_prime_iterator.html">RandomPrimeIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iterator.html#a77ea8d2bc6736064cf790c8a473742e8">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_lin_box_1_1_random_prime_iterator.html#a77ea8d2bc6736064cf790c8a473742e8" title="operator++() creates a new random prime.">operator++()</a> creates a new random prime. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Prime_Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iterator.html#adf79bef87c5e9c064b2da80fb9954003">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the random prime. <a href="#adf79bef87c5e9c064b2da80fb9954003"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Prime_Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iterator.html#a6cf7e8d51c4f45353122cf9dd1544352">randomPrime</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the random prime. <a href="#a6cf7e8d51c4f45353122cf9dd1544352"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_prime_iterator.html#a609e3ac83fb4aaefde9a1fb22e85f5dc">setSeed</a> (unsigned long ul)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the seed. <a href="#a609e3ac83fb4aaefde9a1fb22e85f5dc"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Random Prime Generator. </p>
<p>Generates prime of specified length. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abf082000a18a4d6c237d3f810048a1ae"></a><!-- doxytag: member="LinBox::RandomPrimeIterator::RandomPrimeIterator" ref="abf082000a18a4d6c237d3f810048a1ae" 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_iterator.html">RandomPrimeIterator</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>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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adf79bef87c5e9c064b2da80fb9954003"></a><!-- doxytag: member="LinBox::RandomPrimeIterator::operator*" ref="adf79bef87c5e9c064b2da80fb9954003" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Prime_Type& operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the random prime. </p>
<p>returns the actual prime. </p>
</div>
</div>
<a class="anchor" id="a6cf7e8d51c4f45353122cf9dd1544352"></a><!-- doxytag: member="LinBox::RandomPrimeIterator::randomPrime" ref="a6cf7e8d51c4f45353122cf9dd1544352" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Prime_Type& randomPrime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the random prime. </p>
<p>returns the actual prime. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>a new prime is not generated. </dd></dl>
</div>
</div>
<a class="anchor" id="a609e3ac83fb4aaefde9a1fb22e85f5dc"></a><!-- doxytag: member="LinBox::RandomPrimeIterator::setSeed" ref="a609e3ac83fb4aaefde9a1fb22e85f5dc" args="(unsigned long ul)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void setSeed </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>ul</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the seed. </p>
<p>Set the random seed to be <code>ul</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ul</td><td>the new seed. </td></tr>
</table>
</dd>
</dl>
</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>
