<!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: ScalarMatrix< _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_scalar_matrix.html">ScalarMatrix</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">ScalarMatrix< _Field > Class Template Reference<div class="ingroups"><a class="el" href="group__blackbox.html">blackbox</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::ScalarMatrix" --><!-- doxytag: inherits="LinBox::BlackboxInterface" -->
<p>Blackbox for <code>aI</code>.
<a href="class_lin_box_1_1_scalar_matrix.html#details">More...</a></p>
<p><code>#include <scalar-matrix.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 ScalarMatrix< _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_scalar_matrix.png" usemap="#ScalarMatrix< _Field >_map" alt=""/>
<map id="ScalarMatrix< _Field >_map" name="ScalarMatrix< _Field >_map">
<area href="class_lin_box_1_1_blackbox_interface.html" title="This blackbox base class exists solely to aid documentation organization." alt="BlackboxInterface" shape="rect" coords="0,0,143,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"><a class="anchor" id="a4a231c3eeb97c56aef378d84454ef59f"></a><!-- doxytag: member="LinBox::ScalarMatrix::ScalarMatrix" ref="a4a231c3eeb97c56aef378d84454ef59f" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_scalar_matrix.html#a4a231c3eeb97c56aef378d84454ef59f">ScalarMatrix</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs an initially 0 by 0 matrix. <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_scalar_matrix.html#af776e22d4e22d70d33d26e8a84bc9a30">ScalarMatrix</a> (const Field &F, const size_t n, const Element &s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scalar matrix Constructor from an element. <a href="#af776e22d4e22d70d33d26e8a84bc9a30"></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_scalar_matrix.html#a13afd75a8c63ae22c3f22e62c076240d">ScalarMatrix</a> (const Field &F, const size_t n, const typename Field::RandIter &iter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a random element. <a href="#a13afd75a8c63ae22c3f22e62c076240d"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class OutVector , class InVector > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">OutVector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_scalar_matrix.html#a1d5749b0b440c205a58fcf903a1b3b81">apply</a> (OutVector &y, InVector &x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Application of BlackBox matrix. <a href="#a1d5749b0b440c205a58fcf903a1b3b81"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class OutVector , class InVector > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">OutVector & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_scalar_matrix.html#a225d1558b88cc33dcf4f17f055e89f1a">applyTranspose</a> (OutVector &y, InVector &x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Application of BlackBox matrix transpose. <a href="#a225d1558b88cc33dcf4f17f055e89f1a"></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::ScalarMatrix< _Field ></h3>
<p>Blackbox for <code>aI</code>. </p>
<p>Use particularly for representing <code>0</code> and <code>I</code>.</p>
<p>This is a class of blackbox square scalar matrices. Each scalar matrix occupies O(scalar-size) memory. The matrix itself is not stored in memory, just the scalar and the dimensions. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af776e22d4e22d70d33d26e8a84bc9a30"></a><!-- doxytag: member="LinBox::ScalarMatrix::ScalarMatrix" ref="af776e22d4e22d70d33d26e8a84bc9a30" args="(const Field &F, const size_t n, const Element &s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_scalar_matrix.html">ScalarMatrix</a> </td>
<td>(</td>
<td class="paramtype">const Field & </td>
<td class="paramname"><em>F</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const 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>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scalar matrix Constructor from an element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td>field in which to do arithmetic. </td></tr>
<tr><td class="paramname">n</td><td>size of the matrix. </td></tr>
<tr><td class="paramname">s</td><td>scalar, a field element, to be used as the diagonal of the matrix. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a13afd75a8c63ae22c3f22e62c076240d"></a><!-- doxytag: member="LinBox::ScalarMatrix::ScalarMatrix" ref="a13afd75a8c63ae22c3f22e62c076240d" args="(const Field &F, const size_t n, const typename Field::RandIter &iter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_scalar_matrix.html">ScalarMatrix</a> </td>
<td>(</td>
<td class="paramtype">const Field & </td>
<td class="paramname"><em>F</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const typename Field::RandIter & </td>
<td class="paramname"><em>iter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from a random element. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td>field in which to do arithmetic. </td></tr>
<tr><td class="paramname">n</td><td>size of the matrix. </td></tr>
<tr><td class="paramname">iter</td><td>Random iterator from which to get the diagonal scalar element. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1d5749b0b440c205a58fcf903a1b3b81"></a><!-- doxytag: member="LinBox::ScalarMatrix::apply" ref="a1d5749b0b440c205a58fcf903a1b3b81" args="(OutVector &y, InVector &x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OutVector& apply </td>
<td>(</td>
<td class="paramtype">OutVector & </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InVector & </td>
<td class="paramname"><em>x</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Application of BlackBox matrix. </p>
<p>y= A*x. Requires time linear in n, the size of the matrix. </p>
</div>
</div>
<a class="anchor" id="a225d1558b88cc33dcf4f17f055e89f1a"></a><!-- doxytag: member="LinBox::ScalarMatrix::applyTranspose" ref="a225d1558b88cc33dcf4f17f055e89f1a" args="(OutVector &y, InVector &x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OutVector& applyTranspose </td>
<td>(</td>
<td class="paramtype">OutVector & </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">InVector & </td>
<td class="paramname"><em>x</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Application of BlackBox matrix transpose. </p>
<p>y= transpose(A)*x. Requires time linear in n, the size of the matrix. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>scalar-matrix.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>
