hep.aida.ref.optimizer
Class VariableSettings

java.lang.Object
  hep.aida.ref.optimizer.VariableSettings

All Implemented Interfaces:

IVariableSettings

public class VariableSettings

extends Object

implements IVariableSettings

Author:

The AIDA team @ SLAC.

Source Code:

VariableSettings.java

Constructor Summary

VariableSettings(String name)

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 lo, double up) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableSettings

public VariableSettings(String name)

Method Detail

name

public String name()

Description copied from interface: IVariableSettings

Get the name of the variable to which settings apply.

Specified by:

name in interface IVariableSettings

Returns:

The name.

stepSize

public double stepSize()

Description copied from interface: IVariableSettings

The step size for this variable.

Specified by:

stepSize in interface IVariableSettings

Returns:

the step size.

upperBound

public double upperBound()

Description copied from interface: IVariableSettings

Get the upper bound.

Specified by:

upperBound in interface IVariableSettings

Returns:

The upper bound.

lowerBound

public double lowerBound()

Description copied from interface: IVariableSettings

Get the lower bound.

Specified by:

lowerBound in interface IVariableSettings

Returns:

The lower bound.

isBound

public boolean isBound()

Description copied from interface: IVariableSettings

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

Specified by:

isBound in interface IVariableSettings

Returns:

true if the variable is bounded.

isFixed

public boolean isFixed()

Description copied from interface: IVariableSettings

Check if a variable is fixed.

Specified by:

isFixed in interface IVariableSettings

Returns:

true if the variable is fixed.

setStepSize

public void setStepSize(double step)

Description copied from interface: IVariableSettings

Set the step size for this variable.

Specified by:

setStepSize in interface IVariableSettings

Parameters:

step - The step size.

setBounds

public void setBounds(double lo,
                      double up)

Description copied from interface: IVariableSettings

Set the bounds for the variable.

Specified by:

setBounds in interface IVariableSettings

Parameters:

lo - The lower bound.

up - The upper bound.

removeBounds

public void removeBounds()

Description copied from interface: IVariableSettings

Reset the bounds.

Specified by:

removeBounds in interface IVariableSettings

setFixed

public void setFixed(boolean isFixed)

Description copied from interface: IVariableSettings

Set the fixed/unfixed status of a variable.

Specified by:

setFixed in interface IVariableSettings

Parameters:

isFixed - The fixed status of a variable.

reset

public void reset()

Description copied from interface: IVariableSettings

Reset the IVariableSetting ot its defaults.

Specified by:

reset in interface IVariableSettings

value

public double value()

Description copied from interface: IVariableSettings

The current value for this variable.

Specified by:

value in interface IVariableSettings

Returns:

The current value.

setValue

public void setValue(double value)

Description copied from interface: IVariableSettings

Set the current value of this variable.

Specified by:

setValue in interface IVariableSettings

Parameters:

value - The current value.