Click or drag to resize

MultivariableFunctionSolverResultsTIterationResults Class

A type storing the overall results of a MultivariableFunctionSolver. If requested, this type will store all the iteration results from an entire run of a MultivariableFunctionSolver.
Inheritance Hierarchy

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.1.418.0 (24.1.418.0)
public class MultivariableFunctionSolverResults<TIterationResults> : ICloneWithContext
where TIterationResults : class

Type Parameters

The results type of an iteration of a solver.

The MultivariableFunctionSolverResultsTIterationResults type exposes the following members.

Public propertyAborted
Gets a value indicating whether the run aborted. This can happen either by the user canceling the computation, or if some warning was detected that prevented the MultivariableFunctionSolver from running to completion.
Public propertyConverged
Gets a value indicating whether the solver converged.
Public propertyFinalIteration
Gets the TIterationResults of the final iteration. is returned if there are no results.
Public propertyIterationResults
Gets the results for each iteration the solver performed.
Public propertyWarnings
Gets a list of warnings that the MultivariableFunctionSolver produced.
Public methodClone
Clones this object using the specified context.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also