xal.tools.math.differential

Class DifferentiableVariable

java.lang.Object

xal.tools.math.differential.DifferentiableOperation

xal.tools.math.differential.DifferentiableVariable

Direct Known Subclasses:

BoundedDifferentiableVariable

public class DifferentiableVariable
extends DifferentiableOperation

Variable used in a differntiable operation

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
DifferentiableVariable(java.lang.String name, double defaultValue) Constructor

Method Summary

Modifier and Type	Method and Description
protected DifferentiableOperation	copySubstituting(java.util.Map<DifferentiableOperation,DifferentiableOperation> substitutions) Construct a copy this operation substituting the operations given in the map.
double	evaluate(DifferentiableVariableValues valueMap, java.util.Map<DifferentiableOperation,java.lang.Double> cache) Evaluate the operation for the specified variable values using the default value if this variable is not specified in the map
double	getDefaultValue() get the default value
DifferentiableOperation	getDerivative(DifferentiableVariable variable) Get the derivative with respect to the coordinate at the specified index
static DifferentiableVariable	getInstance(java.lang.String name, double defaultValue) generate a new variable with the specified name
java.lang.String	getName() Get the name of this variable
protected int	getPrecedence() get the operation precedence
protected boolean	isEquivalentTo(DifferentiableOperation operation) Test whether this operation is equivalent to the specified operation when the two operations are different instances.
void	setDefaultValue(double value) set the default value
java.lang.String	toString() get the string representation of this variable

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

DifferentiableVariable

public DifferentiableVariable(java.lang.String name,
                              double defaultValue)

Constructor

Parameters:

name - name of this variable

defaultValue - value to use when none is supplied during evaluation

Method Detail

copySubstituting

protected DifferentiableOperation copySubstituting(java.util.Map<DifferentiableOperation,DifferentiableOperation> substitutions)

Construct a copy this operation substituting the operations given in the map.

Specified by:

copySubstituting in class DifferentiableOperation

Parameters:

substitutions - map of the new operations keyed by the current operations to be substituted

Returns:

a new operation with operations substituted

getName

public java.lang.String getName()

Get the name of this variable

getDefaultValue

public double getDefaultValue()

get the default value

setDefaultValue

public void setDefaultValue(double value)

set the default value

getInstance

public static DifferentiableVariable getInstance(java.lang.String name,
                                                 double defaultValue)

generate a new variable with the specified name

evaluate

public final double evaluate(DifferentiableVariableValues valueMap,
                             java.util.Map<DifferentiableOperation,java.lang.Double> cache)

Evaluate the operation for the specified variable values using the default value if this variable is not specified in the map

Specified by:

evaluate in class DifferentiableOperation

getDerivative

public final DifferentiableOperation getDerivative(DifferentiableVariable variable)

Get the derivative with respect to the coordinate at the specified index

Specified by:

getDerivative in class DifferentiableOperation

toString

public java.lang.String toString()

get the string representation of this variable

Overrides:

toString in class java.lang.Object

isEquivalentTo

protected boolean isEquivalentTo(DifferentiableOperation operation)

Test whether this operation is equivalent to the specified operation when the two operations are different instances. Always returns false.

Specified by:

isEquivalentTo in class DifferentiableOperation

getPrecedence

protected int getPrecedence()

get the operation precedence

Specified by:

getPrecedence in class DifferentiableOperation