<!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: LanczosSolver< Field, Vector > 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_lanczos_solver.html">LanczosSolver</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">LanczosSolver< Field, Vector > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="LinBox::LanczosSolver" -->
<p>Solve a linear system using the conjugate Lanczos iteration.
<a href="class_lin_box_1_1_lanczos_solver.html#details">More...</a></p>
<p><code>#include <lanczos.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lin_box_1_1_lanczos_solver.html#a33b9f10d4e88bfda77d15e5cdde326e8">LanczosSolver</a> (const <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> &F, const LanczosTraits &traits)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a33b9f10d4e88bfda77d15e5cdde326e8"></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_lanczos_solver.html#abdad27cf50d6de3b96a1e7b6e44299d8">LanczosSolver</a> (const <a class="el" href="class_lin_box_1_1_modular_3_01uint32__t_01_4.html">Field</a> &F, const LanczosTraits &traits, typename Field::RandIter r)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor with a random iterator. <a href="#abdad27cf50d6de3b96a1e7b6e44299d8"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class Blackbox > </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_lanczos_solver.html#a516c425f630dc0512d4303aee30bebe1">solve</a> (const Blackbox &A, Vector &x, const Vector &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Solve the linear system Ax = b. <a href="#a516c425f630dc0512d4303aee30bebe1"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class Field, class Vector><br/>
class LinBox::LanczosSolver< Field, Vector ></h3>
<p>Solve a linear system using the conjugate Lanczos iteration. </p>
<p>Lanczos system solver class. This class encapsulates the functionality required for solving a linear system through the conjugate Lanczos iteration </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a33b9f10d4e88bfda77d15e5cdde326e8"></a><!-- doxytag: member="LinBox::LanczosSolver::LanczosSolver" ref="a33b9f10d4e88bfda77d15e5cdde326e8" args="(const Field &F, const LanczosTraits &traits)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_lanczos_solver.html">LanczosSolver</a> </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 class="paramkey"></td>
<td></td>
<td class="paramtype">const LanczosTraits & </td>
<td class="paramname"><em>traits</em> </td>
</tr>
<tr>
<td></td>
<td>)</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">F</td><td>Field over which to operate </td></tr>
<tr><td class="paramname">traits</td><td><a class="el" href="struct_lin_box_1_1_solver_traits.html">SolverTraits</a> structure describing user options for the solver </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abdad27cf50d6de3b96a1e7b6e44299d8"></a><!-- doxytag: member="LinBox::LanczosSolver::LanczosSolver" ref="abdad27cf50d6de3b96a1e7b6e44299d8" args="(const Field &F, const LanczosTraits &traits, typename Field::RandIter r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lin_box_1_1_lanczos_solver.html">LanczosSolver</a> </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 class="paramkey"></td>
<td></td>
<td class="paramtype">const LanczosTraits & </td>
<td class="paramname"><em>traits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename Field::RandIter </td>
<td class="paramname"><em>r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor with a random iterator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">F</td><td>Field over which to operate </td></tr>
<tr><td class="paramname">traits</td><td><a class="el" href="struct_lin_box_1_1_solver_traits.html">SolverTraits</a> structure describing user options for the solver </td></tr>
<tr><td class="paramname">r</td><td>Random iterator to use for randomization </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a516c425f630dc0512d4303aee30bebe1"></a><!-- doxytag: member="LinBox::LanczosSolver::solve" ref="a516c425f630dc0512d4303aee30bebe1" args="(const Blackbox &A, Vector &x, const Vector &b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Vector& solve </td>
<td>(</td>
<td class="paramtype">const Blackbox & </td>
<td class="paramname"><em>A</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Vector & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Vector & </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Solve the linear system Ax = b. </p>
<p>If the system is nonsingular, this method computes the unique solution to the system Ax = b. If the system is singular, it computes a random solution.</p>
<p>If the matrix A is nonsymmetric, this method preconditions the matrix A with the preconditioner D_1 A^T D_2 A D_1, where D_1 and D_2 are random nonsingular diagonal matrices. If the matrix A is symmetric, this method preconditions the system with A D, where D is a random diagonal matrix.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">A</td><td>Black box for the matrix A </td></tr>
<tr><td class="paramname">x</td><td>Vector in which to store solution </td></tr>
<tr><td class="paramname">b</td><td>Right-hand side of system </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to solution vector </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>lanczos.h</li>
<li>lanczos.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>
