public abstract class ParameterOptimizer extends Object implements IThreadAware, IDisposable
ParameterOptimizers
.
An instance of a type derived from this will pass in values of Variables
(get
) into an
OptimizerMultivariableFunction
to optimize the CostFunction
(get
/ set
),
match the Equalities
(get
), and satisfy the
Inequalities
(get
).Modifier  Constructor and Description 

protected 
ParameterOptimizer()
Initializes a new instance.

protected 
ParameterOptimizer(ParameterOptimizer existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.

Modifier and Type  Method and Description 

static boolean 
checkCostFunctionConvergence(CostFunctionSettings costFunction,
Double currentCostFunctionValue,
Double previousCostFunctionValue)
A helper method to determine if the
cost function changed
by less than its Tolerance (get / set ) in the last iteration. 
static boolean 
checkEqualitySatisfaction(List<SolverConstraintSettings> equalities,
double[] currentEqualityValues)
A helper method to determine if the
equality constraints are
satisfied with the currentEqualityValues . 
static boolean 
checkInequalitySatisfaction(List<InequalityConstraintSettings> inequalities,
double[] currentInequalityValues)
A helper method to determine if the
inequality constraints are
satisfied with the currentInequalityValues . 
static boolean 
checkVariableConvergence(List<SolverVariableSettings> variables,
double[] currentVariableValues,
double[] previousVariableValues)

abstract Object 
clone(CopyContext context)
Clones this object using the specified context.

void 
dispose()
Releases any resources associated with this instance.

protected void 
dispose(boolean disposing)
Releases any resources associated with this instance.

boolean 
findSolution(int numberOfIterations)

boolean 
findSolution(int numberOfIterations,
boolean justFinalResult)

abstract boolean 
findSolution(int numberOfIterations,
boolean justFinalResult,
ITrackCalculationProgress progressTracker)

CostFunctionSettings 
getCostFunction()

int 
getCurrentIteration()
Gets the number of the current iteration.

List<SolverConstraintSettings> 
getEqualities()
Gets the
equality constraint settings corresponding to the
results computed by the Function (get / set ). 
OptimizerMultivariableFunction 
getFunction()
Gets the
function to solve. 
List<InequalityConstraintSettings> 
getInequalities()
Gets the
inequality constraint settings corresponding to the
results computed by the Function (get / set ). 
abstract boolean 
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.

MultivariableFunctionSolverResults<ParameterOptimizerIterationResults> 
getLastRunsResults()
Gets the
results
of the solver run. 
abstract boolean 
getMultithreaded()
Gets a value indicating whether this optimizer should evaluate with as many threads as the current threading policy facet and
optimizer algorithm will allow.

List<SolverVariableSettings> 
getVariables()
Gets the
SolverVariableSettings that will be used when computing this function. 
void 
reset()
Resets the
ParameterOptimizer by setting the LastRunsResults (get / set ) to
null and the CurrentIteration (get / set ) to zero. 
void 
setCostFunction(CostFunctionSettings value)

protected void 
setCurrentIteration(int value)
Sets the number of the current iteration.

void 
setFunction(OptimizerMultivariableFunction value)
Sets the
function to solve. 
void 
setLastRunsResults(MultivariableFunctionSolverResults<ParameterOptimizerIterationResults> value)
Sets the
results
of the solver run. 
abstract void 
setMultithreaded(boolean value)
Sets a value indicating whether this optimizer should evaluate with as many threads as the current threading policy facet and
optimizer algorithm will allow.

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close
protected ParameterOptimizer()
variable
to the
Variables
(get
) as well as set the Function
(get
/ set
). Further, either the CostFunction
(get
/ set
)
must be set or at least one equality constraint
must be added
to the Equalities
(get
) to pose a welldefined optimization problem.protected ParameterOptimizer(@Nonnull ParameterOptimizer 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 abstract 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
nonevaluators.
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 ICloneWithContext
context
 The context to use to perform the copy.public final void dispose()
dispose
in interface IDisposable
protected void dispose(boolean disposing)
disposing
 true
to release both managed and unmanaged resources;
false
to release only unmanaged resources.public abstract 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
public final OptimizerMultivariableFunction getFunction()
function
to solve. When
the solver converges
, this function must
have been run with the variable values that converged. This behavior must be obeyed when
Multithreaded
(get
/ set
) is either true
or false
.public final void setFunction(OptimizerMultivariableFunction value)
function
to solve. When
the solver converges
, this function must
have been run with the variable values that converged. This behavior must be obeyed when
Multithreaded
(get
/ set
) is either true
or false
.public final boolean findSolution(int numberOfIterations)
public final boolean findSolution(int numberOfIterations, boolean justFinalResult)
numberOfIterations
 The number of iterations that may be performed while
attempting to find a solution.justFinalResult
 Tells this method to only include the final results, or
the results of each iteration.LastRunsResults
(get
/ set
)
for the results.public abstract boolean findSolution(int numberOfIterations, boolean justFinalResult, ITrackCalculationProgress progressTracker)
numberOfIterations
 The number of iterations that may be performed while
attempting to find a solution.justFinalResult
 Tells this method to only include the final results, or
the results of each iteration.progressTracker
 An optional progress tracker.LastRunsResults
(get
/ set
)
for the results.public final int getCurrentIteration()
ParameterOptimizer.findSolution(int,boolean,ITrackCalculationProgress)
method.protected final void setCurrentIteration(int value)
ParameterOptimizer.findSolution(int,boolean,ITrackCalculationProgress)
method.public final MultivariableFunctionSolverResults<ParameterOptimizerIterationResults> getLastRunsResults()
results
of the solver run. This includes such information as if the solver converged,
all the iteration results (if configured to save them), if the run was aborted, etc.public final void setLastRunsResults(MultivariableFunctionSolverResults<ParameterOptimizerIterationResults> value)
results
of the solver run. This includes such information as if the solver converged,
all the iteration results (if configured to save them), if the run was aborted, etc.public abstract boolean getMultithreaded()
The specific algorithm you implement may fundamentally be single threaded. In that case it is acceptable to ignore this property.
It is possible that the single and multithreaded algorithms are not identical. As such the parameter optimizer results for the two cases may diverge especially if the problem is illdefined.
public abstract void setMultithreaded(boolean value)
The specific algorithm you implement may fundamentally be single threaded. In that case it is acceptable to ignore this property.
It is possible that the single and multithreaded algorithms are not identical. As such the parameter optimizer results for the two cases may diverge especially if the problem is illdefined.
public final CostFunctionSettings getCostFunction()
cost function settings
corresponding to the
results computed by the Function
(get
/ set
). If there are no
equality constraints
set, then this property must
not be null
for this optimizer to work.public final void setCostFunction(CostFunctionSettings value)
cost function settings
corresponding to the
results computed by the Function
(get
/ set
). If there are no
equality constraints
set, then this property must
not be null
for this optimizer to work.public final List<SolverConstraintSettings> getEqualities()
equality constraint settings
corresponding to the
results computed by the Function
(get
/ set
). If the CostFunction
(get
/ set
) is null
,
there must be at least one constraint
set for this optimizer to work.public final List<InequalityConstraintSettings> getInequalities()
inequality constraint settings
corresponding to the
results computed by the Function
(get
/ set
).public final List<SolverVariableSettings> getVariables()
SolverVariableSettings
that will be used when computing this function.
The variables passed to the function will be in the same order as this list of settings. There
must be at least one variable
set for this solver to work.public void reset()
ParameterOptimizer
by setting the LastRunsResults
(get
/ set
) to
null
and the CurrentIteration
(get
/ set
) to zero. This method should be
called in any derived version.public static boolean checkEqualitySatisfaction(@Nonnull List<SolverConstraintSettings> equalities, double[] currentEqualityValues)
equality constraints
are
satisfied with the currentEqualityValues
.equalities
 The equality constraints
of the function.currentEqualityValues
 The values to check against the DesiredValue
(get
/ set
)
of the equalities
.true
if all of the equality constraints are satisfied or there are no equality constraints;
otherwise false
.public static boolean checkInequalitySatisfaction(@Nonnull List<InequalityConstraintSettings> inequalities, double[] currentInequalityValues)
inequality constraints
are
satisfied with the currentInequalityValues
.inequalities
 The inequality constraints
of the function.currentInequalityValues
 The values to check against the BoundValue
(get
/ set
)
of the inequalities
.true
if all of the inequality constraints are satisfied or there are no inequality constraints;
otherwise false
.public static boolean checkVariableConvergence(@Nonnull List<SolverVariableSettings> variables, double[] currentVariableValues, double[] previousVariableValues)
variables
changed
by less than their respective VariableTolerance
(get
/ set
) in the last iteration.variables
 The independent variables of the function.currentVariableValues
 The values of the independent variables for the current iteration.previousVariableValues
 The values of the independent variables for the previous iteration.true
if all of the variables changed by less than their respective tolerances;
otherwise false
.public static boolean checkCostFunctionConvergence(CostFunctionSettings costFunction, @Nullable Double currentCostFunctionValue, @Nullable Double previousCostFunctionValue)
cost function
changed
by less than its Tolerance
(get
/ set
) in the last iteration.costFunction
 The cost function to be optimized.currentCostFunctionValue
 The value of the cost function for the current iteration.previousCostFunctionValue
 The value of the cost function for the previous iteration.true
if the cost function changed by less than its tolerance or if
one of the cost function values is null
; otherwise false
.