org.apache.commons.math3.analysis.integration

Class BaseAbstractUnivariateIntegrator

java.lang.Object

org.apache.commons.math3.analysis.integration.BaseAbstractUnivariateIntegrator

All Implemented Interfaces:

UnivariateIntegrator

Direct Known Subclasses:

IterativeLegendreGaussIntegrator, LegendreGaussIntegrator, MidPointIntegrator, RombergIntegrator, SimpsonIntegrator, TrapezoidIntegrator

public abstract class BaseAbstractUnivariateIntegrator
extends Object
implements UnivariateIntegrator

Provide a default implementation for several generic functions.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_ABSOLUTE_ACCURACY Default absolute accuracy.
static int	DEFAULT_MAX_ITERATIONS_COUNT Default maximal iteration count.
static int	DEFAULT_MIN_ITERATIONS_COUNT Default minimal iteration count.
static double	DEFAULT_RELATIVE_ACCURACY Default relative accuracy.

Method Summary

Modifier and Type	Method and Description
double	getAbsoluteAccuracy() Get the absolute accuracy.
int	getEvaluations() Get the number of function evaluations of the last run of the integrator.
int	getIterations() Get the number of iterations of the last run of the integrator.
int	getMaximalIterationCount() Get the upper limit for the number of iterations.
int	getMinimalIterationCount() Get the min limit for the number of iterations.
double	getRelativeAccuracy() Get the relative accuracy.
double	integrate(int maxEval, UnivariateFunction f, double lower, double upper) Integrate the function in the given interval.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ABSOLUTE_ACCURACY

public static final double DEFAULT_ABSOLUTE_ACCURACY

Default absolute accuracy.

See Also:

Constant Field Values

DEFAULT_RELATIVE_ACCURACY

public static final double DEFAULT_RELATIVE_ACCURACY

Default relative accuracy.

See Also:

Constant Field Values

DEFAULT_MIN_ITERATIONS_COUNT

public static final int DEFAULT_MIN_ITERATIONS_COUNT

Default minimal iteration count.

See Also:

Constant Field Values

DEFAULT_MAX_ITERATIONS_COUNT

public static final int DEFAULT_MAX_ITERATIONS_COUNT

Default maximal iteration count.

See Also:

Constant Field Values

Method Detail

getRelativeAccuracy

public double getRelativeAccuracy()

Get the relative accuracy.

Specified by:

getRelativeAccuracy in interface UnivariateIntegrator

Returns:

the accuracy

getAbsoluteAccuracy

public double getAbsoluteAccuracy()

Get the absolute accuracy.

Specified by:

getAbsoluteAccuracy in interface UnivariateIntegrator

Returns:

the accuracy

getMinimalIterationCount

public int getMinimalIterationCount()

Get the min limit for the number of iterations.

Specified by:

getMinimalIterationCount in interface UnivariateIntegrator

Returns:

the actual min limit

getMaximalIterationCount

public int getMaximalIterationCount()

Get the upper limit for the number of iterations.

Specified by:

getMaximalIterationCount in interface UnivariateIntegrator

Returns:

the actual upper limit

getEvaluations

public int getEvaluations()

Get the number of function evaluations of the last run of the integrator.

Specified by:

getEvaluations in interface UnivariateIntegrator

Returns:

number of function evaluations

getIterations

public int getIterations()

Get the number of iterations of the last run of the integrator.

Specified by:

getIterations in interface UnivariateIntegrator

Returns:

number of iterations

integrate

public double integrate(int maxEval,
                        UnivariateFunction f,
                        double lower,
                        double upper)
                 throws TooManyEvaluationsException,
                        MaxCountExceededException,
                        MathIllegalArgumentException,
                        NullArgumentException

Integrate the function in the given interval.

Specified by:

integrate in interface UnivariateIntegrator

Parameters:

maxEval - Maximum number of evaluations.

f - the integrand function

lower - the lower bound for the interval

upper - the upper bound for the interval

Returns:

the value of integral

Throws:

TooManyEvaluationsException - if the maximum number of function evaluations is exceeded

MaxCountExceededException - if the maximum iteration count is exceeded or the integrator detects convergence problems otherwise

MathIllegalArgumentException - if min > max or the endpoints do not satisfy the requirements specified by the integrator

NullArgumentException - if f is null.