<!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: RandIterEnvelope< Field > 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_rand_iter_envelope.html">RandIterEnvelope</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">RandIterEnvelope< Field > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::RandIterEnvelope" --><!-- doxytag: inherits="LinBox::RandIterAbstract" -->
<p>Random field base element generator.
<a href="class_lin_box_1_1_rand_iter_envelope.html#details">More...</a></p>
<p><code>#include <envelope.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for RandIterEnvelope< Field >:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="class_lin_box_1_1_rand_iter_envelope.png" usemap="#RandIterEnvelope< Field >_map" alt=""/>
<map id="RandIterEnvelope< Field >_map" name="RandIterEnvelope< Field >_map">
<area href="class_lin_box_1_1_rand_iter_abstract.html" title="Random field element generator." alt="RandIterAbstract" shape="rect" coords="0,0,164,24"/>
</map>
</div></div>
<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="aafd25cc504cbd7e5dac63a07d00f26bf"></a><!-- doxytag: member="LinBox::RandIterEnvelope::Element" ref="aafd25cc504cbd7e5dac63a07d00f26bf" args="" -->
typedef <a class="el" href="class_lin_box_1_1_element_envelope.html">ElementEnvelope</a>< <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_rand_iter_envelope.html#aafd25cc504cbd7e5dac63a07d00f26bf">Element</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">element 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_rand_iter_envelope.html#afe042a4327e503087cb4504080496d93">RandIterEnvelope</a> (const <a class="el" href="class_lin_box_1_1_field_envelope.html">FieldEnvelope</a>< <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> > &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="#afe042a4327e503087cb4504080496d93"></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_rand_iter_envelope.html#aed034956fcde898c4877ed378e87f98d">RandIterEnvelope</a> (const typename Field::RandIter &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from random field element generator to be wrapped. <a href="#aed034956fcde898c4877ed378e87f98d"></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_rand_iter_envelope.html#ab8c8103130fdef7b90e202d83ba3bbe9">RandIterEnvelope</a> (const <a class="el" href="class_lin_box_1_1_rand_iter_envelope.html">RandIterEnvelope</a> &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ab8c8103130fdef7b90e202d83ba3bbe9"></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_rand_iter_envelope.html#a6daf1f678889e1d8fee51177b5d48d8b">~RandIterEnvelope</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a6daf1f678889e1d8fee51177b5d48d8b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_rand_iter_envelope.html#a7064bd9e0bebf53e9e7167a5cc474f24">operator=</a> (const <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a> &R)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a7064bd9e0bebf53e9e7167a5cc474f24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_rand_iter_envelope.html#a9e00cbaef2f79081219c72d70477e7f5">construct</a> (const <a class="el" href="class_lin_box_1_1_field_abstract.html">FieldAbstract</a> &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) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual constructor from field, sampling size, and seed. <a href="#a9e00cbaef2f79081219c72d70477e7f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_rand_iter_envelope.html#a3a5198dd096f1bf5b5026b206b4244e7">clone</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual copy constructor. <a href="#a3a5198dd096f1bf5b5026b206b4244e7"></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_rand_iter_envelope.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 Field><br/>
class LinBox::RandIterEnvelope< Field ></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="afe042a4327e503087cb4504080496d93"></a><!-- doxytag: member="LinBox::RandIterEnvelope::RandIterEnvelope" ref="afe042a4327e503087cb4504080496d93" args="(const FieldEnvelope< Field > &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_rand_iter_envelope.html">RandIterEnvelope</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_field_envelope.html">FieldEnvelope</a>< <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> > & </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. </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 envelope 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 = 0) </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="aed034956fcde898c4877ed378e87f98d"></a><!-- doxytag: member="LinBox::RandIterEnvelope::RandIterEnvelope" ref="aed034956fcde898c4877ed378e87f98d" args="(const typename Field::RandIter &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_rand_iter_envelope.html">RandIterEnvelope</a> </td>
<td>(</td>
<td class="paramtype">const typename Field::RandIter & </td>
<td class="paramname"><em>R</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from random field element generator to be wrapped. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">R</td><td>random field element generator object to be wrapped </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab8c8103130fdef7b90e202d83ba3bbe9"></a><!-- doxytag: member="LinBox::RandIterEnvelope::RandIterEnvelope" ref="ab8c8103130fdef7b90e202d83ba3bbe9" args="(const RandIterEnvelope &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_rand_iter_envelope.html">RandIterEnvelope</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_rand_iter_envelope.html">RandIterEnvelope</a>< <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</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>
<p>Constructs <a class="el" href="class_lin_box_1_1_rand_iter_envelope.html" title="Random field base element generator.">RandIterEnvelope</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_rand_iter_envelope.html" title="Random field base element generator.">RandIterEnvelope</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6daf1f678889e1d8fee51177b5d48d8b"></a><!-- doxytag: member="LinBox::RandIterEnvelope::~RandIterEnvelope" ref="a6daf1f678889e1d8fee51177b5d48d8b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="class_lin_box_1_1_rand_iter_envelope.html">RandIterEnvelope</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>Required by abstract base class. This destructs the random field element generator object. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7064bd9e0bebf53e9e7167a5cc474f24"></a><!-- doxytag: member="LinBox::RandIterEnvelope::operator=" ref="a7064bd9e0bebf53e9e7167a5cc474f24" args="(const RandIterAbstract &R)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a> & </td>
<td class="paramname"><em>R</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<p>Assigns <a class="el" href="class_lin_box_1_1_rand_iter_envelope.html" title="Random field base element generator.">RandIterEnvelope</a> object R to generator. Required by abstract base class. </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_rand_iter_envelope.html" title="Random field base element generator.">RandIterEnvelope</a> object. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html#a3573203f19af6b1677c22ea69c55e365">RandIterAbstract</a>.</p>
</div>
</div>
<a class="anchor" id="a9e00cbaef2f79081219c72d70477e7f5"></a><!-- doxytag: member="LinBox::RandIterEnvelope::construct" ref="a9e00cbaef2f79081219c72d70477e7f5" args="(const FieldAbstract &F, const integer &size=0, const integer &seed=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a>* construct </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_lin_box_1_1_field_abstract.html">FieldAbstract</a> & </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> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual constructor from field, sampling size, and seed. </p>
<p>Required because constructors cannot be virtual. Passes construction on to derived classes. 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. Required by abstract base class. </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 abstract 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 = 0) </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>
<p>Implements <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html#a032491c3f68a08a6b68337e44e0c4fe3">RandIterAbstract</a>.</p>
</div>
</div>
<a class="anchor" id="a3a5198dd096f1bf5b5026b206b4244e7"></a><!-- doxytag: member="LinBox::RandIterEnvelope::clone" ref="a3a5198dd096f1bf5b5026b206b4244e7" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_rand_iter_abstract.html">RandIterAbstract</a>* clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual copy constructor. </p>
<p>Required because constructors cannot be virtual. Passes construction on to derived classes. Required by abstract base class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to new <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html" title="Random field element generator.">RandIterAbstract</a> object in dynamic memory. </dd></dl>
<p>Implements <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html#a94e7af4c3e320c823916a4c086630bc9">RandIterAbstract</a>.</p>
</div>
</div>
<a class="anchor" id="adcd52d6cef0599b26cbe79ee36802b92"></a><!-- doxytag: member="LinBox::RandIterEnvelope::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, virtual]</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>
<p>Implements <a class="el" href="class_lin_box_1_1_rand_iter_abstract.html#af24414c54db902d1302e5d599d86606d">RandIterAbstract</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>randiter/envelope.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>
