org.apache.commons.math.estimation
Class AbstractEstimator

java.lang.Object
  extended by org.apache.commons.math.estimation.AbstractEstimator
All Implemented Interfaces:
Estimator
Direct Known Subclasses:
GaussNewtonEstimator, LevenbergMarquardtEstimator

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.general

@Deprecated
public abstract class AbstractEstimator
extends Object
implements Estimator

Base class for implementing estimators.

This base class handles the boilerplates methods associated to thresholds settings, jacobian and error estimation.

Since:
1.2

Field Summary
static int DEFAULT_MAX_COST_EVALUATIONS
          Deprecated. Default maximal number of cost evaluations allowed.
 
Method Summary
abstract  void estimate(EstimationProblem problem)
          Deprecated. Solve an estimation problem.
 double getChiSquare(EstimationProblem problem)
          Deprecated. Get the Chi-Square value.
 int getCostEvaluations()
          Deprecated. Get the number of cost evaluations.
 double[][] getCovariances(EstimationProblem problem)
          Deprecated. Get the covariance matrix of unbound estimated parameters.
 int getJacobianEvaluations()
          Deprecated. Get the number of jacobian evaluations.
 double getRMS(EstimationProblem problem)
          Deprecated. Get the Root Mean Square value.
 double[] guessParametersErrors(EstimationProblem problem)
          Deprecated. Guess the errors in unbound estimated parameters.
 void setMaxCostEval(int maxCostEval)
          Deprecated. Set the maximal number of cost evaluations allowed.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_MAX_COST_EVALUATIONS

public static final int DEFAULT_MAX_COST_EVALUATIONS
Deprecated. 
Default maximal number of cost evaluations allowed.

See Also:
Constant Field Values
Method Detail

setMaxCostEval

public final void setMaxCostEval(int maxCostEval)
Deprecated. 
Set the maximal number of cost evaluations allowed.

Parameters:
maxCostEval - maximal number of cost evaluations allowed
See Also:
estimate(org.apache.commons.math.estimation.EstimationProblem)

getCostEvaluations

public final int getCostEvaluations()
Deprecated. 
Get the number of cost evaluations.

Returns:
number of cost evaluations

getJacobianEvaluations

public final int getJacobianEvaluations()
Deprecated. 
Get the number of jacobian evaluations.

Returns:
number of jacobian evaluations

getRMS

public double getRMS(EstimationProblem problem)
Deprecated. 
Get the Root Mean Square value. Get the Root Mean Square value, i.e. the root of the arithmetic mean of the square of all weighted residuals. This is related to the criterion that is minimized by the estimator as follows: if c if the criterion, and n is the number of measurements, then the RMS is sqrt (c/n).

Specified by:
getRMS in interface Estimator
Parameters:
problem - estimation problem
Returns:
RMS value
See Also:
Estimator.guessParametersErrors(EstimationProblem)

getChiSquare

public double getChiSquare(EstimationProblem problem)
Deprecated. 
Get the Chi-Square value.

Parameters:
problem - estimation problem
Returns:
chi-square value

getCovariances

public double[][] getCovariances(EstimationProblem problem)
                          throws EstimationException
Deprecated. 
Get the covariance matrix of unbound estimated parameters.

Specified by:
getCovariances in interface Estimator
Parameters:
problem - estimation problem
Returns:
covariance matrix
Throws:
EstimationException - if the covariance matrix cannot be computed (singular problem)

guessParametersErrors

public double[] guessParametersErrors(EstimationProblem problem)
                               throws EstimationException
Deprecated. 
Guess the errors in unbound estimated parameters.

Guessing is covariance-based, it only gives rough order of magnitude.

Specified by:
guessParametersErrors in interface Estimator
Parameters:
problem - estimation problem
Returns:
errors in estimated parameters
Throws:
EstimationException - if the covariances matrix cannot be computed or the number of degrees of freedom is not positive (number of measurements lesser or equal to number of parameters)
See Also:
Estimator.getRMS(EstimationProblem)

estimate

public abstract void estimate(EstimationProblem problem)
                       throws EstimationException
Deprecated. 
Solve an estimation problem.

The method should set the parameters of the problem to several trial values until it reaches convergence. If this method returns normally (i.e. without throwing an exception), then the best estimate of the parameters can be retrieved from the problem itself, through the EstimationProblem.getAllParameters method.

Specified by:
estimate in interface Estimator
Parameters:
problem - estimation problem to solve
Throws:
EstimationException - if the problem cannot be solved


jHepWork 3.0 ©