csharpfftfsharpintegrationinterpolationlinear-algebramathdifferentiationmatrixnumericsrandomregressionstatisticsmathnet
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
237 lines
10 KiB
237 lines
10 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>IPreconditioner<T> - Math.NET Numerics Documentation</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|
<link type="text/css" rel="stylesheet" href="../main.css"/>
|
|
<script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
|
|
<script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
|
|
<script type="text/javascript" src="../js/navigation.js"></script>
|
|
<script type="text/javascript" src="../js/example.js"></script>
|
|
</head>
|
|
<body><div id="namespaces">
|
|
<h2 class="fixed">Namespaces</h2>
|
|
<div class="scroll">
|
|
<ul>
|
|
<li>
|
|
<a href="../MathNet.Numerics/index.htm">MathNet.Numerics</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/index.htm">MathNet.Numerics.Differentiation</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Distributions/index.htm">MathNet.Numerics.Distributions</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Financial/index.htm">MathNet.Numerics.Financial</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.IntegralTransforms/index.htm">MathNet.Numerics.IntegralTransforms</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Integration/index.htm">MathNet.Numerics.Integration</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Interpolation/index.htm">MathNet.Numerics.Interpolation</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra/index.htm">MathNet.Numerics.LinearAlgebra</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex/index.htm">MathNet.Numerics.LinearAlgebra.Complex</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex32/index.htm">MathNet.Numerics.LinearAlgebra.Complex32</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex32.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Double/index.htm">MathNet.Numerics.LinearAlgebra.Double</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Double.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Factorization/index.htm">MathNet.Numerics.LinearAlgebra.Factorization</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Single/index.htm">MathNet.Numerics.LinearAlgebra.Single</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Single.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/index.htm" class="current">MathNet.Numerics.LinearAlgebra.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Storage/index.htm">MathNet.Numerics.LinearAlgebra.Storage</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearRegression/index.htm">MathNet.Numerics.LinearRegression</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.OdeSolvers/index.htm">MathNet.Numerics.OdeSolvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization/index.htm">MathNet.Numerics.Optimization</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization.LineSearch/index.htm">MathNet.Numerics.Optimization.LineSearch</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm">MathNet.Numerics.Optimization.ObjectiveFunctions</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization.TrustRegion/index.htm">MathNet.Numerics.Optimization.TrustRegion</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers/index.htm">MathNet.Numerics.Providers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers.FourierTransform/index.htm">MathNet.Numerics.Providers.FourierTransform</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers.LinearAlgebra/index.htm">MathNet.Numerics.Providers.LinearAlgebra</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers.SparseSolver/index.htm">MathNet.Numerics.Providers.SparseSolver</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Random/index.htm">MathNet.Numerics.Random</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.RootFinding/index.htm">MathNet.Numerics.RootFinding</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Statistics/index.htm">MathNet.Numerics.Statistics</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Statistics.Mcmc/index.htm">MathNet.Numerics.Statistics.Mcmc</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><div id="types">
|
|
<h2 class="fixed">Types in MathNet.Numerics.LinearAlgebra.Solvers</h2>
|
|
<div class="scroll">
|
|
<ul>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/CancellationStopCriterion`1.htm">CancellationStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/DelegateStopCriterion`1.htm">DelegateStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/DivergenceStopCriterion`1.htm">DivergenceStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/FailureStopCriterion`1.htm">FailureStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/IIterationStopCriterion`1.htm">IIterationStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolver`1.htm">IIterativeSolver<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolverSetup`1.htm">IIterativeSolverSetup<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm" class="current">IPreconditioner<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/IterationCountStopCriterion`1.htm">IterationCountStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm">IterationStatus</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/ResidualStopCriterion`1.htm">ResidualStopCriterion<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/SolverSetup`1.htm">SolverSetup<T></a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/UnitPreconditioner`1.htm">UnitPreconditioner<T></a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<p class="class"><strong>Type</strong> IPreconditioner<T></p>
|
|
<p><strong>Namespace</strong> MathNet.Numerics.LinearAlgebra.Solvers</p>
|
|
</div>
|
|
<div class="sub-header">
|
|
<div id="summary">The base interface for preconditioner classes. <blockquote class="remarks">
|
|
<p>Preconditioners are used by iterative solvers to improve the convergence
|
|
speed of the solving process. Increase in convergence speed
|
|
is related to the number of iterations necessary to get a converged solution.
|
|
So while in general the use of a preconditioner means that the iterative
|
|
solver will perform fewer iterations it does not guarantee that the actual
|
|
solution time decreases given that some preconditioners can be expensive to
|
|
setup and run. </p> <p>Note that in general changes to the matrix will invalidate the preconditioner
|
|
if the changes occur after creating the preconditioner. </p>
|
|
</blockquote>
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Methods</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm#Approximate">Approximate</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm#Initialize">Initialize</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<h3 class="section">Public Methods</h3>
|
|
|
|
<div id="Approximate" class="method">
|
|
<h4><span title="System.void">void</span> <strong>Approximate</strong>(<a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a> rhs, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a> lhs)</h4>
|
|
<div class="content">Approximates the solution to the matrix equation .
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a></code> rhs</h6>
|
|
<p class="comments">The right hand side vector. </p>
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a></code> lhs</h6>
|
|
<p class="comments">The left hand side vector. Also known as the result vector. </p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Initialize" class="method">
|
|
<h4><span title="System.void">void</span> <strong>Initialize</strong>(<a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix<T></a> matrix)</h4>
|
|
<div class="content">Initializes the preconditioner and loads the internal data structures.
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix<T></a></code> matrix</h6>
|
|
<p class="comments">The matrix on which the preconditioner is based. </p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="footer">
|
|
<p>Based on v5.0.0.0 of MathNet.Numerics (Math.NET Numerics)</p>
|
|
<p>Generated by <a href="http://docu.jagregory.com">docu</a></p>
|
|
</div>
|
|
</body>
|
|
</html>
|