xal.extension.solver

Class Problem

java.lang.Object

xal.extension.solver.Problem

public class Problem
extends java.lang.Object

Problem is the primary class for holding the user's problem information.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Constraint>	_constraints Constraints which identify unacceptable solutions.
protected Evaluator	_evaluator The user provided object which evaluates the trial solutions.
protected java.util.Map<java.lang.String,Hint>	_hints A table of hints the algorithms may use to adjust their search.
protected java.util.List<Objective>	_objectives The objectives we are trying to optimize.
protected java.util.Map<Variable,ValueRef>	_valueRefs A table of reference values keyed by variable
protected java.util.List<Variable>	_variables The variables which identify the controls for optimizing the solution.

Constructor Summary

Constructors

Constructor and Description
Problem() Construct a problem where everything is null.
Problem(java.util.List<Objective> objectives, java.util.List<Variable> variables, Evaluator evaluator) Construct a problem using an objective list, variable list, and an evaluator.
Problem(java.util.List<Objective> objectives, java.util.List<Variable> variables, Evaluator evaluator, java.util.List<Constraint> constraints, java.util.List<Hint> hints) Construct a problem using an objective list, variable list, constraint list, hint list, and an evaluator.

Method Summary

Modifier and Type	Method and Description
void	addConstraint(Constraint aConstraint) Add a Constraint object to constraintList.
void	addHint(Hint aHint) Add a Hint object to the hintList.
void	addHints(java.util.List<Hint> hints) Add to this problem, the list of hints.
void	addObjective(Objective anObjective) Adds an Objective to objectiveList.
void	addVariable(Variable variable) Adds a Variable object to variableList.
boolean	evaluate(Trial trial) Evaluate the trial
Trial	evaluateInitialPoint() Evaluate the initial point as specified by the initial values of the variables
TrialPoint	generateInitialTrialPoint() Generate a new trial point based on the initial values of the variables.
java.util.List<Constraint>	getConstraints() Get the list of constraints.
Evaluator	getEvaluator() Get the evaluator.
Hint	getHint(java.lang.String type) Get the hint corresponding to the specified type.
java.util.List<Objective>	getObjectives() Get the list of objectives.
ValueRef	getValueReference(Variable variable) Get the value reference which is mapped to a variable.
java.util.List<Variable>	getVariables() Get the list of variables.
void	setConstraints(java.util.List<Constraint> constraints) Set the constraints.
void	setEvaluator(Evaluator anEvaluator) Set the evaluator to use in scoring the trial points.
void	setHints(java.util.List<Hint> hints) Set this problem's hints to the ones specified.
void	setObjectives(java.util.List<? extends Objective> objectives) Set the objectives.
void	setVariables(java.util.List<Variable> variables) Set the variables.
protected TrialVeto	validate(Trial trial) Validate the trial.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_objectives

protected java.util.List<Objective> _objectives

The objectives we are trying to optimize.

_variables

protected final java.util.List<Variable> _variables

The variables which identify the controls for optimizing the solution.

_constraints

protected java.util.List<Constraint> _constraints

Constraints which identify unacceptable solutions.

_hints

protected java.util.Map<java.lang.String,Hint> _hints

A table of hints the algorithms may use to adjust their search.

_evaluator

protected Evaluator _evaluator

The user provided object which evaluates the trial solutions.

_valueRefs

protected java.util.Map<Variable,ValueRef> _valueRefs

A table of reference values keyed by variable

Constructor Detail

Problem

public Problem(java.util.List<Objective> objectives,
               java.util.List<Variable> variables,
               Evaluator evaluator,
               java.util.List<Constraint> constraints,
               java.util.List<Hint> hints)

Construct a problem using an objective list, variable list, constraint list, hint list, and an evaluator.

Problem

public Problem(java.util.List<Objective> objectives,
               java.util.List<Variable> variables,
               Evaluator evaluator)

Construct a problem using an objective list, variable list, and an evaluator.

Problem

public Problem()

Construct a problem where everything is null.

Method Detail

addObjective

public void addObjective(Objective anObjective)

Adds an Objective to objectiveList.

Parameters:

anObjective - The objective of the problem.

setObjectives

public void setObjectives(java.util.List<? extends Objective> objectives)

Set the objectives.

Parameters:

objectives - The new objectives value

getObjectives

public java.util.List<Objective> getObjectives()

Get the list of objectives.

Returns:

objectiveList.

addVariable

public void addVariable(Variable variable)

Adds a Variable object to variableList.

Parameters:

variable - The feature to be added to the Variable attribute

setVariables

public void setVariables(java.util.List<Variable> variables)

Set the variables.

Parameters:

variables - The new variables value

getValueReference

public ValueRef getValueReference(Variable variable)

Get the value reference which is mapped to a variable.

Parameters:

variable - Description of the Parameter

Returns:

A double representing the value.

getVariables

public final java.util.List<Variable> getVariables()

Get the list of variables.

Returns:

The list of variables.

addConstraint

public void addConstraint(Constraint aConstraint)

Add a Constraint object to constraintList.

Parameters:

aConstraint - One constraint of the problem.

setConstraints

public void setConstraints(java.util.List<Constraint> constraints)

Set the constraints.

Parameters:

constraints - The new constraints value

getConstraints

public java.util.List<Constraint> getConstraints()

Get the list of constraints.

Returns:

constraintList The list of constraints.

addHint

public void addHint(Hint aHint)

Add a Hint object to the hintList.

Parameters:

aHint - One hint for the problem.

addHints

public void addHints(java.util.List<Hint> hints)

Add to this problem, the list of hints.

Parameters:

hints - the list of hints to add to this problem.

setHints

public void setHints(java.util.List<Hint> hints)

Set this problem's hints to the ones specified.

Parameters:

hints - The new hints to set for this problem.

getHint

public Hint getHint(java.lang.String type)

Get the hint corresponding to the specified type.

Parameters:

type - the type identifier for which to fetch a hint.

Returns:

The hint corresponding to the specified type.

setEvaluator

public void setEvaluator(Evaluator anEvaluator)

Set the evaluator to use in scoring the trial points. The evaluator defines the problem we are trying to optimize.

Parameters:

anEvaluator - The new evaluator value

getEvaluator

public Evaluator getEvaluator()

Get the evaluator.

Returns:

The evaluator.

generateInitialTrialPoint

public TrialPoint generateInitialTrialPoint()

Generate a new trial point based on the initial values of the variables.

Returns:

a new trial point

validate

protected TrialVeto validate(Trial trial)

Validate the trial.

Parameters:

trial - The trial to be validated.

Returns:

A trial veto if any of the constraints vetos the trial or null if there is no veto.

evaluateInitialPoint

public Trial evaluateInitialPoint()

Evaluate the initial point as specified by the initial values of the variables

Returns:

the evaluated trial

evaluate

public boolean evaluate(Trial trial)

Evaluate the trial

Parameters:

trial - the trial to evaluate

Returns:

true if the evaluation was successful and false if it was vetoed