MultivariableFunctionSolverResults<TIterationResults> 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 HierarchyNamespace: AGI.Foundation.NumericalMethods
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 25.1.421.0 (25.1.421.0)
Syntaxpublic class MultivariableFunctionSolverResults<TIterationResults> : ICloneWithContext where TIterationResults : class
Type Parameters
- TIterationResults
- The results type of an iteration of a solver.
The MultivariableFunctionSolverResults<TIterationResults> type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MultivariableFunctionSolverResults<TIterationResults>(MultivariableFunctionSolverResults<TIterationResults>, CopyContext) | Initializes a new instance as a copy of an existing instance. |
 | MultivariableFunctionSolverResults<TIterationResults>(IEnumerable<TIterationResults>, Boolean, Boolean, IEnumerable<MultivariableFunctionSolverWarning>) |
Initializes a new instance.
|
Properties| Name | Description | |
|---|---|---|
 | Aborted |
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.
|
| Converged |
Gets a value indicating whether the solver converged.
|
| FinalIteration |
Gets the TIterationResults of the final iteration. null is returned if
there are no results.
|
| IterationResults |
Gets the results for each iteration the solver performed.
|
| Warnings |
Gets a list of warnings that the MultivariableFunctionSolver produced.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Clones this object using the specified context.
|
| 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.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also