<!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: Diagonal< Field, 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_diagonal.html">Diagonal</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Diagonal< Field, Trait > 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::Diagonal" -->
<p>Random diagonal matrices are used heavily as preconditioners.
<a href="class_lin_box_1_1_diagonal.html#details">More...</a></p>
<p><code>#include <diagonal.h></code></p>
<table class="memberdecls">
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Field, class Trait = typename VectorTraits<typename LinBox::Vector<Field>::Dense>::VectorCategory><br/>
class LinBox::Diagonal< Field, Trait ></h3>
<p>Random diagonal matrices are used heavily as preconditioners. </p>
<p>This is a class of <img class="formulaInl" alt="$n \times n$" src="form_33.png"/> diagonal matrices templatized by the field in which the elements reside. The class conforms to the <a class="el" href="class_lin_box_1_1_blackbox_archetype.html">BlackboxArchetype</a>.</p>
<p>The matrix itself is not stored in memory. Rather, its <code>apply</code> methods use a vector of field elements, which are used to "multiply" the matrix to a vector.</p>
<p>This class has two template parameters. The first is the field in which the arithmetic is to be done. The second is the vector trait indicating dense or sparse vector interface (dense by default). This class is then specialized for dense and sparse vectors.</p>
<p>The default class is not implemented. It's functions should never be called because partial template specialization should always be done on the vector traits.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">Field</td><td><code><a class="el" href="namespace_lin_box.html" title="Namespace in which all linbox code resides.">LinBox</a></code> field. </td></tr>
<tr><td class="paramname">Trait</td><td>Marker whether to use dense or sparse <a class="el" href="namespace_lin_box.html" title="Namespace in which all linbox code resides.">LinBox</a> vector implementation. This is chosen by a default parameter and partial template specialization. </td></tr>
</table>
</dd>
</dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="diagonal_8h.html">diagonal.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>
