xal.tools.math.differential

Class DifferentiableVariableValues

java.lang.Object

xal.tools.math.differential.DifferentiableVariableValues

public class DifferentiableVariableValues
extends java.lang.Object

Contains the assigned values for variables

Constructor Summary

Constructors

Constructor and Description
DifferentiableVariableValues() Constructor

Method Summary

Modifier and Type	Method and Description
int	assignmentCount() number of assignments
void	assignValue(DifferentiableVariable variable, double value) assign the value to the variable
void	clear() unassign all variable values
double	getAssignedValue(DifferentiableVariable variable) Get the assigned value
static DifferentiableVariableValues	getInstance() Get a new instance
double	getValue(DifferentiableVariable variable) Get the value for the variable using the assigned value if it exists; otherwise using the variable's default value
boolean	isAssignedValue(DifferentiableVariable variable) Determine whether a value has been assigned for the specified variable
java.lang.String	toString() Get the string representation of this mapping
void	unassignValue(DifferentiableVariable variable) unassign the value to the variable

Methods inherited from class java.lang.Object

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

Constructor Detail

DifferentiableVariableValues

public DifferentiableVariableValues()

Constructor

Method Detail

getInstance

public static DifferentiableVariableValues getInstance()

Get a new instance

clear

public void clear()

unassign all variable values

assignmentCount

public int assignmentCount()

number of assignments

assignValue

public void assignValue(DifferentiableVariable variable,
                        double value)

assign the value to the variable

unassignValue

public void unassignValue(DifferentiableVariable variable)

unassign the value to the variable

isAssignedValue

public boolean isAssignedValue(DifferentiableVariable variable)

Determine whether a value has been assigned for the specified variable

getAssignedValue

public double getAssignedValue(DifferentiableVariable variable)

Get the assigned value

getValue

public double getValue(DifferentiableVariable variable)

Get the value for the variable using the assigned value if it exists; otherwise using the variable's default value

toString

public java.lang.String toString()

Get the string representation of this mapping

Overrides:

toString in class java.lang.Object