<!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: StandardBasisStream< Field, _Vector, Trait > 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_standard_basis_stream.html">StandardBasisStream</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">StandardBasisStream< Field, _Vector, Trait > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::StandardBasisStream" --><!-- doxytag: inherits="LinBox::VectorStream" -->
<p>Stream for <img class="formulaInl" alt="$e_1,\cdots,e_n$" src="form_72.png"/>.
<a href="class_lin_box_1_1_standard_basis_stream.html#details">More...</a></p>
<p><code>#include <stream.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 StandardBasisStream< Field, _Vector, Trait >:</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_standard_basis_stream.png" usemap="#StandardBasisStream< Field, _Vector, Trait >_map" alt=""/>
<map id="StandardBasisStream< Field, _Vector, Trait >_map" name="StandardBasisStream< Field, _Vector, Trait >_map">
<area href="class_lin_box_1_1_vector_stream.html" title="Vector factory." alt="VectorStream< _Vector >" shape="rect" coords="0,0,272,24"/>
</map>
</div></div>
<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_standard_basis_stream.html#a5fa857ac09ffc38f37eb06850fd64e64">StandardBasisStream</a> (<a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> &F, size_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a5fa857ac09ffc38f37eb06850fd64e64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Vector & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#ac706a497284b2d01c56d1ade7b2d92f2">get</a> (Vector &v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next element. <a href="#ac706a497284b2d01c56d1ade7b2d92f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35d1a7e36292989d3574b68788d3fc08"></a><!-- doxytag: member="LinBox::StandardBasisStream::operator>>" ref="a35d1a7e36292989d3574b68788d3fc08" args="(Vector &v)" -->
<a class="el" href="class_lin_box_1_1_vector_stream.html">Self_t</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#a35d1a7e36292989d3574b68788d3fc08">operator>></a> (Vector &v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extraction operator form. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac782da1f912bceb5d8ad00c8dc892ac"></a><!-- doxytag: member="LinBox::StandardBasisStream::size" ref="aac782da1f912bceb5d8ad00c8dc892ac" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#aac782da1f912bceb5d8ad00c8dc892ac">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of vectors to be created. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af80a47b72287661cccd127d6ea9b5c36"></a><!-- doxytag: member="LinBox::StandardBasisStream::pos" ref="af80a47b72287661cccd127d6ea9b5c36" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#af80a47b72287661cccd127d6ea9b5c36">pos</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of vectors created so far. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcb9e4d7e5d718f2b007256f38fcc771"></a><!-- doxytag: member="LinBox::StandardBasisStream::dim" ref="afcb9e4d7e5d718f2b007256f38fcc771" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#afcb9e4d7e5d718f2b007256f38fcc771">dim</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dimension of the space. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa385aa18f5e42db5a415c25a90f4193d"></a><!-- doxytag: member="LinBox::StandardBasisStream::operator bool" ref="aa385aa18f5e42db5a415c25a90f4193d" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#aa385aa18f5e42db5a415c25a90f4193d">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether we have reached the end. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad20897c5c8bd47f5d4005989bead0e55"></a><!-- doxytag: member="LinBox::StandardBasisStream::reset" ref="ad20897c5c8bd47f5d4005989bead0e55" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html#ad20897c5c8bd47f5d4005989bead0e55">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the stream to start at the beginning. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8734e666421c9fe3b6380a818c6c727"></a><!-- doxytag: member="LinBox::StandardBasisStream::rewind" ref="ab8734e666421c9fe3b6380a818c6c727" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#ab8734e666421c9fe3b6380a818c6c727">rewind</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alias for reset. <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Legacy interface</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>These functions provide compatiblity with older parts of the library.</p>
<p>Their use is deprecated. </p>
</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c5d181da85e47d7f4866edde4c043ea"></a><!-- doxytag: member="LinBox::StandardBasisStream::next" ref="a8c5d181da85e47d7f4866edde4c043ea" args="(Vector &v)" -->
Vector & </td><td class="memItemRight" valign="bottom"><b>next</b> (Vector &v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0713835d510d8e47bf392d5c031070cc"></a><!-- doxytag: member="LinBox::StandardBasisStream::j" ref="a0713835d510d8e47bf392d5c031070cc" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><b>j</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a333c5a7645ab840af4f0d1683e37e04c"></a><!-- doxytag: member="LinBox::StandardBasisStream::m" ref="a333c5a7645ab840af4f0d1683e37e04c" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><b>m</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a779efe10a8564e80553431bd4d357f7a"></a><!-- doxytag: member="LinBox::StandardBasisStream::n" ref="a779efe10a8564e80553431bd4d357f7a" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><b>n</b> () const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Field, class _Vector, class Trait = typename VectorTraits<_Vector>::VectorCategory><br/>
class LinBox::StandardBasisStream< Field, _Vector, Trait ></h3>
<p>Stream for <img class="formulaInl" alt="$e_1,\cdots,e_n$" src="form_72.png"/>. </p>
<p>Generates the sequence (e_1,...,e_n) over a given field</p>
<p>This class is generic with respect to the underlying vector representation. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5fa857ac09ffc38f37eb06850fd64e64"></a><!-- doxytag: member="LinBox::StandardBasisStream::StandardBasisStream" ref="a5fa857ac09ffc38f37eb06850fd64e64" args="(Field &F, size_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_standard_basis_stream.html">StandardBasisStream</a> </td>
<td>(</td>
<td class="paramtype"><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">size_t </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Construct a new stream with the given field and vector size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td>Field over which to create vectors </td></tr>
<tr><td class="paramname">n</td><td>Size of vectors </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac706a497284b2d01c56d1ade7b2d92f2"></a><!-- doxytag: member="LinBox::StandardBasisStream::get" ref="ac706a497284b2d01c56d1ade7b2d92f2" args="(Vector &v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Vector& get </td>
<td>(</td>
<td class="paramtype">Vector & </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get next element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>Vector into which to generate vector </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to new vector </dd></dl>
<p>Implements <a class="el" href="class_lin_box_1_1_vector_stream.html#a9f81a41a876b99f640b0977ee6f3b42d">VectorStream< _Vector ></a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="stream_8h.html">stream.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>
