ParameterOptimizerIterationResults Class |
The results of a single iteration of a ParameterOptimizer. This includes
the unperturbed run of the Function and all of the perturbed
runs of the Function for one time through the
ParameterOptimizer.
Inheritance HierarchyNamespace: AGI.Foundation.NumericalMethods
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)
SyntaxThe ParameterOptimizerIterationResults type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ParameterOptimizerIterationResults(ParameterOptimizerIterationResults, CopyContext) | Initializes a new instance as a copy of an existing instance. |
 | ParameterOptimizerIterationResults(OptimizerMultivariableFunctionResults, OptimizerMultivariableFunctionDerivativeResults, Int32, SolverVariableSettings, CostFunctionSettings, SolverConstraintSettings, InequalityConstraintSettings) |
Initializes a new instance.
|
Properties| Name | Description | |
|---|---|---|
 | CostFunctionSettings |
Gets the settings of the cost function that was computed in all of the function evaluations.
|
| DerivativeResults |
Gets the results of the evaluation of the function's derivative.
|
| FunctionResult |
Gets the results from the Function.
|
| Iteration |
Gets the zero-based iteration count of these results.
|
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.) |
| GetEqualityConstraintSettings |
Gets the SolverConstraintSettings that correspond to the
equality constraints computed by the function.
The order of the SolverConstraintSettings in this array matches the order of the computed values.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInequalityConstraintSettings |
Gets the SolverConstraintSettings that correspond to the
inequality constraints computed by the function.
The order of the SolverConstraintSettings in this array matches the order of the computed values.
|
| GetPerturbedResults |
Gets the results of the
Function when the variable
with the same index in the ParameterOptimizer 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.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVariableSettings |
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.
|
| IndexOfEqualityConstraint(SolverConstraintSettings) |
Gets the index of the SolverConstraintSettings in the array that is returned by the
GetEqualityConstraintSettings method. This index also corresponds to the evaluated value
in the array returned by the GetEqualityConstraintValues of
every OptimizerMultivariableFunctionResults stored in this set of results.
|
| IndexOfEqualityConstraint(String) |
Gets the index of the SolverConstraintSettings with the matching
constraintName in the array that is returned by the
GetEqualityConstraintSettings method. This index also corresponds to the evaluated value
in the array returned by the GetEqualityConstraintValues of
every OptimizerMultivariableFunctionResults stored in this set of results.
|
| IndexOfInequalityConstraint(InequalityConstraintSettings) |
Gets the index of the InequalityConstraintSettings in the array that is returned by the
GetInequalityConstraintSettings method. This index also corresponds to the evaluated value
in the array returned by the GetInequalityConstraintValues of
every OptimizerMultivariableFunctionResults stored in this set of results.
|
| IndexOfInequalityConstraint(String) |
Gets the index of the InequalityConstraintSettings with the matching
constraintName in the array that is returned by the
GetInequalityConstraintSettings method. This index also corresponds to the evaluated value
in the array returned by the GetInequalityConstraintValues of
every OptimizerMultivariableFunctionResults stored in this set of results.
|
| IndexOfVariable(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 OptimizerMultivariableFunctionResults stored in this set of results.
|
| IndexOfVariable(String) |
Gets the index of the SolverVariableSettings with the matching
variableName in the array that is returned by the
GetVariableSettings method. This index also corresponds to the variable value
in the array returned by the GetVariablesUsed of
every OptimizerMultivariableFunctionResults stored in this set of results.
|
| 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