ManagedIterativeAlgorithm Class

Represents an implementation of an iterative algorithm that uses a managed driver routine.

Definition

Namespace: Numerics.NET.Algorithms
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

public abstract class ManagedIterativeAlgorithm : ManagedIterativeAlgorithm<Object>

Visual Basic

Public MustInherit Class ManagedIterativeAlgorithm
	Inherits ManagedIterativeAlgorithm(Of Object)

C++/CLI

public ref class ManagedIterativeAlgorithm abstract : public ManagedIterativeAlgorithm<Object^>

[<AbstractClassAttribute>]
type ManagedIterativeAlgorithm = 
    class
        inherit ManagedIterativeAlgorithm<Object>
    end

Inheritance: Object → ManagedIterativeAlgorithm<Object, Double, SolutionReport<Object, Double>> → ManagedIterativeAlgorithm<Object> → ManagedIterativeAlgorithm

Derived: Numerics.NET.EquationSolvers.EquationSystemSolver

Remarks

This class is supplied for compatibility with previous versions only. It's use is not recommended. Use the generic type ManagedIterativeAlgorithm<T, TError, TReport> instead.

Constructors

ManagedIterativeAlgorithm

Initializes a new instance of the ManagedIterativeAlgorithm class

Properties

ConvergenceTests	Gets the collection of convergence tests for the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
EstimatedError	Gets a value indicating the size of the absolute error of the result. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
EvaluationsNeeded	Gets the number of evaluations needed to execute the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
EvaluationsRemaining	Gets the number of evaluations still available. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
HasSharedDegreeOfParallelism	Indicates whether the degree of parallelism is a property that is shared across instances. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IterationsNeeded	Gets the number of iterations needed by the algorithm to reach the desired accuracy. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IterationsRemaining	Gets the number of iterations remaining. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MaxDegreeOfParallelism	Gets or sets the maximum degree of parallelism enabled by this instance. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MaxEvaluations	Gets or sets the maximum number of evaluations during the calculation. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MaxIterations	Gets or sets the maximum number of iterations to use when approximating the roots of the target function. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MinIterations	Gets or sets the minimum iterations that have to be performed. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ParallelOptions	Gets or sets the configuration for the parallel behavior of the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Result	Gets the result of an algorithm after it has executed. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
SolutionReport	Gets the result of an algorithm after it has executed. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Status	Gets the AlgorithmStatus following an execution of the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThrowExceptionOnFailure	Gets or sets whether to throw an exception when the algorithm fails to converge. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)

Methods

Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
IncrementEvaluations()	Increments the number of evaluations by one. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
IncrementEvaluations(Int32)	Increments the number of evaluations by the specified amount. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Iterate	Performs one iteration of the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Iterated	Performs tasks after the iteration is completed, but before the status of the algorithm is finalized. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
OnConvergence	Performs any tasks after the main algorithm has converged. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
OnFailure	Performs any tasks after the main algorithm has failed to converge. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
OnInit	Performs initialization before the first iteration. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportFailure	Records the results of an algorithm in case it fails. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportResult	Records the results of an algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ReportSuccess	Records the results of a algorithm that converged successfully. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ResetEvaluations	Resets the number of evaluations to zero. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Restart	Prepares the algorithm to be run again with possibly different inputs. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Run()	Runs the algorithm. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
Run(ParallelOptions)	Runs the algorithm using the specified parallelization options. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
SetResult	Sets the results of an algorithm's execution. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
TestConvergence	Checks whether the algorithm has converged. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThreadSafeIncrementEvaluations()	Increments the number of evaluations by one. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThreadSafeIncrementEvaluations(Int32)	Increments the number of evaluations by the specified amount. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ThrowConvergenceException	Interprets the AlgorithmStatus and throws the appropriate exception. (Inherited from ManagedIterativeAlgorithm<T, TError, TReport>)
ToString	Returns a string that represents the current object. (Inherited from Object)