<!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: ModularBalancedRandIter< 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_modular_balanced_rand_iter.html">ModularBalancedRandIter</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">ModularBalancedRandIter< Element > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::ModularBalancedRandIter" -->
<p>Random field base element generator.
<a href="class_lin_box_1_1_modular_balanced_rand_iter.html#details">More...</a></p>
<p><code>#include <modular-balanced.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_modular_balanced_rand_iter.html#a4231eddc86a9fe4b68d2b7787ce9776c">ModularBalancedRandIter</a> (const ModularBalanced< Element > &F, const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &size=0, const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> &seed=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from field, sampling size, and seed. <a href="#a4231eddc86a9fe4b68d2b7787ce9776c"></a><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_modular_balanced_rand_iter.html#a68bd6070900f6e413641548df1c76f72">ModularBalancedRandIter</a> (const <a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a>< Element > &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a68bd6070900f6e413641548df1c76f72"></a><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_modular_balanced_rand_iter.html#a59b333828d46e97e976952eea9556783">~ModularBalancedRandIter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a59b333828d46e97e976952eea9556783"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a><br class="typebreak"/>
< Element > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html#abcb81143548cb9a76650760d3a5e9b33">operator=</a> (const <a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a>< Element > &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#abcb81143548cb9a76650760d3a5e9b33"></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_modular_balanced_rand_iter.html#a5d14896944481a69181ca8b871d46f7f">random</a> (Element &a) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Random field element creator. <a href="#a5d14896944481a69181ca8b871d46f7f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html#adcd52d6cef0599b26cbe79ee36802b92">random</a> (<a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> &a) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Random field element creator. <a href="#adcd52d6cef0599b26cbe79ee36802b92"></a><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::ModularBalancedRandIter< Element ></h3>
<p>Random field base element generator. </p>
<p>This encapsulated class is a generator of random field base elements for the encapsulating field. It is required to contain constructors from a field object and two integers. The first integer being a cardinality of a set to draw the random elements from, and the second being a seed for the random number generator. It is also required to contain a copy constructor, a destructor, and an operator () which acts on a reference to a field base element. In this operator (), the random element is placed into the input field base element and also returned as a reference. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4231eddc86a9fe4b68d2b7787ce9776c"></a><!-- doxytag: member="LinBox::ModularBalancedRandIter::ModularBalancedRandIter" ref="a4231eddc86a9fe4b68d2b7787ce9776c" args="(const ModularBalanced< Element > &F, const integer &size=0, const integer &seed=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a> </td>
<td>(</td>
<td class="paramtype">const ModularBalanced< Element > & </td>
<td class="paramname"><em>F</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </td>
<td class="paramname"><em>size</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__integers.html#gad62eceb96963b157a2357aba991f6d6e">integer</a> & </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 from field, sampling size, and seed. </p>
<p>The random field element iterator works in the field F, is seeded by seed, and it returns any one element with probability no more than 1/min (size, F.cardinality (c)). A sampling size of zero means to sample from the entire field. A seed of zero means to use some arbitrary seed for the generator. Purely virtual. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td><a class="el" href="namespace_lin_box.html" title="Namespace in which all linbox code resides.">LinBox</a> field archetype object in which to do arithmetic </td></tr>
<tr><td class="paramname">size</td><td>constant integer reference of sample size from which to sample (default = modulus of field) </td></tr>
<tr><td class="paramname">seed</td><td>constant integer reference from which to seed random number generator (default = 0) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a68bd6070900f6e413641548df1c76f72"></a><!-- doxytag: member="LinBox::ModularBalancedRandIter::ModularBalancedRandIter" ref="a68bd6070900f6e413641548df1c76f72" args="(const ModularBalancedRandIter< Element > &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a>< Element > & </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>
<p>Constructs <a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html" title="Random field base element generator.">ModularBalancedRandIter</a> object by copying the random field element generator. This is required to allow generator objects to be passed by value into functions. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">R</td><td><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html" title="Random field base element generator.">ModularBalancedRandIter</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a59b333828d46e97e976952eea9556783"></a><!-- doxytag: member="LinBox::ModularBalancedRandIter::~ModularBalancedRandIter" ref="a59b333828d46e97e976952eea9556783" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>This destructs the random field element generator object. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abcb81143548cb9a76650760d3a5e9b33"></a><!-- doxytag: member="LinBox::ModularBalancedRandIter::operator=" ref="abcb81143548cb9a76650760d3a5e9b33" args="(const ModularBalancedRandIter< Element > &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a><Element>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html">ModularBalancedRandIter</a>< Element > & </td>
<td class="paramname"><em>R</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Assigns <a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html" title="Random field base element generator.">ModularBalancedRandIter</a> object R to generator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">R</td><td><a class="el" href="class_lin_box_1_1_modular_balanced_rand_iter.html" title="Random field base element generator.">ModularBalancedRandIter</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5d14896944481a69181ca8b871d46f7f"></a><!-- doxytag: member="LinBox::ModularBalancedRandIter::random" ref="a5d14896944481a69181ca8b871d46f7f" args="(Element &a) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Element& random </td>
<td>(</td>
<td class="paramtype">Element & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Random field element creator. </p>
<p>This returns a random field element from the information supplied at the creation of the generator. Required by abstract base class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to random field element </dd></dl>
</div>
</div>
<a class="anchor" id="adcd52d6cef0599b26cbe79ee36802b92"></a><!-- doxytag: member="LinBox::ModularBalancedRandIter::random" ref="adcd52d6cef0599b26cbe79ee36802b92" args="(ElementAbstract &a) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a>& random </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lin_box_1_1_element_abstract.html">ElementAbstract</a> & </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Random field element creator. </p>
<p>This returns a random field element from the information supplied at the creation of the generator. Required by abstract base class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to random field element </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>randiter/modular-balanced.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>
