Click or drag to resize

MultivariableFunctionSolverIterationResults Class

The results of a single iteration of a MultivariableFunctionSolver. This includes the unperturbed run of the Function and all of the perturbed runs of the Function for one time through the MultivariableFunctionSolver.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethodsMultivariableFunctionSolverIterationResults

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class MultivariableFunctionSolverIterationResults : ICloneWithContext

The MultivariableFunctionSolverIterationResults type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyDerivativeResults
Gets the results of the evaluation of the functions derivative.
Public propertyFunctionResult
Gets the results from the Function.
Public propertyIteration
Gets the iteration count of these results. This is zero based.
Top
Methods
  NameDescription
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 methodGetConstraintSettings
Gets the SolverConstraintSettings that correspond to the constraints computed by the function. The order of the SolverConstraintSettings in this array matches the order of the computed values.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPerturbedResults
Gets the results of the Function when the variable with the same index in the MultivariableFunctionSolver was perturbed for this iteration. Note that this may return if the Jacobian of the function that made these results was computed analytically or if index is higher than the number of variables in the function.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVariableSettings
Gets the SolverVariableSettings that correspond to the variable values used to compute all of the function evaluations. The order of the SolverVariableSettings in this array matches the order of the variable values.
Public methodIndexOfConstraint(String)
Gets the index of the SolverConstraintSettings with the matching constraintName in the array that is returned by the GetConstraintSettings method. This index also corresponds to the evaluated value in the array returned by the GetConstraintValues of every SolvableMultivariableFunctionResults stored in this set of results.
Public methodIndexOfConstraint(SolverConstraintSettings)
Gets the index of the SolverConstraintSettings in the array that is returned by the GetConstraintSettings method. This index also corresponds to the evaluated value in the array returned by the GetConstraintValues of every SolvableMultivariableFunctionResults stored in this set of results.
Public methodIndexOfVariable(String)
Gets the index of the SolverVariableSettings with the matching variableName in the array that is returned by the GetConstraintSettings method. This index also corresponds to the variable value in the array returned by the GetVariablesUsed of every SolvableMultivariableFunctionResults stored in this set of results.
Public methodIndexOfVariable(SolverVariableSettings)
Gets the index of the SolverVariableSettings in the array that is returned by the GetVariableSettings method. This index also corresponds to the variable values in the array returned by the GetVariablesUsed of every SolvableMultivariableFunctionResults stored in this set of results.
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.)
Top
See Also