Christoph Ruegg
13 years ago
30 changed files with 124 additions and 1197 deletions
@ -1,309 +0,0 @@ |
|||
// <copyright file="DivergenceStopCriterium.cs" company="Math.NET">
|
|||
// Math.NET Numerics, part of the Math.NET Project
|
|||
// http://numerics.mathdotnet.com
|
|||
// http://github.com/mathnet/mathnet-numerics
|
|||
// http://mathnetnumerics.codeplex.com
|
|||
//
|
|||
// Copyright (c) 2009-2010 Math.NET
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
// </copyright>
|
|||
|
|||
using MathNet.Numerics.LinearAlgebra.Solvers; |
|||
using System; |
|||
using System.Diagnostics; |
|||
|
|||
namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers |
|||
{ |
|||
|
|||
#if NOSYSNUMERICS
|
|||
using Complex = Numerics.Complex; |
|||
#else
|
|||
using Complex = System.Numerics.Complex; |
|||
#endif
|
|||
|
|||
/// <summary>
|
|||
/// Monitors an iterative calculation for signs of divergence.
|
|||
/// </summary>
|
|||
public sealed class DivergenceStopCriterium : IIterationStopCriterium<Complex> |
|||
{ |
|||
/// <summary>
|
|||
/// Default value for the maximum relative increase that the
|
|||
/// residual may experience before a divergence warning is issued.
|
|||
/// </summary>
|
|||
public const double DefaultMaximumRelativeIncrease = 0.08; |
|||
|
|||
/// <summary>
|
|||
/// Default value for the minimum number of iterations over which
|
|||
/// the residual must grow before a divergence warning is issued.
|
|||
/// </summary>
|
|||
public const int DefaultMinimumNumberOfIterations = 10; |
|||
|
|||
/// <summary>
|
|||
/// Defines the default last iteration number. Set to -1 because iterations normally
|
|||
/// start at 0.
|
|||
/// </summary>
|
|||
const int DefaultLastIterationNumber = -1; |
|||
|
|||
/// <summary>
|
|||
/// The maximum relative increase the residual may experience without triggering a divergence warning.
|
|||
/// </summary>
|
|||
double _maximumRelativeIncrease; |
|||
|
|||
/// <summary>
|
|||
/// The number of iterations over which a residual increase should be tracked before issuing a divergence warning.
|
|||
/// </summary>
|
|||
int _minimumNumberOfIterations; |
|||
|
|||
/// <summary>
|
|||
/// The status of the calculation
|
|||
/// </summary>
|
|||
IterationStatus _status = IterationStatus.Continue; |
|||
|
|||
/// <summary>
|
|||
/// The array that holds the tracking information.
|
|||
/// </summary>
|
|||
double[] _residualHistory; |
|||
|
|||
/// <summary>
|
|||
/// The iteration number of the last iteration.
|
|||
/// </summary>
|
|||
int _lastIteration = DefaultLastIterationNumber; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="DivergenceStopCriterium"/> class with the specified maximum
|
|||
/// relative increase and the specified minimum number of tracking iterations.
|
|||
/// </summary>
|
|||
/// <param name="maximumRelativeIncrease">The maximum relative increase that the residual may experience before a divergence warning is issued. </param>
|
|||
/// <param name="minimumIterations">The minimum number of iterations over which the residual must grow before a divergence warning is issued.</param>
|
|||
public DivergenceStopCriterium(double maximumRelativeIncrease = DefaultMaximumRelativeIncrease, int minimumIterations = DefaultMinimumNumberOfIterations) |
|||
{ |
|||
if (maximumRelativeIncrease <= 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("maximumRelativeIncrease"); |
|||
} |
|||
|
|||
// There must be at least three iterations otherwise we can't calculate the relative increase
|
|||
if (minimumIterations < 3) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("minimumIterations"); |
|||
} |
|||
|
|||
_maximumRelativeIncrease = maximumRelativeIncrease; |
|||
_minimumNumberOfIterations = minimumIterations; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued.
|
|||
/// </summary>
|
|||
/// <exception cref="ArgumentOutOfRangeException">Thrown if the <c>Maximum</c> is set to zero or below.</exception>
|
|||
public double MaximumRelativeIncrease |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _maximumRelativeIncrease; |
|||
} |
|||
|
|||
[DebuggerStepThrough] |
|||
set |
|||
{ |
|||
if (value <= 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("value"); |
|||
} |
|||
|
|||
_maximumRelativeIncrease = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Returns the maximum relative increase to the default.
|
|||
/// </summary>
|
|||
public void ResetMaximumRelativeIncreaseToDefault() |
|||
{ |
|||
_maximumRelativeIncrease = DefaultMaximumRelativeIncrease; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the minimum number of iterations over which the residual must grow before
|
|||
/// issuing a divergence warning.
|
|||
/// </summary>
|
|||
/// <exception cref="ArgumentOutOfRangeException">Thrown if the <c>value</c> is set to less than one.</exception>
|
|||
public int MinimumNumberOfIterations |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _minimumNumberOfIterations; |
|||
} |
|||
|
|||
[DebuggerStepThrough] |
|||
set |
|||
{ |
|||
// There must be at least three iterations otherwise we can't calculate
|
|||
// the relative increase
|
|||
if (value < 3) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("value"); |
|||
} |
|||
|
|||
_minimumNumberOfIterations = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Returns the minimum number of iterations to the default.
|
|||
/// </summary>
|
|||
public void ResetNumberOfIterationsToDefault() |
|||
{ |
|||
_minimumNumberOfIterations = DefaultMinimumNumberOfIterations; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Determines the status of the iterative calculation based on the stop criteria stored
|
|||
/// by the current <see cref="IIterationStopCriterium{T}"/>. Result is set into <c>Status</c> field.
|
|||
/// </summary>
|
|||
/// <param name="iterationNumber">The number of iterations that have passed so far.</param>
|
|||
/// <param name="solutionVector">The vector containing the current solution values.</param>
|
|||
/// <param name="sourceVector">The right hand side vector.</param>
|
|||
/// <param name="residualVector">The vector containing the current residual vectors.</param>
|
|||
/// <remarks>
|
|||
/// The individual stop criteria 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.
|
|||
/// </remarks>
|
|||
public IterationStatus DetermineStatus(int iterationNumber, Vector<Complex> solutionVector, Vector<Complex> sourceVector, Vector<Complex> residualVector) |
|||
{ |
|||
if (iterationNumber < 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("iterationNumber"); |
|||
} |
|||
|
|||
if (_lastIteration >= iterationNumber) |
|||
{ |
|||
// We have already stored the actual last iteration number
|
|||
// For now do nothing. We only care about the next step.
|
|||
return _status; |
|||
} |
|||
|
|||
if ((_residualHistory == null) || (_residualHistory.Length != RequiredHistoryLength)) |
|||
{ |
|||
_residualHistory = new double[RequiredHistoryLength]; |
|||
} |
|||
|
|||
// We always track the residual.
|
|||
// Move the old versions one element up in the array.
|
|||
for (var i = 1; i < _residualHistory.Length; i++) |
|||
{ |
|||
_residualHistory[i - 1] = _residualHistory[i]; |
|||
} |
|||
|
|||
// Store the infinity norms of both the solution and residual vectors
|
|||
// These values will be used to calculate the relative drop in residuals later on.
|
|||
_residualHistory[_residualHistory.Length - 1] = residualVector.InfinityNorm(); |
|||
|
|||
// Check if we have NaN's. If so we've gone way beyond normal divergence.
|
|||
// Stop the iteration.
|
|||
if (double.IsNaN(_residualHistory[_residualHistory.Length - 1])) |
|||
{ |
|||
_status = IterationStatus.Diverged; |
|||
return _status; |
|||
} |
|||
|
|||
// Check if we are diverging and if so set the status
|
|||
_status = IsDiverging() ? IterationStatus.Diverged : IterationStatus.Continue; |
|||
|
|||
_lastIteration = iterationNumber; |
|||
return _status; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Detect if solution is diverging
|
|||
/// </summary>
|
|||
/// <returns><c>true</c> if diverging, otherwise <c>false</c></returns>
|
|||
bool IsDiverging() |
|||
{ |
|||
// Run for each variable
|
|||
for (var i = 1; i < _residualHistory.Length; i++) |
|||
{ |
|||
var difference = _residualHistory[i] - _residualHistory[i - 1]; |
|||
|
|||
// Divergence is occurring if:
|
|||
// - the last residual is larger than the previous one
|
|||
// - the relative increase of the residual is larger than the setting allows
|
|||
if ((difference < 0) || (_residualHistory[i - 1]*(1 + _maximumRelativeIncrease) >= _residualHistory[i])) |
|||
{ |
|||
// No divergence taking place within the required number of iterations
|
|||
// So reset and stop the iteration. There is no way we can get to the
|
|||
// required number of iterations anymore.
|
|||
return false; |
|||
} |
|||
} |
|||
|
|||
return true; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets required history Length
|
|||
/// </summary>
|
|||
int RequiredHistoryLength |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _minimumNumberOfIterations + 1; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets the current calculation status.
|
|||
/// </summary>
|
|||
public IterationStatus Status |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _status; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Resets the <see cref="IIterationStopCriterium{T}"/> to the pre-calculation state.
|
|||
/// </summary>
|
|||
public void Reset() |
|||
{ |
|||
_status = IterationStatus.Continue; |
|||
_lastIteration = DefaultLastIterationNumber; |
|||
_residualHistory = null; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Clones the current <see cref="DivergenceStopCriterium"/> and its settings.
|
|||
/// </summary>
|
|||
/// <returns>A new instance of the <see cref="DivergenceStopCriterium"/> class.</returns>
|
|||
public IIterationStopCriterium<Complex> Clone() |
|||
{ |
|||
return new DivergenceStopCriterium(_maximumRelativeIncrease, _minimumNumberOfIterations); |
|||
} |
|||
} |
|||
} |
|||
@ -1,304 +0,0 @@ |
|||
// <copyright file="DivergenceStopCriterium.cs" company="Math.NET">
|
|||
// Math.NET Numerics, part of the Math.NET Project
|
|||
// http://numerics.mathdotnet.com
|
|||
// http://github.com/mathnet/mathnet-numerics
|
|||
// http://mathnetnumerics.codeplex.com
|
|||
//
|
|||
// Copyright (c) 2009-2010 Math.NET
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
// </copyright>
|
|||
|
|||
using MathNet.Numerics.LinearAlgebra.Solvers; |
|||
using System; |
|||
using System.Diagnostics; |
|||
|
|||
namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers |
|||
{ |
|||
using Numerics; |
|||
|
|||
/// <summary>
|
|||
/// Monitors an iterative calculation for signs of divergence.
|
|||
/// </summary>
|
|||
public sealed class DivergenceStopCriterium : IIterationStopCriterium<Complex32> |
|||
{ |
|||
/// <summary>
|
|||
/// Default value for the maximum relative increase that the
|
|||
/// residual may experience before a divergence warning is issued.
|
|||
/// </summary>
|
|||
public const double DefaultMaximumRelativeIncrease = 0.08; |
|||
|
|||
/// <summary>
|
|||
/// Default value for the minimum number of iterations over which
|
|||
/// the residual must grow before a divergence warning is issued.
|
|||
/// </summary>
|
|||
public const int DefaultMinimumNumberOfIterations = 10; |
|||
|
|||
/// <summary>
|
|||
/// Defines the default last iteration number. Set to -1 because iterations normally
|
|||
/// start at 0.
|
|||
/// </summary>
|
|||
const int DefaultLastIterationNumber = -1; |
|||
|
|||
/// <summary>
|
|||
/// The maximum relative increase the residual may experience without triggering a divergence warning.
|
|||
/// </summary>
|
|||
double _maximumRelativeIncrease; |
|||
|
|||
/// <summary>
|
|||
/// The number of iterations over which a residual increase should be tracked before issuing a divergence warning.
|
|||
/// </summary>
|
|||
int _minimumNumberOfIterations; |
|||
|
|||
/// <summary>
|
|||
/// The status of the calculation
|
|||
/// </summary>
|
|||
IterationStatus _status = IterationStatus.Continue; |
|||
|
|||
/// <summary>
|
|||
/// The array that holds the tracking information.
|
|||
/// </summary>
|
|||
double[] _residualHistory; |
|||
|
|||
/// <summary>
|
|||
/// The iteration number of the last iteration.
|
|||
/// </summary>
|
|||
int _lastIteration = DefaultLastIterationNumber; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="DivergenceStopCriterium"/> class with the specified maximum
|
|||
/// relative increase and the specified minimum number of tracking iterations.
|
|||
/// </summary>
|
|||
/// <param name="maximumRelativeIncrease">The maximum relative increase that the residual may experience before a divergence warning is issued. </param>
|
|||
/// <param name="minimumIterations">The minimum number of iterations over which the residual must grow before a divergence warning is issued.</param>
|
|||
public DivergenceStopCriterium(double maximumRelativeIncrease = DefaultMaximumRelativeIncrease, int minimumIterations = DefaultMinimumNumberOfIterations) |
|||
{ |
|||
if (maximumRelativeIncrease <= 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("maximumRelativeIncrease"); |
|||
} |
|||
|
|||
// There must be at least three iterations otherwise we can't calculate the relative increase
|
|||
if (minimumIterations < 3) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("minimumIterations"); |
|||
} |
|||
|
|||
_maximumRelativeIncrease = maximumRelativeIncrease; |
|||
_minimumNumberOfIterations = minimumIterations; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued.
|
|||
/// </summary>
|
|||
/// <exception cref="ArgumentOutOfRangeException">Thrown if the <c>Maximum</c> is set to zero or below.</exception>
|
|||
public double MaximumRelativeIncrease |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _maximumRelativeIncrease; |
|||
} |
|||
|
|||
[DebuggerStepThrough] |
|||
set |
|||
{ |
|||
if (value <= 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("value"); |
|||
} |
|||
|
|||
_maximumRelativeIncrease = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Returns the maximum relative increase to the default.
|
|||
/// </summary>
|
|||
public void ResetMaximumRelativeIncreaseToDefault() |
|||
{ |
|||
_maximumRelativeIncrease = DefaultMaximumRelativeIncrease; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the minimum number of iterations over which the residual must grow before
|
|||
/// issuing a divergence warning.
|
|||
/// </summary>
|
|||
/// <exception cref="ArgumentOutOfRangeException">Thrown if the <c>value</c> is set to less than one.</exception>
|
|||
public int MinimumNumberOfIterations |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _minimumNumberOfIterations; |
|||
} |
|||
|
|||
[DebuggerStepThrough] |
|||
set |
|||
{ |
|||
// There must be at least three iterations otherwise we can't calculate
|
|||
// the relative increase
|
|||
if (value < 3) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("value"); |
|||
} |
|||
|
|||
_minimumNumberOfIterations = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Returns the minimum number of iterations to the default.
|
|||
/// </summary>
|
|||
public void ResetNumberOfIterationsToDefault() |
|||
{ |
|||
_minimumNumberOfIterations = DefaultMinimumNumberOfIterations; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Determines the status of the iterative calculation based on the stop criteria stored
|
|||
/// by the current <see cref="IIterationStopCriterium{T}"/>. Result is set into <c>Status</c> field.
|
|||
/// </summary>
|
|||
/// <param name="iterationNumber">The number of iterations that have passed so far.</param>
|
|||
/// <param name="solutionVector">The vector containing the current solution values.</param>
|
|||
/// <param name="sourceVector">The right hand side vector.</param>
|
|||
/// <param name="residualVector">The vector containing the current residual vectors.</param>
|
|||
/// <remarks>
|
|||
/// The individual stop criteria 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.
|
|||
/// </remarks>
|
|||
public IterationStatus DetermineStatus(int iterationNumber, Vector<Complex32> solutionVector, Vector<Complex32> sourceVector, Vector<Complex32> residualVector) |
|||
{ |
|||
if (iterationNumber < 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("iterationNumber"); |
|||
} |
|||
|
|||
if (_lastIteration >= iterationNumber) |
|||
{ |
|||
// We have already stored the actual last iteration number
|
|||
// For now do nothing. We only care about the next step.
|
|||
return _status; |
|||
} |
|||
|
|||
if ((_residualHistory == null) || (_residualHistory.Length != RequiredHistoryLength)) |
|||
{ |
|||
_residualHistory = new double[RequiredHistoryLength]; |
|||
} |
|||
|
|||
// We always track the residual.
|
|||
// Move the old versions one element up in the array.
|
|||
for (var i = 1; i < _residualHistory.Length; i++) |
|||
{ |
|||
_residualHistory[i - 1] = _residualHistory[i]; |
|||
} |
|||
|
|||
// Store the infinity norms of both the solution and residual vectors
|
|||
// These values will be used to calculate the relative drop in residuals later on.
|
|||
_residualHistory[_residualHistory.Length - 1] = residualVector.InfinityNorm(); |
|||
|
|||
// Check if we have NaN's. If so we've gone way beyond normal divergence.
|
|||
// Stop the iteration.
|
|||
if (double.IsNaN(_residualHistory[_residualHistory.Length - 1])) |
|||
{ |
|||
_status = IterationStatus.Diverged; |
|||
return _status; |
|||
} |
|||
|
|||
// Check if we are diverging and if so set the status
|
|||
_status = IsDiverging() ? IterationStatus.Diverged : IterationStatus.Continue; |
|||
|
|||
_lastIteration = iterationNumber; |
|||
return _status; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Detect if solution is diverging
|
|||
/// </summary>
|
|||
/// <returns><c>true</c> if diverging, otherwise <c>false</c></returns>
|
|||
bool IsDiverging() |
|||
{ |
|||
// Run for each variable
|
|||
for (var i = 1; i < _residualHistory.Length; i++) |
|||
{ |
|||
var difference = _residualHistory[i] - _residualHistory[i - 1]; |
|||
|
|||
// Divergence is occurring if:
|
|||
// - the last residual is larger than the previous one
|
|||
// - the relative increase of the residual is larger than the setting allows
|
|||
if ((difference < 0) || (_residualHistory[i - 1]*(1 + _maximumRelativeIncrease) >= _residualHistory[i])) |
|||
{ |
|||
// No divergence taking place within the required number of iterations
|
|||
// So reset and stop the iteration. There is no way we can get to the
|
|||
// required number of iterations anymore.
|
|||
return false; |
|||
} |
|||
} |
|||
|
|||
return true; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets required history Length
|
|||
/// </summary>
|
|||
int RequiredHistoryLength |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _minimumNumberOfIterations + 1; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets the current calculation status.
|
|||
/// </summary>
|
|||
public IterationStatus Status |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _status; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Resets the <see cref="IIterationStopCriterium{T}"/> to the pre-calculation state.
|
|||
/// </summary>
|
|||
public void Reset() |
|||
{ |
|||
_status = IterationStatus.Continue; |
|||
_lastIteration = DefaultLastIterationNumber; |
|||
_residualHistory = null; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Clones the current <see cref="DivergenceStopCriterium"/> and its settings.
|
|||
/// </summary>
|
|||
/// <returns>A new instance of the <see cref="DivergenceStopCriterium"/> class.</returns>
|
|||
public IIterationStopCriterium<Complex32> Clone() |
|||
{ |
|||
return new DivergenceStopCriterium(_maximumRelativeIncrease, _minimumNumberOfIterations); |
|||
} |
|||
} |
|||
} |
|||
@ -1,302 +0,0 @@ |
|||
// <copyright file="DivergenceStopCriterium.cs" company="Math.NET">
|
|||
// Math.NET Numerics, part of the Math.NET Project
|
|||
// http://numerics.mathdotnet.com
|
|||
// http://github.com/mathnet/mathnet-numerics
|
|||
// http://mathnetnumerics.codeplex.com
|
|||
//
|
|||
// Copyright (c) 2009-2010 Math.NET
|
|||
//
|
|||
// Permission is hereby granted, free of charge, to any person
|
|||
// obtaining a copy of this software and associated documentation
|
|||
// files (the "Software"), to deal in the Software without
|
|||
// restriction, including without limitation the rights to use,
|
|||
// copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|||
// copies of the Software, and to permit persons to whom the
|
|||
// Software is furnished to do so, subject to the following
|
|||
// conditions:
|
|||
//
|
|||
// The above copyright notice and this permission notice shall be
|
|||
// included in all copies or substantial portions of the Software.
|
|||
//
|
|||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|||
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|||
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|||
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|||
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|||
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|||
// OTHER DEALINGS IN THE SOFTWARE.
|
|||
// </copyright>
|
|||
|
|||
using MathNet.Numerics.LinearAlgebra.Solvers; |
|||
using System; |
|||
using System.Diagnostics; |
|||
|
|||
namespace MathNet.Numerics.LinearAlgebra.Double.Solvers |
|||
{ |
|||
/// <summary>
|
|||
/// Monitors an iterative calculation for signs of divergence.
|
|||
/// </summary>
|
|||
public sealed class DivergenceStopCriterium : IIterationStopCriterium<double> |
|||
{ |
|||
/// <summary>
|
|||
/// Default value for the maximum relative increase that the
|
|||
/// residual may experience before a divergence warning is issued.
|
|||
/// </summary>
|
|||
public const double DefaultMaximumRelativeIncrease = 0.08; |
|||
|
|||
/// <summary>
|
|||
/// Default value for the minimum number of iterations over which
|
|||
/// the residual must grow before a divergence warning is issued.
|
|||
/// </summary>
|
|||
public const int DefaultMinimumNumberOfIterations = 10; |
|||
|
|||
/// <summary>
|
|||
/// Defines the default last iteration number. Set to -1 because iterations normally
|
|||
/// start at 0.
|
|||
/// </summary>
|
|||
const int DefaultLastIterationNumber = -1; |
|||
|
|||
/// <summary>
|
|||
/// The maximum relative increase the residual may experience without triggering a divergence warning.
|
|||
/// </summary>
|
|||
double _maximumRelativeIncrease; |
|||
|
|||
/// <summary>
|
|||
/// The number of iterations over which a residual increase should be tracked before issuing a divergence warning.
|
|||
/// </summary>
|
|||
int _minimumNumberOfIterations; |
|||
|
|||
/// <summary>
|
|||
/// The status of the calculation
|
|||
/// </summary>
|
|||
IterationStatus _status = IterationStatus.Continue; |
|||
|
|||
/// <summary>
|
|||
/// The array that holds the tracking information.
|
|||
/// </summary>
|
|||
double[] _residualHistory; |
|||
|
|||
/// <summary>
|
|||
/// The iteration number of the last iteration.
|
|||
/// </summary>
|
|||
int _lastIteration = DefaultLastIterationNumber; |
|||
|
|||
/// <summary>
|
|||
/// Initializes a new instance of the <see cref="DivergenceStopCriterium"/> class with the specified maximum
|
|||
/// relative increase and the specified minimum number of tracking iterations.
|
|||
/// </summary>
|
|||
/// <param name="maximumRelativeIncrease">The maximum relative increase that the residual may experience before a divergence warning is issued. </param>
|
|||
/// <param name="minimumIterations">The minimum number of iterations over which the residual must grow before a divergence warning is issued.</param>
|
|||
public DivergenceStopCriterium(double maximumRelativeIncrease = DefaultMaximumRelativeIncrease, int minimumIterations = DefaultMinimumNumberOfIterations) |
|||
{ |
|||
if (maximumRelativeIncrease <= 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("maximumRelativeIncrease"); |
|||
} |
|||
|
|||
// There must be at least three iterations otherwise we can't calculate the relative increase
|
|||
if (minimumIterations < 3) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("minimumIterations"); |
|||
} |
|||
|
|||
_maximumRelativeIncrease = maximumRelativeIncrease; |
|||
_minimumNumberOfIterations = minimumIterations; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the maximum relative increase that the residual may experience before a divergence warning is issued.
|
|||
/// </summary>
|
|||
/// <exception cref="ArgumentOutOfRangeException">Thrown if the <c>Maximum</c> is set to zero or below.</exception>
|
|||
public double MaximumRelativeIncrease |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _maximumRelativeIncrease; |
|||
} |
|||
|
|||
[DebuggerStepThrough] |
|||
set |
|||
{ |
|||
if (value <= 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("value"); |
|||
} |
|||
|
|||
_maximumRelativeIncrease = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Returns the maximum relative increase to the default.
|
|||
/// </summary>
|
|||
public void ResetMaximumRelativeIncreaseToDefault() |
|||
{ |
|||
_maximumRelativeIncrease = DefaultMaximumRelativeIncrease; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets or sets the minimum number of iterations over which the residual must grow before
|
|||
/// issuing a divergence warning.
|
|||
/// </summary>
|
|||
/// <exception cref="ArgumentOutOfRangeException">Thrown if the <c>value</c> is set to less than one.</exception>
|
|||
public int MinimumNumberOfIterations |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _minimumNumberOfIterations; |
|||
} |
|||
|
|||
[DebuggerStepThrough] |
|||
set |
|||
{ |
|||
// There must be at least three iterations otherwise we can't calculate
|
|||
// the relative increase
|
|||
if (value < 3) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("value"); |
|||
} |
|||
|
|||
_minimumNumberOfIterations = value; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Returns the minimum number of iterations to the default.
|
|||
/// </summary>
|
|||
public void ResetNumberOfIterationsToDefault() |
|||
{ |
|||
_minimumNumberOfIterations = DefaultMinimumNumberOfIterations; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Determines the status of the iterative calculation based on the stop criteria stored
|
|||
/// by the current <see cref="IIterationStopCriterium{T}"/>. Result is set into <c>Status</c> field.
|
|||
/// </summary>
|
|||
/// <param name="iterationNumber">The number of iterations that have passed so far.</param>
|
|||
/// <param name="solutionVector">The vector containing the current solution values.</param>
|
|||
/// <param name="sourceVector">The right hand side vector.</param>
|
|||
/// <param name="residualVector">The vector containing the current residual vectors.</param>
|
|||
/// <remarks>
|
|||
/// The individual stop criteria 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.
|
|||
/// </remarks>
|
|||
public IterationStatus DetermineStatus(int iterationNumber, Vector<double> solutionVector, Vector<double> sourceVector, Vector<double> residualVector) |
|||
{ |
|||
if (iterationNumber < 0) |
|||
{ |
|||
throw new ArgumentOutOfRangeException("iterationNumber"); |
|||
} |
|||
|
|||
if (_lastIteration >= iterationNumber) |
|||
{ |
|||
// We have already stored the actual last iteration number
|
|||
// For now do nothing. We only care about the next step.
|
|||
return _status; |
|||
} |
|||
|
|||
if ((_residualHistory == null) || (_residualHistory.Length != RequiredHistoryLength)) |
|||
{ |
|||
_residualHistory = new double[RequiredHistoryLength]; |
|||
} |
|||
|
|||
// We always track the residual.
|
|||
// Move the old versions one element up in the array.
|
|||
for (var i = 1; i < _residualHistory.Length; i++) |
|||
{ |
|||
_residualHistory[i - 1] = _residualHistory[i]; |
|||
} |
|||
|
|||
// Store the infinity norms of both the solution and residual vectors
|
|||
// These values will be used to calculate the relative drop in residuals later on.
|
|||
_residualHistory[_residualHistory.Length - 1] = residualVector.InfinityNorm(); |
|||
|
|||
// Check if we have NaN's. If so we've gone way beyond normal divergence.
|
|||
// Stop the iteration.
|
|||
if (double.IsNaN(_residualHistory[_residualHistory.Length - 1])) |
|||
{ |
|||
_status = IterationStatus.Diverged; |
|||
return _status; |
|||
} |
|||
|
|||
// Check if we are diverging and if so set the status
|
|||
_status = IsDiverging() ? IterationStatus.Diverged : IterationStatus.Continue; |
|||
|
|||
_lastIteration = iterationNumber; |
|||
return _status; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Detect if solution is diverging
|
|||
/// </summary>
|
|||
/// <returns><c>true</c> if diverging, otherwise <c>false</c></returns>
|
|||
bool IsDiverging() |
|||
{ |
|||
// Run for each variable
|
|||
for (var i = 1; i < _residualHistory.Length; i++) |
|||
{ |
|||
var difference = _residualHistory[i] - _residualHistory[i - 1]; |
|||
|
|||
// Divergence is occurring if:
|
|||
// - the last residual is larger than the previous one
|
|||
// - the relative increase of the residual is larger than the setting allows
|
|||
if ((difference < 0) || (_residualHistory[i - 1]*(1 + _maximumRelativeIncrease) >= _residualHistory[i])) |
|||
{ |
|||
// No divergence taking place within the required number of iterations
|
|||
// So reset and stop the iteration. There is no way we can get to the
|
|||
// required number of iterations anymore.
|
|||
return false; |
|||
} |
|||
} |
|||
|
|||
return true; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets required history Length
|
|||
/// </summary>
|
|||
int RequiredHistoryLength |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _minimumNumberOfIterations + 1; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Gets the current calculation status.
|
|||
/// </summary>
|
|||
public IterationStatus Status |
|||
{ |
|||
[DebuggerStepThrough] |
|||
get |
|||
{ |
|||
return _status; |
|||
} |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Resets the <see cref="IIterationStopCriterium{T}"/> to the pre-calculation state.
|
|||
/// </summary>
|
|||
public void Reset() |
|||
{ |
|||
_status = IterationStatus.Continue; |
|||
_lastIteration = DefaultLastIterationNumber; |
|||
_residualHistory = null; |
|||
} |
|||
|
|||
/// <summary>
|
|||
/// Clones the current <see cref="DivergenceStopCriterium"/> and its settings.
|
|||
/// </summary>
|
|||
/// <returns>A new instance of the <see cref="DivergenceStopCriterium"/> class.</returns>
|
|||
public IIterationStopCriterium<double> Clone() |
|||
{ |
|||
return new DivergenceStopCriterium(_maximumRelativeIncrease, _minimumNumberOfIterations); |
|||
} |
|||
} |
|||
} |
|||
Loading…
Reference in new issue