Class EstimatedParameter
- java.lang.Object
-
- org.apache.commons.math.estimation.EstimatedParameter
-
- All Implemented Interfaces:
java.io.Serializable
@Deprecated public class EstimatedParameter extends java.lang.Object implements java.io.Serializable
Deprecated.as of 2.0, everything in package org.apache.commons.math.estimation has been deprecated and replaced by package org.apache.commons.math.optimization.generalThis class represents 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.
- Since:
- 1.2
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EstimatedParameter(java.lang.String name, double firstEstimate)
Deprecated.Simple constructor.EstimatedParameter(java.lang.String name, double firstEstimate, boolean bound)
Deprecated.Simple constructor.EstimatedParameter(EstimatedParameter parameter)
Deprecated.Copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description double
getEstimate()
Deprecated.Get the current estimate of the parameterjava.lang.String
getName()
Deprecated.get the name of the parameterboolean
isBound()
Deprecated.Check if the parameter is boundvoid
setBound(boolean bound)
Deprecated.Set the bound flag of the parametervoid
setEstimate(double estimate)
Deprecated.Set a new estimated value for the parameter.
-
-
-
Constructor Detail
-
EstimatedParameter
public EstimatedParameter(java.lang.String name, double firstEstimate)
Deprecated.Simple constructor. Build an instance from a first estimate of the parameter, initially considered unbound.- Parameters:
name
- name of the parameterfirstEstimate
- first estimate of the parameter
-
EstimatedParameter
public EstimatedParameter(java.lang.String name, double firstEstimate, boolean bound)
Deprecated.Simple constructor. Build an instance from a first estimate of the parameter and a bound flag- Parameters:
name
- name of the parameterfirstEstimate
- first estimate of the parameterbound
- flag, should be true if the parameter is bound
-
EstimatedParameter
public EstimatedParameter(EstimatedParameter parameter)
Deprecated.Copy constructor. Build a copy of a parameter- Parameters:
parameter
- instance to copy
-
-
Method Detail
-
setEstimate
public void setEstimate(double estimate)
Deprecated.Set a new estimated value for the parameter.- Parameters:
estimate
- new estimate for the parameter
-
getEstimate
public double getEstimate()
Deprecated.Get the current estimate of the parameter- Returns:
- current estimate
-
getName
public java.lang.String getName()
Deprecated.get the name of the parameter- Returns:
- parameter name
-
setBound
public void setBound(boolean bound)
Deprecated.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()
Deprecated.Check if the parameter is bound- Returns:
- true if the parameter is bound
-
-