<!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: RandomIntegerIter< _Unsigned > 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_random_integer_iter.html">RandomIntegerIter</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">RandomIntegerIter< _Unsigned > Class Template Reference<div class="ingroups"><a class="el" href="group__integers.html">Integers</a> | <a class="el" href="group__randiter.html">randiter</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::RandomIntegerIter" -->
<p>Random Integer Iterator.
<a href="class_lin_box_1_1_random_integer_iter.html#details">More...</a></p>
<p><code>#include <random-integer.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_integer_iter.html#a5a7060bfa8182d74a5cc5c46407e983e">RandomIntegerIter</a> (unsigned int bits=30, unsigned long seed=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a5a7060bfa8182d74a5cc5c46407e983e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ff0c023438469837dccfbe657391d00"></a><!-- doxytag: member="LinBox::RandomIntegerIter::~RandomIntegerIter" ref="a4ff0c023438469837dccfbe657391d00" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_integer_iter.html#a4ff0c023438469837dccfbe657391d00">~RandomIntegerIter</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_integer_iter.html#a2b200c5d019c1edf8991d7b8a94ff807">RandomIntegerIter</a> (const <a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a> &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor. <a href="#a2b200c5d019c1edf8991d7b8a94ff807"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_random_integer_iter.html#addab4a80ce85962c2e8c3c1745b16a54">operator=</a> (const <a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a> &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy. <a href="#addab4a80ce85962c2e8c3c1745b16a54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <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_integer_iter.html#a58d421ab97c44fd92c76f4e73b474f22">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 the random integer. <a href="#a58d421ab97c44fd92c76f4e73b474f22"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<bool _Unsigned = true><br/>
class LinBox::RandomIntegerIter< _Unsigned ></h3>
<p>Random Integer Iterator. </p>
<p>Generates integers 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#_todo000031">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>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">_Unsigned</td><td>if <code>true</code>, then only non negative integers are generated, if <code>false</code>, their sign is random. </td></tr>
</table>
</dd>
</dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5a7060bfa8182d74a5cc5c46407e983e"></a><!-- doxytag: member="LinBox::RandomIntegerIter::RandomIntegerIter" ref="a5a7060bfa8182d74a5cc5c46407e983e" 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_integer_iter.html">RandomIntegerIter</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 integers (in bits) </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="a2b200c5d019c1edf8991d7b8a94ff807"></a><!-- doxytag: member="LinBox::RandomIntegerIter::RandomIntegerIter" ref="a2b200c5d019c1edf8991d7b8a94ff807" args="(const RandomIntegerIter &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a>< _Unsigned > & </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="addab4a80ce85962c2e8c3c1745b16a54"></a><!-- doxytag: member="LinBox::RandomIntegerIter::operator=" ref="addab4a80ce85962c2e8c3c1745b16a54" args="(const RandomIntegerIter &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_random_integer_iter.html">RandomIntegerIter</a>< _Unsigned > & </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="a58d421ab97c44fd92c76f4e73b474f22"></a><!-- doxytag: member="LinBox::RandomIntegerIter::random" ref="a58d421ab97c44fd92c76f4e73b474f22" args="(integer &a) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <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 the random integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">a</td><td>the new integer number </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-integer_8h.html">random-integer.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>
