xal.extension.solver.hint

Class ExcursionHint

java.lang.Object

xal.extension.solver.hint.Hint

xal.extension.solver.hint.ExcursionHint

public class ExcursionHint
extends Hint

ExcursionHint

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE type identifier for this kind of hint

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

_label

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExcursionHint() Empty Constructor
protected	ExcursionHint(xal.extension.solver.hint.VariableExcursionDomain defaultDomain) Primary Constructor

Method Summary

Modifier and Type	Method and Description
void	addAbsoluteMaxExcursion(Variable variable, double maxExcursion) add the absolute maximum excursion for a variable
void	addFractionExcursion(Variable variable, double fraction) add fraction excursion range for the specified variable
static ExcursionHint	getAbsoluteMaxExcursionHint(double maxExcursion) Get an excursion hint specifying a default maximum absolute excursion about the current value.
static ExcursionHint	getFractionalExcursionHint(double fraction) Get an excursion hint specifying a default fractional excursion about the current value.
double[]	getRange(double value, Variable variable) Get the domain for the specified variable and the current value.
java.lang.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 Detail

TYPE

public static final java.lang.String TYPE

type identifier for this kind of hint

See Also:

Constant Field Values

Constructor Detail

ExcursionHint

protected ExcursionHint(xal.extension.solver.hint.VariableExcursionDomain defaultDomain)

Primary Constructor

ExcursionHint

public ExcursionHint()

Empty Constructor

Method Detail

getFractionalExcursionHint

public static ExcursionHint getFractionalExcursionHint(double fraction)

Get an excursion hint specifying a default fractional excursion about the current value.

getAbsoluteMaxExcursionHint

public static ExcursionHint getAbsoluteMaxExcursionHint(double maxExcursion)

Get an excursion hint specifying a default maximum absolute excursion about the current value.

getType

public java.lang.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 type identifier of this kind of Hint

hasVariable

public boolean hasVariable(Variable variable)

Determine if there is an entry for the variable

addAbsoluteMaxExcursion

public void addAbsoluteMaxExcursion(Variable variable,
                                    double maxExcursion)

add the absolute maximum excursion for a variable

addFractionExcursion

public void addFractionExcursion(Variable variable,
                                 double fraction)

add fraction excursion range for the specified variable

getRange

public double[] getRange(double value,
                         Variable variable)

Get the domain for the specified variable and the current value.