xal.tools.math.differential

Class BoundedDifferentiableVariable

java.lang.Object

xal.tools.math.differential.DifferentiableOperation

xal.tools.math.differential.DifferentiableVariable

xal.tools.math.differential.BoundedDifferentiableVariable

public class BoundedDifferentiableVariable
extends DifferentiableVariable

BoundedDifferentiableVariable

Field Summary

Fields inherited from class xal.tools.math.differential.DifferentiableOperation

ADDITION_PRECEDENCE, POWER_PRECEDENCE, PRODUCT_PRECEDENCE, QUOTIENT_PRECEDENCE, SUBTRACTION_PRECEDENCE, SYMBOL_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
BoundedDifferentiableVariable(java.lang.String name, double defaultValue, double lowerLimit, double upperLimit) Constructor

Method Summary

Modifier and Type	Method and Description
double	getLowerLimit() get the lower limit
double	getNearestBoundedValue(double value) get the nearest bounded (i.e.
protected int	getPrecedence() get the operation precedence
double	getUpperLimit() get the upper limit
boolean	isBounded(double value) determine whether the value is bounded within the given bounds
void	setLowerLimit(double lowerLimit) set the lower limit
void	setUpperLimit(double upperLimit) set the upper limit

Methods inherited from class xal.tools.math.differential.DifferentiableVariable

copySubstituting, evaluate, getDefaultValue, getDerivative, getInstance, getName, isEquivalentTo, setDefaultValue, toString

Methods inherited from class xal.tools.math.differential.DifferentiableOperation

abs, acos, asin, atan, copySubstitutingWithCache, copyWithSubstitutions, cos, cosh, evaluate, evaluate, evaluateWithCache, exp, getConstant, getVariable, isEqualTo, log, minus, minus, minus, minus, multiply, negate, over, over, over, over, plus, plus, plus, plus, plus, pow, pow, reciprocal, sin, sinh, sqrt, sum, tan, tanh, times, times, times, times, times, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedDifferentiableVariable

public BoundedDifferentiableVariable(java.lang.String name,
                                     double defaultValue,
                                     double lowerLimit,
                                     double upperLimit)

Constructor

Method Detail

getLowerLimit

public double getLowerLimit()

get the lower limit

setLowerLimit

public void setLowerLimit(double lowerLimit)

set the lower limit

getUpperLimit

public double getUpperLimit()

get the upper limit

setUpperLimit

public void setUpperLimit(double upperLimit)

set the upper limit

isBounded

public boolean isBounded(double value)

determine whether the value is bounded within the given bounds

getNearestBoundedValue

public double getNearestBoundedValue(double value)

get the nearest bounded (i.e. within bounds) value to the specified value

getPrecedence

protected int getPrecedence()

get the operation precedence

Specified by:

getPrecedence in class DifferentiableOperation