<!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: SolverTraits Struct 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="struct_lin_box_1_1_solver_traits.html">SolverTraits</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">SolverTraits Struct Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::SolverTraits" --><!-- doxytag: inherits="LinBox::Specifier" -->
<p>Solver traits.
<a href="struct_lin_box_1_1_solver_traits.html#details">More...</a></p>
<p><code>#include <methods.h></code></p>
<p>Inherits Specifier.</p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>SingularState</b> </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the system is known to be singular or nonsingular. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Preconditioner</b> </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Which preconditioner to use to ensure generic rank profile. <a href="struct_lin_box_1_1_specifier.html#adac1c2aa74e98e485c02f73279b71a38">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>BlackboxShape</b> </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Other shapes : UNIMOD_UT -- unimodular upper triang. <a href="struct_lin_box_1_1_specifier.html#a10bccb4962de1967ea97f76ad855a818">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the rank of the system is known (otherwise its value) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the system is known to be symmetric. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Whether the probabilistic computation has to be certified Las-Vegas. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>PivotStrategy</b> </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Linear-time pivoting or not for eliminations. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc502ceb64dbfee25eb4d3f49aa4b8f7"></a><!-- doxytag: member="LinBox::SolverTraits::Shape" ref="adc502ceb64dbfee25eb4d3f49aa4b8f7" args="" -->
typedef InheritEnum<br class="typebreak"/>
< BlackboxShape, <br class="typebreak"/>
Preconditioner > </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_specifier.html#adc502ceb64dbfee25eb4d3f49aa4b8f7">Shape</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shape of a Blackbox Precontioner shapes and other blackbox shape are combined. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_solver_traits.html#a05b7ef2f27e360beb6391b843247436c">SolverTraits</a> (bool CheckResult=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a05b7ef2f27e360beb6391b843247436c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_solver_traits.html#a514f67a5ae239e06f15176eed6e5a646">SolverTraits</a> (const Specifier &S)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a MethodTraits structure. <a href="#a514f67a5ae239e06f15176eed6e5a646"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Preconditioner </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_specifier.html#aaf1d4f7ebe8392ce46e8c9d77e7eb9e1">preconditioner</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accessors. <a href="#aaf1d4f7ebe8392ce46e8c9d77e7eb9e1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_lin_box_1_1_specifier.html#ad7b9b321a4b576b8e788e44e0147e66e">preconditioner</a> (Preconditioner p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Manipulators. <a href="#ad7b9b321a4b576b8e788e44e0147e66e"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Solver traits. </p>
<p>User-specified parameters for solving a linear system. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="adac1c2aa74e98e485c02f73279b71a38"></a><!-- doxytag: member="LinBox::SolverTraits::Preconditioner" ref="adac1c2aa74e98e485c02f73279b71a38" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum Preconditioner<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Which preconditioner to use to ensure generic rank profile. </p>
<p>NO_PRECONDITIONER - Do not use any preconditioner BUTTERFLY - Use a butterfly network, see <a class="el" href="class_lin_box_1_1_butterfly.html">Butterfly</a> SPARSE - Use a sparse preconditioner, c.f. (Mulders 2000) TOEPLITZ - Use a <a class="el" href="class_lin_box_1_1_toeplitz.html" title="This is the blackbox representation of a Toeplitz matrix.">Toeplitz</a> preconditioner, c.f. (Kaltofen and Saunders 1991) SYMMETRIZE - Use A^T A (Lanczos only) PARTIAL_DIAGONAL - Use AD, where D is a random nonsingular diagonal matrix (Lanczos only) PARTIAL_DIAGONAL_SYMMETRIZE - Use A^T D A, where D is a random nonsingular diagonal matrix (Lanczos only) FULL_DIAGONAL - Use D_1 A^T D_2 A D_1, where D_1 and D_2 are random nonsingular diagonal matrices (Lanczos only) DENSE (Dixon use) </p>
</div>
</div>
<a class="anchor" id="a10bccb4962de1967ea97f76ad855a818"></a><!-- doxytag: member="LinBox::SolverTraits::BlackboxShape" ref="a10bccb4962de1967ea97f76ad855a818" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum BlackboxShape<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Other shapes : UNIMOD_UT -- unimodular upper triang. </p>
<p><a class="el" href="class_lin_box_1_1_toeplitz.html" title="This is the blackbox representation of a Toeplitz matrix.">Toeplitz</a> UNIMOD_LT -- unimodular lower triang. <a class="el" href="class_lin_box_1_1_toeplitz.html" title="This is the blackbox representation of a Toeplitz matrix.">Toeplitz</a> UNIMOD_UH -- unimodular upper triang. Hankel UNIMOD_LH -- unimodular lower triang. Hankel </p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a05b7ef2f27e360beb6391b843247436c"></a><!-- doxytag: member="LinBox::SolverTraits::SolverTraits" ref="a05b7ef2f27e360beb6391b843247436c" args="(bool CheckResult=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_lin_box_1_1_solver_traits.html">SolverTraits</a> </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>CheckResult</em> = <code>true</code></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">checkResult</td><td>True if and only if the solution should be checked for correctness after it is computed (very much recommended for the randomized algorithms Wiedemann and Lanczos); default is true </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a514f67a5ae239e06f15176eed6e5a646"></a><!-- doxytag: member="LinBox::SolverTraits::SolverTraits" ref="a514f67a5ae239e06f15176eed6e5a646" args="(const Specifier &S)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_lin_box_1_1_solver_traits.html">SolverTraits</a> </td>
<td>(</td>
<td class="paramtype">const Specifier & </td>
<td class="paramname"><em>S</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor from a MethodTraits structure. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">S</td><td>MethodTraits structure from which to get defaults </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaf1d4f7ebe8392ce46e8c9d77e7eb9e1"></a><!-- doxytag: member="LinBox::SolverTraits::preconditioner" ref="aaf1d4f7ebe8392ce46e8c9d77e7eb9e1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Preconditioner preconditioner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accessors. </p>
<p>These functions just return the corresponding parameters from the structure </p>
</div>
</div>
<a class="anchor" id="ad7b9b321a4b576b8e788e44e0147e66e"></a><!-- doxytag: member="LinBox::SolverTraits::preconditioner" ref="ad7b9b321a4b576b8e788e44e0147e66e" args="(Preconditioner p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void preconditioner </td>
<td>(</td>
<td class="paramtype">Preconditioner </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [inline, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Manipulators. </p>
<p>These functions allow on-the-fly modification of a <a class="el" href="struct_lin_box_1_1_solver_traits.html" title="Solver traits.">SolverTraits</a> structure. Note that it is guaranteed that your <a class="el" href="struct_lin_box_1_1_solver_traits.html" title="Solver traits.">SolverTraits</a> structure will not be modified during <a class="el" href="namespace_lin_box.html#a353c2c55c4d1fd5b35e9b4e04c274982">solve</a>. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="methods_8h.html">methods.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>
