org.apache.commons.math.estimation
@Deprecated public class EstimatedParameter extends Object implements Serializable
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.
Modifier and Type | Field and Description |
---|---|
private boolean |
bound
Deprecated.
Indicator for bound parameters
(ie parameters that should not be estimated)
|
protected double |
estimate
Deprecated.
Current value of the parameter
|
private String |
name
Deprecated.
Name of the parameter
|
private static long |
serialVersionUID
Deprecated.
Serializable version identifier
|
Constructor and Description |
---|
EstimatedParameter(EstimatedParameter parameter)
Deprecated.
Copy constructor.
|
EstimatedParameter(String name,
double firstEstimate)
Deprecated.
Simple constructor.
|
EstimatedParameter(String name,
double firstEstimate,
boolean bound)
Deprecated.
Simple constructor.
|
Modifier and Type | Method and Description |
---|---|
double |
getEstimate()
Deprecated.
Get the current estimate of the parameter
|
String |
getName()
Deprecated.
get the name of the parameter
|
boolean |
isBound()
Deprecated.
Check if the parameter is bound
|
void |
setBound(boolean bound)
Deprecated.
Set the bound flag of the parameter
|
void |
setEstimate(double estimate)
Deprecated.
Set a new estimated value for the parameter.
|
private static final long serialVersionUID
protected double estimate
private final String name
private boolean bound
public EstimatedParameter(String name, double firstEstimate)
name
- name of the parameterfirstEstimate
- first estimate of the parameterpublic EstimatedParameter(String name, double firstEstimate, boolean bound)
name
- name of the parameterfirstEstimate
- first estimate of the parameterbound
- flag, should be true if the parameter is boundpublic EstimatedParameter(EstimatedParameter parameter)
parameter
- instance to copypublic void setEstimate(double estimate)
estimate
- new estimate for the parameterpublic double getEstimate()
public String getName()
public void setBound(boolean bound)
bound
- this flag should be set to true if the parameter is
bound (i.e. if it should not be adjusted by the solver).public boolean isBound()
Copyright (c) 2003-2013 Apache Software Foundation