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.
352 lines
14 KiB
352 lines
14 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>Iterator<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">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" class="current">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> Iterator<T></p>
|
|
<p><strong>Namespace</strong> MathNet.Numerics.LinearAlgebra.Solvers</p>
|
|
</div>
|
|
<div class="sub-header">
|
|
<div id="summary">An iterator that is used to check if an iterative calculation should continue or stop.
|
|
</div>
|
|
|
|
<h3 class="section">Constructors</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#.ctor">Iterator<T></a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#.ctor">Iterator<T></a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#.ctor">Iterator<T></a></li>
|
|
</ul>
|
|
|
|
<h3 class="section">Methods</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#Cancel">Cancel</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#Clone">Clone</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#DetermineStatus">DetermineStatus</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#Equals">Equals</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#GetHashCode">GetHashCode</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#GetType">GetType</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#Reset">Reset</a></li>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#ToString">ToString</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3 class="section">Properties</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm#Status">Status</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Public Constructors</h3>
|
|
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>Iterator<T></strong>()</h4>
|
|
<div class="content">Initializes a new instance of the <a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a> class with the default stop criteria.
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>Iterator<T></strong>(<span title="MathNet.Numerics.LinearAlgebra.Solvers.IIterationStopCriterion`1[]">IIterationStopCriterion`1[]</span> stopCriteria)</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>Iterator<T></strong>(<span title="System.Collections.Generic.IEnumerable<IIterationStopCriterion<T>>">IEnumerable<IIterationStopCriterion<T>></span> stopCriteria)</h4>
|
|
<div class="content">Initializes a new instance of the <a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a> class with the specified stop criteria.
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.Collections.Generic.IEnumerable<IIterationStopCriterion<T>>">IEnumerable<IIterationStopCriterion<T>></span></code> stopCriteria</h6>
|
|
<p class="comments">The specified stop criteria. Only one stop criterion of each type can be passed in. None
|
|
of the stop criteria will be passed on to child iterators. </p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Public Methods</h3>
|
|
|
|
<div id="Cancel" class="method">
|
|
<h4><span title="System.void">void</span> <strong>Cancel</strong>()</h4>
|
|
<div class="content">Indicates to the iterator that the iterative process has been cancelled. <blockquote class="remarks">
|
|
Does not reset the stop-criteria.
|
|
</blockquote>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Clone" class="method">
|
|
<h4><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a> <strong>Clone</strong>()</h4>
|
|
<div class="content">Creates a deep clone of the current iterator.
|
|
|
|
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a></code></h6>
|
|
<p>The deep clone of the current iterator. </p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="DetermineStatus" class="method">
|
|
<h4><a href="../MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm">IterationStatus</a> <strong>DetermineStatus</strong>(<span title="System.int">int</span> iterationNumber, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a> solutionVector, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a> sourceVector, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a> residualVector)</h4>
|
|
<div class="content">Determines the status of the iterative calculation based on the stop criteria stored
|
|
by the current <a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a>. Result is set into <code>Status</code> field. <blockquote class="remarks">
|
|
The individual iterators may internally track the progress of the calculation based
|
|
on the invocation of this method. Therefore this method should only be called if the
|
|
calculation has moved forwards at least one step.
|
|
</blockquote>
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.int">int</span></code> iterationNumber</h6>
|
|
<p class="comments">The number of iterations that have passed so far. </p>
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a></code> solutionVector</h6>
|
|
<p class="comments">The vector containing the current solution values. </p>
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a></code> sourceVector</h6>
|
|
<p class="comments">The right hand side vector. </p>
|
|
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector<T></a></code> residualVector</h6>
|
|
<p class="comments">The vector containing the current residual vectors. </p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Equals" class="method">
|
|
<h4><span title="System.bool">bool</span> <strong>Equals</strong>(<span title="System.object">object</span> obj)</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="GetHashCode" class="method">
|
|
<h4><span title="System.int">int</span> <strong>GetHashCode</strong>()</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="GetType" class="method">
|
|
<h4><span title="System.Type">Type</span> <strong>GetType</strong>()</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Reset" class="method">
|
|
<h4><span title="System.void">void</span> <strong>Reset</strong>()</h4>
|
|
<div class="content">Resets the <a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator<T></a> to the pre-calculation state.
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="ToString" class="method">
|
|
<h4><span title="System.string">string</span> <strong>ToString</strong>()</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<h3 class="section">Public Properties</h3>
|
|
|
|
<div id="Status" class="method">
|
|
<h4><a href="../MathNet.Numerics.LinearAlgebra.Solvers/IterationStatus.htm">IterationStatus</a> <strong>Status</strong> get; </h4>
|
|
<div class="content">Gets the current calculation status.
|
|
|
|
</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>
|