hep.aida.ext
Interface IVariableSettings

All Known Implementing Classes:

VariableSettings

public interface IVariableSettings

IVariableSettings contains the settings for a give variable.

Author:

Tony Johnson, Victor Serbo, Max Turri

Source Code:

IVariableSettings.java

Method Summary

boolean	isBound() Check if a variable is bounded.
boolean	isFixed() Check if a variable is fixed.
double	lowerBound() Get the lower bound.
String	name() Get the name of the variable to which settings apply.
void	removeBounds() Reset the bounds.
void	reset() Reset the IVariableSetting ot its defaults.
void	setBounds(double lowerBound, double upperBound) Set the bounds for the variable.
void	setFixed(boolean isFixed) Set the fixed/unfixed status of a variable.
void	setStepSize(double step) Set the step size for this variable.
void	setValue(double value) Set the current value of this variable.
double	stepSize() The step size for this variable.
double	upperBound() Get the upper bound.
double	value() The current value for this variable.

Method Detail

name

public String name()

Get the name of the variable to which settings apply.

Returns:

The name.

stepSize

public double stepSize()

The step size for this variable.

Returns:

the step size.

upperBound

public double upperBound()

Get the upper bound.

Returns:

The upper bound.

lowerBound

public double lowerBound()

Get the lower bound.

Returns:

The lower bound.

isBound

public boolean isBound()

Check if a variable is bounded. A variable is bounded if either the upper bound or the lower bound are not infinity.

Returns:

true if the variable is bounded.

isFixed

public boolean isFixed()

Check if a variable is fixed.

Returns:

true if the variable is fixed.

setStepSize

public void setStepSize(double step)
                 throws IllegalArgumentException

Set the step size for this variable.

Parameters:

step - The step size.

Throws:

IllegalArgumentException - if the step is not positive.

setBounds

public void setBounds(double lowerBound,
                      double upperBound)
               throws IllegalArgumentException

Set the bounds for the variable.

Parameters:

lowerBound - The lower bound.

upperBound - The upper bound.

Throws:

IllegalArgumentException - if the lowerBound is not lower than the upperBound.

removeBounds

public void removeBounds()

Reset the bounds.

setFixed

public void setFixed(boolean isFixed)

Set the fixed/unfixed status of a variable.

Parameters:

isFixed - The fixed status of a variable.

reset

public void reset()

Reset the IVariableSetting ot its defaults.

setValue

public void setValue(double value)

Set the current value of this variable.

Parameters:

value - The current value.

value

public double value()

The current value for this variable.

Returns:

The current value.