<!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: MatrixArchetype< _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_matrix_archetype.html">MatrixArchetype</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">MatrixArchetype< _Element > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::MatrixArchetype" -->
<p>Directly-represented matrix archetype.
<a href="class_lin_box_1_1_matrix_archetype.html#details">More...</a></p>
<p><code>#include <archetype.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"><a class="anchor" id="a5f4d6b7c46a302eac234faded85ce24e"></a><!-- doxytag: member="LinBox::MatrixArchetype::MatrixArchetype" ref="a5f4d6b7c46a302eac234faded85ce24e" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a5f4d6b7c46a302eac234faded85ce24e">MatrixArchetype</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Empty Constructor. <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_archetype.html#ac3958a9b1f26ff761794695763943d69">MatrixArchetype</a> (size_t m, size_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor with size. <a href="#ac3958a9b1f26ff761794695763943d69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab47017c00f5156fefd6e14866f680927"></a><!-- doxytag: member="LinBox::MatrixArchetype::MatrixArchetype" ref="ab47017c00f5156fefd6e14866f680927" args="(const MatrixArchetype &M)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#ab47017c00f5156fefd6e14866f680927">MatrixArchetype</a> (const <a class="el" href="class_lin_box_1_1_matrix_archetype.html">MatrixArchetype</a> &M)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a7161d6f70e37ed2aab8e95f413ab27"></a><!-- doxytag: member="LinBox::MatrixArchetype::operator=" ref="a1a7161d6f70e37ed2aab8e95f413ab27" args="(const MatrixArchetype &M)" -->
<a class="el" href="class_lin_box_1_1_matrix_archetype.html">MatrixArchetype</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a1a7161d6f70e37ed2aab8e95f413ab27">operator=</a> (const <a class="el" href="class_lin_box_1_1_matrix_archetype.html">MatrixArchetype</a> &M)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator =. <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_archetype.html#a0fee90e6b8ef7fcd8d76a7f3e1f268e6">rowdim</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of rows in the matrix. <a href="#a0fee90e6b8ef7fcd8d76a7f3e1f268e6"></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_archetype.html#a32edb490d3597f5553152d14b102e227">coldim</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of columns in the matrix. <a href="#a32edb490d3597f5553152d14b102e227"></a><br/></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_archetype.html#a3a8bed9f6c686f88097b3997148d0f01">resize</a> (size_t m, size_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resize the matrix to the given dimensions. <a href="#a3a8bed9f6c686f88097b3997148d0f01"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Row </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a443b28c1930db3fb8a8b0a5da0a69972">operator[]</a> (size_t i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a reference to a row. <a href="#a443b28c1930db3fb8a8b0a5da0a69972"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a229b646e8ec107a14b81a4bc29bedd25"></a><!-- doxytag: member="LinBox::MatrixArchetype::operator[]" ref="a229b646e8ec107a14b81a4bc29bedd25" args="(size_t i) const " -->
ConstRow </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a229b646e8ec107a14b81a4bc29bedd25">operator[]</a> (size_t i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">const version <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Input and output</div></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class Field > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::istream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#aaad98743ee739c9f451145c8a26d03fc">read</a> (std::istream &file, const <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> &F)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the matrix from an input stream. <a href="#aaad98743ee739c9f451145c8a26d03fc"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class Field > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::ostream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a531ee46aa633ea119c4650b48bc9724c">write</a> (std::ostream &os, const <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> &F) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the matrix to an output stream. <a href="#a531ee46aa633ea119c4650b48bc9724c"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Access to matrix elements</div></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_archetype.html#aa125275fb11b55df52933a488ca9a6f3">setEntry</a> (size_t i, size_t j, const Element &a_ij)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the entry at the (i, j) position to a_ij. <a href="#aa125275fb11b55df52933a488ca9a6f3"></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_matrix_archetype.html#a626f1fbac5cfe5468da6581c54256825">refEntry</a> (size_t i, size_t j)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a writeable reference to the entry in the (i, j) position. <a href="#a626f1fbac5cfe5468da6581c54256825"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const Element & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a725d135bb8767ea6769811242e20685b">getEntry</a> (size_t i, size_t j) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a read-only reference to the entry in the (i, j) position. <a href="#a725d135bb8767ea6769811242e20685b"></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_matrix_archetype.html#a7175207b21737a612ed84ec9c4c4321a">getEntry</a> (Element &x, size_t i, size_t j) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the (i, j) entry into x, and return a reference to x. <a href="#a7175207b21737a612ed84ec9c4c4321a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a4fedb8afc38347e55b61627601f5ae"></a><!-- doxytag: member="LinBox::MatrixArchetype::rowBegin" ref="a5a4fedb8afc38347e55b61627601f5ae" args="()" -->
RowIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a5a4fedb8afc38347e55b61627601f5ae">rowBegin</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">rowBegin <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabcd25932383b9ccae6bdfd9ad4fc041"></a><!-- doxytag: member="LinBox::MatrixArchetype::rowEnd" ref="aabcd25932383b9ccae6bdfd9ad4fc041" args="()" -->
RowIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#aabcd25932383b9ccae6bdfd9ad4fc041">rowEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">rowEnd <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a40a362d8acb3f92c31be15324e5493"></a><!-- doxytag: member="LinBox::MatrixArchetype::rowBegin" ref="a7a40a362d8acb3f92c31be15324e5493" args="() const " -->
ConstRowIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a7a40a362d8acb3f92c31be15324e5493">rowBegin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">const rowBegin <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fc30a1223bfb760259ab3a0e661a37c"></a><!-- doxytag: member="LinBox::MatrixArchetype::rowEnd" ref="a1fc30a1223bfb760259ab3a0e661a37c" args="() const " -->
ConstRowIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a1fc30a1223bfb760259ab3a0e661a37c">rowEnd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">const rowEnd <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td colspan="2"><div class="groupHeader">Computing matrix information</div></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class Vector > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">Vector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a9ace56625d76410e60e7708977c23a6e">columnDensity</a> (Vector &v) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the column density, i.e. <a href="#a9ace56625d76410e60e7708977c23a6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88dddd361789cf44948718d49e4d8f97"></a><!-- doxytag: member="LinBox::MatrixArchetype::transpose" ref="a88dddd361789cf44948718d49e4d8f97" args="(MatrixArchetype &M) const " -->
<a class="el" href="class_lin_box_1_1_matrix_archetype.html">MatrixArchetype</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a88dddd361789cf44948718d49e4d8f97">transpose</a> (<a class="el" href="class_lin_box_1_1_matrix_archetype.html">MatrixArchetype</a> &M) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute the transpose. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69da390cc58b7949adef750be8cc1ad8"></a><!-- doxytag: member="LinBox::MatrixArchetype::Column" ref="a69da390cc58b7949adef750be8cc1ad8" args="" -->
typedef Col </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a69da390cc58b7949adef750be8cc1ad8">Column</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">colBegin <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88fd4d1c152c519d225d56d184c825d6"></a><!-- doxytag: member="LinBox::MatrixArchetype::ConstColumn" ref="a88fd4d1c152c519d225d56d184c825d6" args="" -->
typedef ConstCol </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a88fd4d1c152c519d225d56d184c825d6">ConstColumn</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">colBegin <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10e4a1e88c9cd83cbc7a450fac396b67"></a><!-- doxytag: member="LinBox::MatrixArchetype::colBegin" ref="a10e4a1e88c9cd83cbc7a450fac396b67" args="()" -->
ColIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a10e4a1e88c9cd83cbc7a450fac396b67">colBegin</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">colBegin <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86303da83fe6f80370171559d3c5e8fe"></a><!-- doxytag: member="LinBox::MatrixArchetype::colEnd" ref="a86303da83fe6f80370171559d3c5e8fe" args="()" -->
ColIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#a86303da83fe6f80370171559d3c5e8fe">colEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">colEnd <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae75931c69f52d341d1dc246416f030f3"></a><!-- doxytag: member="LinBox::MatrixArchetype::colBegin" ref="ae75931c69f52d341d1dc246416f030f3" args="() const " -->
ConstColIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#ae75931c69f52d341d1dc246416f030f3">colBegin</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">const colBegin <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afbd54e30362eccecc7fe287046200de0"></a><!-- doxytag: member="LinBox::MatrixArchetype::colEnd" ref="afbd54e30362eccecc7fe287046200de0" args="() const " -->
ConstColIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_matrix_archetype.html#afbd54e30362eccecc7fe287046200de0">colEnd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">const colEnd <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::MatrixArchetype< _Element ></h3>
<p>Directly-represented matrix archetype. </p>
<p>This archetype gives the common interface for matrices that have direct representations. The matrices are required to provide iterators to access and manipulate their entries, but not any matrix-matrix or matrix-vector arithmetic. That is, they are pure containers. As such, they are only parameterized on the element type, not on the field type. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac3958a9b1f26ff761794695763943d69"></a><!-- doxytag: member="LinBox::MatrixArchetype::MatrixArchetype" ref="ac3958a9b1f26ff761794695763943d69" args="(size_t m, 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_matrix_archetype.html">MatrixArchetype</a> </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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor with size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>row dimension </td></tr>
<tr><td class="paramname">n</td><td>column dimension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0fee90e6b8ef7fcd8d76a7f3e1f268e6"></a><!-- doxytag: member="LinBox::MatrixArchetype::rowdim" ref="a0fee90e6b8ef7fcd8d76a7f3e1f268e6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t rowdim </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of rows in the matrix. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of rows in matrix </dd></dl>
</div>
</div>
<a class="anchor" id="a32edb490d3597f5553152d14b102e227"></a><!-- doxytag: member="LinBox::MatrixArchetype::coldim" ref="a32edb490d3597f5553152d14b102e227" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t coldim </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of columns in the matrix. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of columns in matrix </dd></dl>
</div>
</div>
<a class="anchor" id="a3a8bed9f6c686f88097b3997148d0f01"></a><!-- doxytag: member="LinBox::MatrixArchetype::resize" ref="a3a8bed9f6c686f88097b3997148d0f01" args="(size_t m, size_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void resize </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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resize the matrix to the given dimensions. </p>
<p>The state of the matrix's entries after a call to this method is undefined.</p>
<p>This interface is optional; a matrix can omit it if it makes no sense in the context.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td>Number of rows </td></tr>
<tr><td class="paramname">n</td><td>Number of columns </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaad98743ee739c9f451145c8a26d03fc"></a><!-- doxytag: member="LinBox::MatrixArchetype::read" ref="aaad98743ee739c9f451145c8a26d03fc" args="(std::istream &file, const Field &F)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::istream& read </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the matrix from an input stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>Input stream from which to read </td></tr>
<tr><td class="paramname">F</td><td>Field over which to read </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a531ee46aa633ea119c4650b48bc9724c"></a><!-- doxytag: member="LinBox::MatrixArchetype::write" ref="a531ee46aa633ea119c4650b48bc9724c" args="(std::ostream &os, const Field &F) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream& write </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <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></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write the matrix to an output stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>Output stream to which to write </td></tr>
<tr><td class="paramname">F</td><td>Field over which to write </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa125275fb11b55df52933a488ca9a6f3"></a><!-- doxytag: member="LinBox::MatrixArchetype::setEntry" ref="aa125275fb11b55df52933a488ca9a6f3" args="(size_t i, size_t j, const Element &a_ij)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setEntry </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>j</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Element & </td>
<td class="paramname"><em>a_ij</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the entry at the (i, j) position to a_ij. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Row number, 0...rowdim () - 1 </td></tr>
<tr><td class="paramname">j</td><td>Column number 0...coldim () - 1 </td></tr>
<tr><td class="paramname">a_ij</td><td>Element to set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a626f1fbac5cfe5468da6581c54256825"></a><!-- doxytag: member="LinBox::MatrixArchetype::refEntry" ref="a626f1fbac5cfe5468da6581c54256825" args="(size_t i, size_t j)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Element& refEntry </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>j</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a writeable reference to the entry in the (i, j) position. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Row index of entry </td></tr>
<tr><td class="paramname">j</td><td>Column index of entry </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to matrix entry </dd></dl>
</div>
</div>
<a class="anchor" id="a725d135bb8767ea6769811242e20685b"></a><!-- doxytag: member="LinBox::MatrixArchetype::getEntry" ref="a725d135bb8767ea6769811242e20685b" args="(size_t i, size_t j) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const Element& getEntry </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>j</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a read-only reference to the entry in the (i, j) position. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Row index </td></tr>
<tr><td class="paramname">j</td><td>Column index </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Const reference to matrix entry </dd></dl>
</div>
</div>
<a class="anchor" id="a7175207b21737a612ed84ec9c4c4321a"></a><!-- doxytag: member="LinBox::MatrixArchetype::getEntry" ref="a7175207b21737a612ed84ec9c4c4321a" args="(Element &x, size_t i, size_t j) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Element& getEntry </td>
<td>(</td>
<td class="paramtype">Element & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>j</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy the (i, j) entry into x, and return a reference to x. </p>
<p>This form is more in the Linbox style and is provided for interface compatibility with other parts of the library </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>Element in which to store result </td></tr>
<tr><td class="paramname">i</td><td>Row index </td></tr>
<tr><td class="paramname">j</td><td>Column index </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to x </dd></dl>
</div>
</div>
<a class="anchor" id="a443b28c1930db3fb8a8b0a5da0a69972"></a><!-- doxytag: member="LinBox::MatrixArchetype::operator[]" ref="a443b28c1930db3fb8a8b0a5da0a69972" args="(size_t i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Row operator[] </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>i</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a reference to a row. </p>
<p>Since rows may also be indexed, this allows A[i][j] notation to be used.</p>
<p>This may be omitted by an implementation if no Row type is available</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>Row index </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9ace56625d76410e60e7708977c23a6e"></a><!-- doxytag: member="LinBox::MatrixArchetype::columnDensity" ref="a9ace56625d76410e60e7708977c23a6e" args="(Vector &v) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Vector& columnDensity </td>
<td>(</td>
<td class="paramtype">Vector & </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compute the column density, i.e. </p>
<p>the number of entries per column </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="matrix_2archetype_8h.html">matrix/archetype.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>
