Package xal.extension.solver.hint

Class InitialDelta

java.lang.Object

xal.extension.solver.hint.Hint

xal.extension.solver.hint.DomainHint

xal.extension.solver.hint.InitialDelta

public class InitialDelta
extends DomainHint

A hint that indicates a good initial search space about the initial variable values.

Field Summary

Fields

Modifier and Type	Field	Description
protected final double	defaultDelta	default delta
static final String	TYPE
protected final Map<Variable,Double>	variableDeltas	delta keyed by variable

Fields inherited from class xal.extension.solver.hint.DomainHint

LOWER_IND, UPPER_IND

Fields inherited from class xal.extension.solver.hint.Hint

label

Constructor Summary

Constructors

Constructor	Description
InitialDelta()	Constructor
InitialDelta(double delta)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
void	addInitialDelta(Variable variable, double delta)	add the initial delta for the specified variable
double[]	getRange(Variable variable)	Get the domain for the specified variable.
String	getType()	Get the type identifier of this Hint which will be used to fetch this hint in a table of hints.
boolean	hasVariable(Variable variable)	Determine if there is an entry for the variable

Methods inherited from class xal.extension.solver.hint.Hint

getLabel

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

variableDeltas

protected final Map<Variable,Double> variableDeltas

delta keyed by variable

defaultDelta

protected final double defaultDelta

default delta

Constructor Details

InitialDelta

public InitialDelta(double delta)

Primary Constructor

InitialDelta

public InitialDelta()

Constructor

Method Details

getType

public String getType()

Get the type identifier of this Hint which will be used to fetch this hint in a table of hints.

Specified by:

getType in class Hint

Returns:

the unique type identifier of this Hint

hasVariable

public boolean hasVariable(Variable variable)

Determine if there is an entry for the variable

Specified by:

hasVariable in class DomainHint

addInitialDelta

public void addInitialDelta(Variable variable,
 double delta)

add the initial delta for the specified variable

getRange

public double[] getRange(Variable variable)

Get the domain for the specified variable.

Specified by:

getRange in class DomainHint