Package com.irurueta.numerical.polynomials.estimators

Class LMSEPolynomialEstimator

java.lang.Object

com.irurueta.numerical.polynomials.estimators.PolynomialEstimator

com.irurueta.numerical.polynomials.estimators.LMSEPolynomialEstimator

public class LMSEPolynomialEstimator
extends PolynomialEstimator

This class defines an LMSE (Least Mean Square Error) estimator of a polynomial of a given degree using points where polynomials (or its derivatives or integrals) are evaluated.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowLMSESolution	Indicates if an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided.
static final boolean	DEFAULT_ALLOW_LMSE_SOLUTION	Indicates if by default an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided.

Fields inherited from class com.irurueta.numerical.polynomials.estimators.PolynomialEstimator

DEFAULT_ESTIMATOR_TYPE, degree, evaluations, listener, locked, MIN_DEGREE

Constructor Summary

Constructors

Constructor	Description
LMSEPolynomialEstimator()	Constructor.
LMSEPolynomialEstimator(int degree)	Constructor.
LMSEPolynomialEstimator(int degree, PolynomialEstimatorListener listener)	Constructor.
LMSEPolynomialEstimator(int degree, List<PolynomialEvaluation> evaluations)	Constructor.
LMSEPolynomialEstimator(int degree, List<PolynomialEvaluation> evaluations, PolynomialEstimatorListener listener)	Constructor.
LMSEPolynomialEstimator(PolynomialEstimatorListener listener)	Constructor.
LMSEPolynomialEstimator(List<PolynomialEvaluation> evaluations)	Constructor.
LMSEPolynomialEstimator(List<PolynomialEvaluation> evaluations, PolynomialEstimatorListener listener)	Constructor.

Method Summary

Modifier and Type	Method	Description
Polynomial	estimate()	Estimates a polynomial based on provided evaluations.
PolynomialEstimatorType	getType()	Returns type of polynomial estimator.
boolean	isLMSESolutionAllowed()	Indicates if an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided.
void	setLMSESolutionAllowed(boolean allowed)	Specified if an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided.

Methods inherited from class com.irurueta.numerical.polynomials.estimators.PolynomialEstimator

create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, fillDerivativeEvaluation, fillDirectEvaluation, fillIntegralEvaluation, fillIntegralIntervalEvaluation, getDegree, getEvaluations, getListener, getMinNumberOfEvaluations, getMinNumberOfEvaluations, isLocked, isReady, normalize, setDegree, setDegreeAndEvaluations, setEvaluations, setListener

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ALLOW_LMSE_SOLUTION

public static final boolean DEFAULT_ALLOW_LMSE_SOLUTION

Indicates if by default an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided.

See Also:

• Constant Field Values

allowLMSESolution

private boolean allowLMSESolution

Indicates if an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided. If false, the exceeding evaluations are ignored, and only the first minimum required are used.

Constructor Details

LMSEPolynomialEstimator

public LMSEPolynomialEstimator()

Constructor.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(int degree)

Constructor.

Parameters:

degree - degree of polynomial to be estimated.

Throws:

IllegalArgumentException - if provided degree is less than 1.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(List<PolynomialEvaluation> evaluations)

Constructor.

Parameters:

evaluations - collection of polynomial evaluations.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(PolynomialEstimatorListener listener)

Constructor.

Parameters:

listener - listener to be notified of events.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(int degree,
 List<PolynomialEvaluation> evaluations)

Constructor.

Parameters:

degree - degree of polynomial to be estimated.

evaluations - collection of polynomial evaluations.

Throws:

IllegalArgumentException - if provided degree is less than 1.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(int degree,
 PolynomialEstimatorListener listener)

Constructor.

Parameters:

degree - degree of polynomial to be estimated.

listener - listener to be notified of events.

Throws:

IllegalArgumentException - if provided degree is less than 1.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(List<PolynomialEvaluation> evaluations,
 PolynomialEstimatorListener listener)

Constructor.

Parameters:

evaluations - collection of polynomial evaluations.

listener - listener to be notified of events.

LMSEPolynomialEstimator

public LMSEPolynomialEstimator(int degree,
 List<PolynomialEvaluation> evaluations,
 PolynomialEstimatorListener listener)

Constructor.

Parameters:

degree - degree of polynomial to be estimated.

evaluations - collection of polynomial evaluations.

listener - listener to be notified of events.

Throws:

IllegalArgumentException - if provided degree is less than 1.

Method Details

isLMSESolutionAllowed

public boolean isLMSESolutionAllowed()

Indicates if an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided. If false, the exceeding evaluations are ignored, and only the first minimum required are used.

Returns:

true if LMSE solution is allowed, false otherwise.

setLMSESolutionAllowed

public void setLMSESolutionAllowed(boolean allowed)
                            throws LockedException

Specified if an LMSE (Least Mean Square Error) solution is allowed if more evaluations than the required minimum are provided. If false, the exceeding evaluations are ignored, and only the first minimum required are used.

Parameters:

allowed - true if LMSE solution is allowed, false otherwise.

Throws:

LockedException - if estimator is locked.

estimate

public Polynomial estimate()
                    throws LockedException,
NotReadyException,
PolynomialEstimationException

Estimates a polynomial based on provided evaluations.

Specified by:

estimate in class PolynomialEstimator

Returns:

estimated polynomial.

Throws:

LockedException - if estimator is locked.

NotReadyException - if estimator is not ready.

PolynomialEstimationException - if polynomial estimation fails.

getType

public PolynomialEstimatorType getType()

Returns type of polynomial estimator.

Specified by:

getType in class PolynomialEstimator

Returns:

type of polynomial estimator.