<!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: MatrixStreamReader< 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_matrix_stream_reader.html">MatrixStreamReader</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">MatrixStreamReader< Field > Class Template Reference<div class="ingroups"><a class="el" href="group__util.html">util</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::MatrixStreamReader" -->
<p>An abstract base class to represent readers for specific formats.
<a href="class_lin_box_1_1_matrix_stream_reader.html#details">More...</a></p>
<p><code>#include <matrix-stream.h></code></p>
<p>Inherited by DenseReader< Field >, MapleReader< Field >, MatrixMarketReader< Field >, SMSReader< Field >, and SparseRowReader< Field >.</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">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a144500b31544cf7c45c8562ebd9985fe">getName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a unique string describing this format. <a href="#a144500b31544cf7c45c8562ebd9985fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a7bd39d3f66a8bd19711cbda08be70108">shortName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a (possibly) shortened version of the format name. <a href="#a7bd39d3f66a8bd19711cbda08be70108"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a420de11f8d63ccb14a05a67a26d848c4">isSparse</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if this format is sparse or dense. <a href="#a420de11f8d63ccb14a05a67a26d848c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#ab96b5f108ad5cc4cf27827f3e1f98765">init</a> (const char *, std::istream *, <a class="el" href="class_lin_box_1_1_matrix_stream.html">MatrixStream</a>< Field > *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize this <a class="el" href="class_lin_box_1_1_matrix_stream_reader.html" title="An abstract base class to represent readers for specific formats.">MatrixStreamReader</a>. <a href="#ab96b5f108ad5cc4cf27827f3e1f98765"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a09e5903e16a51879a44bf13fbded46bd">nextTriple</a> (size_t &, size_t &, Element &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next triple of row index, column index, value and store it into the three referenced variables. <a href="#a09e5903e16a51879a44bf13fbded46bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a6e4921246a6ce8f13ed8ca93c1d17d65">getArray</a> (std::vector< Element > &array)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the whole matrix as a dense (row-major) array of elements. <a href="#a6e4921246a6ce8f13ed8ca93c1d17d65"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a91bdad984b82ea7e84746dfd8a76be24">saveNext</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads the next triple from the subclass nextTripleImpl method and saves it to the savedTriples std::queue rather than returning it. <a href="#a91bdad984b82ea7e84746dfd8a76be24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a40228fcdd42e304318f26fa72533bd1f">getRows</a> (size_t &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of rows in this matrix, store it in the given int. <a href="#a40228fcdd42e304318f26fa72533bd1f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a0ed31c257a82f478aff647ee42aa9444">getColumns</a> (size_t &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of columns in this matrix, store it in the given int. <a href="#a0ed31c257a82f478aff647ee42aa9444"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a406e8743b2010ba9e306242d95f81015">~MatrixStreamReader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a406e8743b2010ba9e306242d95f81015"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a79cbb12f64b01ffedd3472009f7f3a4c">saveTriple</a> (size_t m, size_t n, const Element &v)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save the triple (m,n,v) onto the savedTriples std::queue. <a href="#a79cbb12f64b01ffedd3472009f7f3a4c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a3cb77d5e8ff53325d67e2b9bbd01c2be">nextTripleImpl</a> (size_t &, size_t &, Element &)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the next triple of row index, column index, value and store it in the given references. <a href="#a3cb77d5e8ff53325d67e2b9bbd01c2be"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual MatrixStreamError </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a26b1bfbb2474a9576d3b26822104c716">initImpl</a> (const char *firstLine)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the first line of the matrix from the stream and attempt to determine if it is of this reader's type. <a href="#a26b1bfbb2474a9576d3b26822104c716"></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_matrix_stream_reader.html#ac6e9d31d836f623ea9fcde8d3e862125">MatrixStreamReader</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A protected constructor that is called automatically when subclasses are instantiated. <a href="#ac6e9d31d836f623ea9fcde8d3e862125"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69cf49cd3c5a465782feac31d508b1a7"></a><!-- doxytag: member="LinBox::MatrixStreamReader::sin" ref="a69cf49cd3c5a465782feac31d508b1a7" args="" -->
std::istream * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a69cf49cd3c5a465782feac31d508b1a7">sin</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The stream that provides the data to the reader. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lin_box_1_1_matrix_stream.html">MatrixStream</a>< Field > * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a99f0713b7fec9fc8d124269a40a21832">ms</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the <a class="el" href="class_lin_box_1_1_matrix_stream.html" title="MatrixStream.">MatrixStream</a> that is using this reader. <a href="#a99f0713b7fec9fc8d124269a40a21832"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#aef645714edf7bd944978519e2be44490">_m</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of rows in the matrix. <a href="#aef645714edf7bd944978519e2be44490"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6099ea78c231af3c4e449ea9777ea01b"></a><!-- doxytag: member="LinBox::MatrixStreamReader::knowM" ref="a6099ea78c231af3c4e449ea9777ea01b" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a6099ea78c231af3c4e449ea9777ea01b">knowM</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the row dimension is accurate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#ab9a19772e6c9097c1f9622a3f0d31cdc">_n</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of columns in the matrix. <a href="#ab9a19772e6c9097c1f9622a3f0d31cdc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a197c2ee7d0baa171f2dc0d6bffd77e2f"></a><!-- doxytag: member="LinBox::MatrixStreamReader::knowN" ref="a197c2ee7d0baa171f2dc0d6bffd77e2f" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a197c2ee7d0baa171f2dc0d6bffd77e2f">knowN</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether the column dimension is accurate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#aa25812a607b34beb46abc07646a3dd92">atEnd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Indicates that the end of the matrix has been reached; no more calls to nextTripleImpl will be made once this value is true. <a href="#aa25812a607b34beb46abc07646a3dd92"></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::MatrixStreamReader< Field ></h3>
<p>An abstract base class to represent readers for specific formats. </p>
<p>For each format that is to be supported, make an extension of this class that implements protected methods nextTripleImpl and initImpl. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac6e9d31d836f623ea9fcde8d3e862125"></a><!-- doxytag: member="LinBox::MatrixStreamReader::MatrixStreamReader" ref="ac6e9d31d836f623ea9fcde8d3e862125" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_matrix_stream_reader.html">MatrixStreamReader</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A protected constructor that is called automatically when subclasses are instantiated. </p>
</div>
</div>
<a class="anchor" id="a406e8743b2010ba9e306242d95f81015"></a><!-- doxytag: member="LinBox::MatrixStreamReader::~MatrixStreamReader" ref="a406e8743b2010ba9e306242d95f81015" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="class_lin_box_1_1_matrix_stream_reader.html">MatrixStreamReader</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a79cbb12f64b01ffedd3472009f7f3a4c"></a><!-- doxytag: member="LinBox::MatrixStreamReader::saveTriple" ref="a79cbb12f64b01ffedd3472009f7f3a4c" args="(size_t m, size_t n, const Element &v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void saveTriple </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>m</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 class="paramkey"></td>
<td></td>
<td class="paramtype">const Element & </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Save the triple (m,n,v) onto the savedTriples std::queue. </p>
</div>
</div>
<a class="anchor" id="a3cb77d5e8ff53325d67e2b9bbd01c2be"></a><!-- doxytag: member="LinBox::MatrixStreamReader::nextTripleImpl" ref="a3cb77d5e8ff53325d67e2b9bbd01c2be" args="(size_t &, size_t &, Element &)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual MatrixStreamError nextTripleImpl </td>
<td>(</td>
<td class="paramtype">size_t & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Element & </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the next triple of row index, column index, value and store it in the given references. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A MatrixStreamError indicating the success or failure of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a26b1bfbb2474a9576d3b26822104c716"></a><!-- doxytag: member="LinBox::MatrixStreamReader::initImpl" ref="a26b1bfbb2474a9576d3b26822104c716" args="(const char *firstLine)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual MatrixStreamError initImpl </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>firstLine</em></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the first line of the matrix from the stream and attempt to determine if it is of this reader's type. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A MatrixStreamError indicating the success or failure of the operation </dd></dl>
</div>
</div>
<a class="anchor" id="a144500b31544cf7c45c8562ebd9985fe"></a><!-- doxytag: member="LinBox::MatrixStreamReader::getName" ref="a144500b31544cf7c45c8562ebd9985fe" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a unique string describing this format. </p>
</div>
</div>
<a class="anchor" id="a7bd39d3f66a8bd19711cbda08be70108"></a><!-- doxytag: member="LinBox::MatrixStreamReader::shortName" ref="a7bd39d3f66a8bd19711cbda08be70108" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* shortName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a (possibly) shortened version of the format name. </p>
</div>
</div>
<a class="anchor" id="a420de11f8d63ccb14a05a67a26d848c4"></a><!-- doxytag: member="LinBox::MatrixStreamReader::isSparse" ref="a420de11f8d63ccb14a05a67a26d848c4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool isSparse </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if this format is sparse or dense. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if it is a sparse format, false if it is a dense one </dd></dl>
</div>
</div>
<a class="anchor" id="ab96b5f108ad5cc4cf27827f3e1f98765"></a><!-- doxytag: member="LinBox::MatrixStreamReader::init" ref="ab96b5f108ad5cc4cf27827f3e1f98765" args="(const char *, std::istream *, MatrixStream< Field > *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MatrixStreamError init </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>firstLine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::istream * </td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lin_box_1_1_matrix_stream.html">MatrixStream</a>< Field > * </td>
<td class="paramname"><em>m</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize this <a class="el" href="class_lin_box_1_1_matrix_stream_reader.html" title="An abstract base class to represent readers for specific formats.">MatrixStreamReader</a>. </p>
<p>Calls the initImpl method of the subclass. </p>
</div>
</div>
<a class="anchor" id="a09e5903e16a51879a44bf13fbded46bd"></a><!-- doxytag: member="LinBox::MatrixStreamReader::nextTriple" ref="a09e5903e16a51879a44bf13fbded46bd" args="(size_t &, size_t &, Element &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MatrixStreamError nextTriple </td>
<td>(</td>
<td class="paramtype">size_t & </td>
<td class="paramname"><em>m</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 class="paramkey"></td>
<td></td>
<td class="paramtype">Element & </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next triple of row index, column index, value and store it into the three referenced variables. </p>
<p>Uses the nextTripleImpl method of the subclass. </p>
</div>
</div>
<a class="anchor" id="a6e4921246a6ce8f13ed8ca93c1d17d65"></a><!-- doxytag: member="LinBox::MatrixStreamReader::getArray" ref="a6e4921246a6ce8f13ed8ca93c1d17d65" args="(std::vector< Element > &array)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MatrixStreamError getArray </td>
<td>(</td>
<td class="paramtype">std::vector< Element > & </td>
<td class="paramname"><em>array</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the whole matrix as a dense (row-major) array of elements. </p>
<p>By default, this implementation just repeatedly calls nextTriple to read in the whole matrix. Subclasses of dense formats should override this behavior. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>The array to fill with entries. May be resized as needed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a91bdad984b82ea7e84746dfd8a76be24"></a><!-- doxytag: member="LinBox::MatrixStreamReader::saveNext" ref="a91bdad984b82ea7e84746dfd8a76be24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MatrixStreamError saveNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the next triple from the subclass nextTripleImpl method and saves it to the savedTriples std::queue rather than returning it. </p>
<p>The error returned is that given from the subclass method. </p>
</div>
</div>
<a class="anchor" id="a40228fcdd42e304318f26fa72533bd1f"></a><!-- doxytag: member="LinBox::MatrixStreamReader::getRows" ref="a40228fcdd42e304318f26fa72533bd1f" args="(size_t &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MatrixStreamError getRows </td>
<td>(</td>
<td class="paramtype">size_t & </td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of rows in this matrix, store it in the given int. </p>
</div>
</div>
<a class="anchor" id="a0ed31c257a82f478aff647ee42aa9444"></a><!-- doxytag: member="LinBox::MatrixStreamReader::getColumns" ref="a0ed31c257a82f478aff647ee42aa9444" args="(size_t &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MatrixStreamError getColumns </td>
<td>(</td>
<td class="paramtype">size_t & </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of columns in this matrix, store it in the given int. </p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a99f0713b7fec9fc8d124269a40a21832"></a><!-- doxytag: member="LinBox::MatrixStreamReader::ms" ref="a99f0713b7fec9fc8d124269a40a21832" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_matrix_stream.html">MatrixStream</a><Field>* <a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#a99f0713b7fec9fc8d124269a40a21832">ms</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A pointer to the <a class="el" href="class_lin_box_1_1_matrix_stream.html" title="MatrixStream.">MatrixStream</a> that is using this reader. </p>
<p>Useful to get an instance of the field via ms->getField(). </p>
</div>
</div>
<a class="anchor" id="aef645714edf7bd944978519e2be44490"></a><!-- doxytag: member="LinBox::MatrixStreamReader::_m" ref="aef645714edf7bd944978519e2be44490" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#aef645714edf7bd944978519e2be44490">_m</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The number of rows in the matrix. </p>
<p>This will be set by default to 0. </p>
</div>
</div>
<a class="anchor" id="ab9a19772e6c9097c1f9622a3f0d31cdc"></a><!-- doxytag: member="LinBox::MatrixStreamReader::_n" ref="ab9a19772e6c9097c1f9622a3f0d31cdc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#ab9a19772e6c9097c1f9622a3f0d31cdc">_n</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Number of columns in the matrix. </p>
<p>Similar requirements as _m above. </p>
</div>
</div>
<a class="anchor" id="aa25812a607b34beb46abc07646a3dd92"></a><!-- doxytag: member="LinBox::MatrixStreamReader::atEnd" ref="aa25812a607b34beb46abc07646a3dd92" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="class_lin_box_1_1_matrix_stream_reader.html#aa25812a607b34beb46abc07646a3dd92">atEnd</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicates that the end of the matrix has been reached; no more calls to nextTripleImpl will be made once this value is true. </p>
<p>This will automatically be set to true if nextTripleImpl returns END_OF_MATRIX. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>matrix-stream.h</li>
<li>matrix-stream.inl</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>
