fr.cnes.sirius.patrius.math.analysis.integration.bivariate

Interface BivariateIntegrator

All Known Implementing Classes:

DelegatedBivariateIntegrator

public interface BivariateIntegrator

Interface for bivariate real integration algorithms.

Since:

4.1

Version:

$Id: SimpsonIntegrator.java 18108 2017-10-04 06:45:27Z bignon $

Author:

GMV

Method Summary

Modifier and Type	Method and Description
int	getEvaluations() Returns the number of function evaluations made during the last run of the integrator.
BivariateFunction	getFunction() Returns the function used during the last run of the integrator.
int	getMaxEvaluations() Returns the maximal number of function evaluations authorized during the last run of the integrator.
double	getXMax() Returns the upper bounds on x used during the last call to this integrator.
double	getXMin() Returns the lower bounds on x used during the last call to this integrator.
double	getYMax() Returns the upper bounds on y used during the last call to this integrator.
double	getYMin() Returns the lower bounds on y used during the last call to this integrator.
double	integrate(int maxEval, BivariateFunction f, double xmin, double xmax, double ymin, double ymax) Integrates the function on the specified domain.

Method Detail

integrate

double integrate(int maxEval,
                 BivariateFunction f,
                 double xmin,
                 double xmax,
                 double ymin,
                 double ymax)

Integrates the function on the specified domain.

Parameters:

maxEval - the maximum number of evaluations

f - the integrand function

xmin - the lower bound of the interval for the 1st axis

xmax - the upper bound of the interval for the 1st axis

ymin - the lower bound of the interval for the 2nd axis

ymax - the upper bound of the interval for the 2nd axis

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 a convergence problem is detected

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

NullArgumentException - if f is null.

getEvaluations

int getEvaluations()

Returns the number of function evaluations made during the last run of the integrator.

Returns:

the number of function evaluations

getMaxEvaluations

int getMaxEvaluations()

Returns the maximal number of function evaluations authorized during the last run of the integrator.

Returns:

the maximal number of function evaluations

getFunction

BivariateFunction getFunction()

Returns the function used during the last run of the integrator.

Returns:

the last function integrated

getXMin

double getXMin()

Returns the lower bounds on x used during the last call to this integrator.

Returns:

the dimension of the integration domain

getXMax

double getXMax()

Returns the upper bounds on x used during the last call to this integrator.

Returns:

the dimension of the integration domain

getYMin

double getYMin()

Returns the lower bounds on y used during the last call to this integrator.

Returns:

the dimension of the integration domain

getYMax

double getYMax()

Returns the upper bounds on y used during the last call to this integrator.

Returns:

the dimension of the integration domain