<!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: PrimeStream< Element > Class Template 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_prime_stream.html">PrimeStream</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">PrimeStream< Element > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::PrimeStream" -->
<p>Prime number stream.
<a href="class_lin_box_1_1_prime_stream.html#details">More...</a></p>
<p><code>#include <prime-stream.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_prime_stream.html#a75db96a3db5c1ebe8a37df2b58f10df4">PrimeStream</a> (Integer &start, bool move_up=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a75db96a3db5c1ebe8a37df2b58f10df4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Element & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_prime_stream.html#ab75799bfe4b44d8a4266970cbfe57c32">next</a> (Element &a)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next prime element. <a href="#ab75799bfe4b44d8a4266970cbfe57c32"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29ce3a1261ad905b37fcd6dec54c1fea"></a><!-- doxytag: member="LinBox::PrimeStream::operator>>" ref="a29ce3a1261ad905b37fcd6dec54c1fea" args="(Element &a)" -->
<a class="el" href="class_lin_box_1_1_prime_stream.html">PrimeStream</a>< Element > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_prime_stream.html#a29ce3a1261ad905b37fcd6dec54c1fea">operator>></a> (Element &a)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator form for getting the next prime element. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Element><br/>
class LinBox::PrimeStream< Element ></h3>
<p>Prime number stream. </p>
<p>Provides a source of prime numbers of given characteristics to use in parts of the library that need to reduce modulo one or more primes. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a75db96a3db5c1ebe8a37df2b58f10df4"></a><!-- doxytag: member="LinBox::PrimeStream::PrimeStream" ref="a75db96a3db5c1ebe8a37df2b58f10df4" args="(Integer &start, bool move_up=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_prime_stream.html">PrimeStream</a> </td>
<td>(</td>
<td class="paramtype">Integer & </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>move_up</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Construct a <a class="el" href="class_lin_box_1_1_prime_stream.html" title="Prime number stream.">PrimeStream</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">start</td><td>Starting point; need not be prime itself </td></tr>
<tr><td class="paramname">move_up</td><td>true if we should move up from the starting point, false otherwise </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab75799bfe4b44d8a4266970cbfe57c32"></a><!-- doxytag: member="LinBox::PrimeStream::next" ref="ab75799bfe4b44d8a4266970cbfe57c32" args="(Element &a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Element& next </td>
<td>(</td>
<td class="paramtype">Element & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next prime element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>Place to store the next prime element </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to next prime element </dd></dl>
<p><dl class="warning"><dt><b>Warning:</b></dt><dd>LinBox::Integer does not support prevprime </dd></dl>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>prime-stream.h</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>
