public class CostFunctionSettings extends DefinitionalObject implements IThreadAware
OptimizerMultivariableFunction.| Modifier | Constructor and Description |
|---|---|
|
CostFunctionSettings(CostFunctionGoal goal,
double tolerance)
Initializes a new instance with no scaling.
|
|
CostFunctionSettings(CostFunctionGoal goal,
double tolerance,
CostFunctionScaling scaling)
Initializes a new instance.
|
|
CostFunctionSettings(CostFunctionGoal goal,
double tolerance,
CostFunctionScaling scaling,
String name)
Initializes a new instance.
|
|
CostFunctionSettings(CostFunctionGoal goal,
double tolerance,
CostFunctionScaling scaling,
String name,
double weight)
Initializes a new instance.
|
protected |
CostFunctionSettings(CostFunctionSettings existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(CostFunctionSettings other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(DefinitionalObject other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
boolean |
costFunctionChangeWithinTolerance(double currentCostFunctionValue,
double previousCostFunctionValue)
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
CostFunctionGoal |
getGoal()
Gets a value indicating whether the cost function is supposed to be minimized or maximized.
|
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
String |
getName()
Gets an optional name for this cost function.
|
CostFunctionScaling |
getScaling()
Gets the type of scaling applied to the cost function.
|
double |
getTolerance()
Gets the tolerance used for determining convergence.
|
double |
getWeight()
Gets a value multiplied by the cost function to prioritize or de-prioritize it
with respect to the constraint errors of any active constraints.
|
void |
setGoal(CostFunctionGoal value)
Sets a value indicating whether the cost function is supposed to be minimized or maximized.
|
void |
setName(String value)
Sets an optional name for this cost function.
|
void |
setScaling(CostFunctionScaling value)
Sets the type of scaling applied to the cost function.
|
void |
setTolerance(double value)
Sets the tolerance used for determining convergence.
|
void |
setWeight(double value)
Sets a value multiplied by the cost function to prioritize or de-prioritize it
with respect to the constraint errors of any active constraints.
|
areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic CostFunctionSettings(@Nonnull CostFunctionGoal goal, double tolerance)
goal - Whether the cost function is supposed to be minimized or maximized.tolerance - The cost function is considered to be converged if its value changes by less than
this value from one iteration to the next.public CostFunctionSettings(@Nonnull CostFunctionGoal goal, double tolerance, CostFunctionScaling scaling)
goal - Whether the cost function is supposed to be minimized or maximized.tolerance - The cost function is considered to be converged if its value changes by less than
this value from one iteration to the next.scaling - Sets the type of scaling to be used on this cost function.public CostFunctionSettings(@Nonnull CostFunctionGoal goal, double tolerance, CostFunctionScaling scaling, String name)
goal - Whether the cost function is supposed to be minimized or maximized.tolerance - The cost function is considered to be converged if its value changes by less than
this value from one iteration to the next.scaling - Sets the type of scaling to be used on this cost function.name - An optional name for the cost function settings.public CostFunctionSettings(@Nonnull CostFunctionGoal goal, double tolerance, CostFunctionScaling scaling, String name, double weight)
goal - Whether the cost function is supposed to be minimized or maximized.tolerance - The cost function is considered to be converged if its value changes by less than
this value from one iteration to the next.scaling - Sets the type of scaling to be used on this cost function.name - An optional name for the cost function settings.weight - A value multiplied by the cost function to prioritize or de-prioritize it
with respect to the constraint errors of any active constraints.protected CostFunctionSettings(@Nonnull CostFunctionSettings 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 DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(DefinitionalObject other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class DefinitionalObjectother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(CostFunctionSettings other)
true if it does. Derived classes MUST override this method and check
all new fields introduced by the derived class for definitional equivalence. It is NOT necessary
to check base class fields because the base class will already have done that. When overriding this method,
you should NOT call the base implementation because it will return false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
CostFunctionSettings.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.computeCurrentDefinitionHashCode in class DefinitionalObjectpublic void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Derived classes which contain additional dependencies MUST override this method, call the base
implementation, and enumerate dependencies introduced by the derived class.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class DefinitionalObjectenumerator - The enumerator that is informed of the dependencies of this object.public boolean getIsThreadSafe()
If this property is true, all methods and properties are guaranteed to be thread safe.
Conceptually, an object that returns true for this method acts as if there is a lock
protecting each method and property such that only one thread at a time can be inside any method or
property in the class. In reality, such locks are generally not used and are in fact discouraged. However,
the user must not experience any exceptions or inconsistent behavior that would not be experienced if such
locks were used.
If this property is false, the behavior when using this class from multiple threads
simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use
multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the
object for each thread.
getIsThreadSafe in interface IThreadAware@Nonnull public final CostFunctionGoal getGoal()
public final void setGoal(@Nonnull CostFunctionGoal value)
public final double getTolerance()
public final void setTolerance(double value)
public final CostFunctionScaling getScaling()
public final void setScaling(CostFunctionScaling value)
public final String getName()
public final void setName(String value)
public final double getWeight()
public final void setWeight(double value)
public final boolean costFunctionChangeWithinTolerance(double currentCostFunctionValue,
double previousCostFunctionValue)
Tolerance (get / set).currentCostFunctionValue - The cost function value at the current iteration.previousCostFunctionValue - The cost function value at the previous iteration.true if the cost function change is within the tolerance and
false if the cost function change is outside the tolerance.