public class NumericallyComputedOptimizerFunctionDerivativeResults extends OptimizerMultivariableFunctionDerivativeResults
OptimizerMultivariableFunction when that evaluation
was done with a numerical algorithm.| Modifier | Constructor and Description |
|---|---|
protected |
NumericallyComputedOptimizerFunctionDerivativeResults(NumericallyComputedOptimizerFunctionDerivativeResults existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
NumericallyComputedOptimizerFunctionDerivativeResults(OptimizerMultivariableFunctionResults value,
double[] costFunctionGradient,
double[][] equalityConstraintGradients,
double[][] inequalityConstraintGradients,
OptimizerMultivariableFunctionResults[] perturbedResultsUsedToComputeDerivative,
FiniteDifferenceMethod differenceMethod)
Initializes a new instance.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
FiniteDifferenceMethod |
getDifferenceMethod()
Gets which difference method was used to compute these results.
|
OptimizerMultivariableFunctionResults[] |
getFunctionResultsUsedToComputeDerivative()
Gets the results of the function that were computed at the perturbed values of the variables.
|
OptimizerMultivariableFunctionResults |
getValue()
Gets the results of the function at the nominal values of the variables.
|
getCostFunctionGradient, getEqualityConstraintGradients, getInequalityConstraintGradients, getVariablespublic NumericallyComputedOptimizerFunctionDerivativeResults(@Nonnull OptimizerMultivariableFunctionResults value, @Nonnull double[] costFunctionGradient, @Nonnull double[][] equalityConstraintGradients, @Nonnull double[][] inequalityConstraintGradients, OptimizerMultivariableFunctionResults[] perturbedResultsUsedToComputeDerivative, @Nonnull FiniteDifferenceMethod differenceMethod)
value - The value of the function at the nominal variable values. This may be null
if the routine that computed these results did not compute the value of the function.costFunctionGradient - The gradient of the cost function evaluated at the variables
of the value.equalityConstraintGradients - The gradients of the equality constraints evaluated at the variables
of the value.inequalityConstraintGradients - The gradients of the inequality constraints evaluated at the
variables of the value.perturbedResultsUsedToComputeDerivative - The evaluations of the function used to compute the gradients.differenceMethod - What difference method was used to compute these results.protected NumericallyComputedOptimizerFunctionDerivativeResults(@Nonnull NumericallyComputedOptimizerFunctionDerivativeResults existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext context)
This method should be implemented to call a copy constructor on the class of the
object being cloned. The copy constructor should take the CopyContext as a parameter
in addition to the existing instance to copy. The copy constructor should first call
CopyContext.addObjectMapping(T, T) to identify the newly constructed instance
as a copy of the existing instance. It should then copy all fields, using
CopyContext.updateReference(T) to copy any reference fields.
A typical implementation of ICloneWithContext:
public static class MyClass implements ICloneWithContext {
public MyClass(MyClass existingInstance, CopyContext context) {
context.addObjectMapping(existingInstance, this);
someReference = context.updateReference(existingInstance.someReference);
}
@Override
public final Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
}
In general, all fields that are reference types should be copied with a call to
CopyContext.updateReference(T). There are a couple of exceptions:
If one of these exceptions applies, the CopyContext should be given an opportunity
to update the reference before the reference is copied explicitly. Use
CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns
the original object, indicating that the context does not have a replacement registered,
then copy the object manually by invoking a Clone method, a copy constructor, or by manually
constructing a new instance and copying the values.
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
If you are implementing an evaluator (a class that implements IEvaluator), the
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the
copy context constructor. Code duplication can be avoided by doing the following:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
public MyClass(MyClass existingInstance, CopyContext context) {
super(existingInstance, context);
someReference = context.updateReference(existingInstance.someReference);
evaluatorReference = existingInstance.evaluatorReference;
updateEvaluatorReferences(context);
}
@Override
public void updateEvaluatorReferences(CopyContext context) {
evaluatorReference = context.updateReference(evaluatorReference);
}
@Override
public Object clone(CopyContext context) {
return new MyClass(this, context);
}
private Object someReference;
private IEvaluator evaluatorReference;clone in interface ICloneWithContextclone in class OptimizerMultivariableFunctionDerivativeResultscontext - The context to use to perform the copy.public final OptimizerMultivariableFunctionResults getValue()
public final OptimizerMultivariableFunctionResults[] getFunctionResultsUsedToComputeDerivative()
@Nonnull public final FiniteDifferenceMethod getDifferenceMethod()