org.jscience.mathematics.analysis.estimation
Class EstimatedParameter

java.lang.Object
  extended by org.jscience.mathematics.analysis.estimation.EstimatedParameter
All Implemented Interfaces:
java.io.Serializable, Named
Direct Known Subclasses:
PolynomialCoefficient

public class EstimatedParameter
extends java.lang.Object
implements java.io.Serializable, Named

This class represent the estimated parameters of an estimation problem.

The parameters of an estimation problem have a name, a value and a bound flag. The value of bound parameters is considered trusted and the solvers should not adjust them. On the other hand, the solvers should adjust the value of unbounds parameters until they satisfy convergence criterions specific to each solver.

See Also:
Serialized Form

Field Summary
protected  double estimate
          Current value of the parameter
 
Constructor Summary
EstimatedParameter(EstimatedParameter parameter)
          Copy constructor.
EstimatedParameter(java.lang.String name, double firstEstimate)
          Simple constructor.
EstimatedParameter(java.lang.String name, double firstEstimate, boolean bound)
          Simple constructor.
 
Method Summary
 double getEstimate()
          Get the current estimate of the parameter
 java.lang.String getName()
          get the name of the parameter
 boolean isBound()
          Check if the parameter is bound
 void setBound(boolean bound)
          Set the bound flag of the parameter
 void setEstimate(double estimate)
          Set a new estimated value for the parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

estimate

protected double estimate
Current value of the parameter

Constructor Detail

EstimatedParameter

public EstimatedParameter(java.lang.String name,
                          double firstEstimate)
Simple constructor. Build an instance from a first estimate of the parameter, initially considered unbound.

Parameters:
name - name of the parameter
firstEstimate - first estimate of the parameter

EstimatedParameter

public EstimatedParameter(java.lang.String name,
                          double firstEstimate,
                          boolean bound)
Simple constructor. Build an instance from a first estimate of the parameter and a bound flag

Parameters:
name - name of the parameter
firstEstimate - first estimate of the parameter
bound - flag, should be true if the parameter is bound

EstimatedParameter

public EstimatedParameter(EstimatedParameter parameter)
Copy constructor. Build a copy of a parameter

Parameters:
parameter - instance to copy
Method Detail

setEstimate

public void setEstimate(double estimate)
Set a new estimated value for the parameter.

Parameters:
estimate - new estimate for the parameter

getEstimate

public double getEstimate()
Get the current estimate of the parameter

Returns:
current estimate

getName

public java.lang.String getName()
get the name of the parameter

Specified by:
getName in interface Named
Returns:
parameter name

setBound

public void setBound(boolean bound)
Set the bound flag of the parameter

Parameters:
bound - this flag should be set to true if the parameter is bound (i.e. if it should not be adjusted by the solver).

isBound

public boolean isBound()
Check if the parameter is bound

Returns:
true if the parameter is bound