xal.extension.solver

Class TrialPoint

java.lang.Object

xal.extension.solver.TrialPoint

Direct Known Subclasses:

MutableTrialPoint

public class TrialPoint
extends java.lang.Object

TrialPoint is a collection of variables and values for those variables.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<Variable,java.lang.Number>	_values A table of trial values keyed by variable

Constructor Summary

Constructors

Constructor and Description
TrialPoint(java.util.Map<Variable,java.lang.Number> values) Primary constructor.
TrialPoint(TrialPoint trialPoint) Copy constructor.

Method Summary

Modifier and Type	Method and Description
double	getValue(Variable variable) Get the value corresponding to the specified variable.
java.util.Map<Variable,java.lang.Number>	getValueMap() Get the map of variable/value pairs.
java.lang.String	toString() A string for displaying a trial point.

Methods inherited from class java.lang.Object

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

Field Detail

_values

protected final java.util.Map<Variable,java.lang.Number> _values

A table of trial values keyed by variable

Constructor Detail

TrialPoint

public TrialPoint(java.util.Map<Variable,java.lang.Number> values)

Primary constructor.

Parameters:

values - The new values used to map trial points

TrialPoint

public TrialPoint(TrialPoint trialPoint)

Copy constructor.

Parameters:

trialPoint - the trial point to copy

Method Detail

getValue

public double getValue(Variable variable)

Get the value corresponding to the specified variable.

Parameters:

variable - The variable for which to fetch the value.

Returns:

The value of the specified variable.

getValueMap

public java.util.Map<Variable,java.lang.Number> getValueMap()

Get the map of variable/value pairs.

Returns:

the map of variable/value pairs.

toString

public java.lang.String toString()

A string for displaying a trial point. The string consist of the values for the trial point.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of a trial point.