<!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: VectorStream< _Vector > 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_vector_stream.html">VectorStream</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">VectorStream< _Vector > Class Template Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="LinBox::VectorStream" --> <p>Vector factory. <a href="class_lin_box_1_1_vector_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 VectorStream< _Vector >:</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_vector_stream.png" usemap="#VectorStream< _Vector >_map" alt=""/> <map id="VectorStream< _Vector >_map" name="VectorStream< _Vector >_map"> <area href="class_lin_box_1_1_constant_vector_stream.html" title="Constant vector factory." alt="ConstantVectorStream< _Vector >" shape="rect" coords="586,56,1162,80"/> <area href="class_lin_box_1_1_random_dense_stream.html" title="Random dense vector stream." alt="RandomDenseStream< Field, _Vector, RandIter, Trait >" shape="rect" coords="586,112,1162,136"/> <area href="class_lin_box_1_1_random_dense_stream_3_01_field_00_01___vector_00_01_rand_iter_00_01_vector_cat589381417933a6db12f95d32a4c5da0e.html" title="Specialization of random dense stream for dense vectors." alt="RandomDenseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >" shape="rect" coords="586,168,1162,192"/> <area href="class_lin_box_1_1_random_sparse_stream.html" title="Random sparse vector stream." alt="RandomSparseStream< Field, _Vector, RandIter, Trait >" shape="rect" coords="586,224,1162,248"/> <area href="class_lin_box_1_1_random_sparse_stream_3_01_field_00_01___vector_00_01_rand_iter_00_01_vector_ca883e5ca445c8a45322c951afc9074c1d.html" title="Specialization of RandomSparseStream for dense vectors." alt="RandomSparseStream< Field, _Vector, RandIter, VectorCategories::DenseVectorTag >" shape="rect" coords="586,280,1162,304"/> <area href="class_lin_box_1_1_random_sparse_stream_3_01_field_00_01___vector_00_01_rand_iter_00_01_vector_ca076d5b0790f7cce9e4742b9ee96c71e3.html" title="Specialization of RandomSparseStream for sparse associative vectors." alt="RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseAssociativeVectorTag >" shape="rect" coords="586,336,1162,360"/> <area href="class_lin_box_1_1_random_sparse_stream_3_01_field_00_01___vector_00_01_rand_iter_00_01_vector_ca276d66c5e49e11847c8660dd91684cda.html" title="Specialization of RandomSparseStream for sparse parallel vectors." alt="RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseParallelVectorTag >" shape="rect" coords="586,392,1162,416"/> <area href="class_lin_box_1_1_random_sparse_stream_3_01_field_00_01___vector_00_01_rand_iter_00_01_vector_ca61dfcd16fddd3b2ca4b1974ad2d160c4.html" title="Specialization of RandomSparseStream for sparse sequence vectors." alt="RandomSparseStream< Field, _Vector, RandIter, VectorCategories::SparseSequenceVectorTag >" shape="rect" coords="586,448,1162,472"/> <area href="class_lin_box_1_1_standard_basis_stream.html" title="Stream for ." alt="StandardBasisStream< Field, _Vector, Trait >" shape="rect" coords="586,504,1162,528"/> <area href="class_lin_box_1_1_standard_basis_stream_3_01_field_00_01___vector_00_01_vector_categories_1_1_dense_vector_tag_01_4.html" title="Specialization of standard basis stream for dense vectors." alt="StandardBasisStream< Field, _Vector, VectorCategories::DenseVectorTag >" shape="rect" coords="586,560,1162,584"/> <area href="class_lin_box_1_1_standard_basis_stream_3_01_field_00_01___vector_00_01_vector_categories_1_1_speb533800f9a893196e1a53ada766ae00.html" title="Specialization of standard basis stream for sparse associative vectors." alt="StandardBasisStream< Field, _Vector, VectorCategories::SparseAssociativeVectorTag >" shape="rect" coords="586,616,1162,640"/> <area href="class_lin_box_1_1_standard_basis_stream_3_01_field_00_01___vector_00_01_vector_categories_1_1_sparse_parallel_vector_tag_01_4.html" title="Specialization of standard basis stream for sparse parallel vectors." alt="StandardBasisStream< Field, _Vector, VectorCategories::SparseParallelVectorTag >" shape="rect" coords="586,672,1162,696"/> <area href="class_lin_box_1_1_standard_basis_stream_3_01_field_00_01___vector_00_01_vector_categories_1_1_sparse_sequence_vector_tag_01_4.html" title="Specialization of standard basis stream for sparse sequence vectors." alt="StandardBasisStream< Field, _Vector, VectorCategories::SparseSequenceVectorTag >" shape="rect" coords="586,728,1162,752"/> </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"><a class="anchor" id="a9f81a41a876b99f640b0977ee6f3b42d"></a><!-- doxytag: member="LinBox::VectorStream::get" ref="a9f81a41a876b99f640b0977ee6f3b42d" args="(Vector &v)=0" --> virtual Vector & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#a9f81a41a876b99f640b0977ee6f3b42d">get</a> (Vector &v)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next vector from the factory and store it in v. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35d1a7e36292989d3574b68788d3fc08"></a><!-- doxytag: member="LinBox::VectorStream::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_vector_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="aa983ddaeded5756189f46428be79c631"></a><!-- doxytag: member="LinBox::VectorStream::size" ref="aa983ddaeded5756189f46428be79c631" args="() const =0" --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#aa983ddaeded5756189f46428be79c631">size</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of vectors to be constructed in this stream. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37b7fce5c38c901dfcd2da0b39caad44"></a><!-- doxytag: member="LinBox::VectorStream::pos" ref="a37b7fce5c38c901dfcd2da0b39caad44" args="() const =0" --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#a37b7fce5c38c901dfcd2da0b39caad44">pos</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of vectors constructed so far. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbe9b6a1a08a0b96bd580051976f59ca"></a><!-- doxytag: member="LinBox::VectorStream::dim" ref="adbe9b6a1a08a0b96bd580051976f59ca" args="() const =0" --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#adbe9b6a1a08a0b96bd580051976f59ca">dim</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the dimension of each vector. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aecd9240fe1fa34049e5998dd3dbc03c8"></a><!-- doxytag: member="LinBox::VectorStream::operator bool" ref="aecd9240fe1fa34049e5998dd3dbc03c8" args="() const =0" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#aecd9240fe1fa34049e5998dd3dbc03c8">operator bool</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if and only if the vector stream still has more vectors to construct. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20dcbdfbd0ec77afc802522bb7e379c1"></a><!-- doxytag: member="LinBox::VectorStream::reset" ref="a20dcbdfbd0ec77afc802522bb7e379c1" args="()=0" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_vector_stream.html#a20dcbdfbd0ec77afc802522bb7e379c1">reset</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the vector stream to the beginning. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8734e666421c9fe3b6380a818c6c727"></a><!-- doxytag: member="LinBox::VectorStream::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::VectorStream::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::VectorStream::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::VectorStream::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::VectorStream::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 _Vector><br/> class LinBox::VectorStream< _Vector ></h3> <p>Vector factory. </p> <p>This is an abstract base class that generates a sequence of vectors in a generic way. Typical uses would be in tests, where the same test might be run on a sequence of random vectors or on e_1, ..., e_n. </p> </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>