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

Class DelegatedBivariateIntegrator

java.lang.Object

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

All Implemented Interfaces:

BivariateIntegrator

public class DelegatedBivariateIntegrator
extends Object
implements BivariateIntegrator

Bivariate integrator based on two univariate integrators.

Since:

4.1

Version:

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

Author:

GMV

Constructor Summary

Constructors

Constructor and Description
DelegatedBivariateIntegrator(UnivariateIntegrator integratorXIn, UnivariateIntegrator integratorYIn) Build a bivariate integrator with the two specified univariate integrators.

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.
UnivariateIntegrator	getIntegratorX() Gets the univariate integrator associated to the 1st axis.
UnivariateIntegrator	getIntegratorY() Gets the univariate integrator associated to the 2nd axis.
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 xminIn, double xmaxIn, double yminIn, double ymaxIn) Integrates the function on the specified domain.
protected void	setup(int maxEval, BivariateFunction f, double xminIn, double xmaxIn, double yminIn, double ymaxIn) Prepares for computation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatedBivariateIntegrator

public DelegatedBivariateIntegrator(UnivariateIntegrator integratorXIn,
                                    UnivariateIntegrator integratorYIn)

Build a bivariate integrator with the two specified univariate integrators.

Parameters:

integratorXIn - integrator along 1st variable

integratorYIn - integrator along 2nd variable

Method Detail

setup

protected void setup(int maxEval,
                     BivariateFunction f,
                     double xminIn,
                     double xmaxIn,
                     double yminIn,
                     double ymaxIn)

Prepares for computation. Subclasses must call this method if they override any of the solve methods.

Parameters:

maxEval - the maximum number of evaluations.

f - the objective function

xminIn - lower x bound

xmaxIn - upper x bound

yminIn - lower y bound

ymaxIn - upper y bound

Throws:

NullArgumentException - if f is null.

integrate

public double integrate(int maxEval,
                        BivariateFunction f,
                        double xminIn,
                        double xmaxIn,
                        double yminIn,
                        double ymaxIn)

Integrates the function on the specified domain.

Specified by:

integrate in interface BivariateIntegrator

Parameters:

maxEval - the maximum number of evaluations

f - the integrand function

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

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

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

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

Returns:

the value of integral

getIntegratorX

public UnivariateIntegrator getIntegratorX()

Gets the univariate integrator associated to the 1st axis.

Returns:

the univariate integrator associated to the 1st axis

getIntegratorY

public UnivariateIntegrator getIntegratorY()

Gets the univariate integrator associated to the 2nd axis.

Returns:

the univariate integrator associated to the 2nd axis

getFunction

public BivariateFunction getFunction()

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

Specified by:

getFunction in interface BivariateIntegrator

Returns:

the last function integrated

getEvaluations

public int getEvaluations()

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

Specified by:

getEvaluations in interface BivariateIntegrator

Returns:

the number of function evaluations

getMaxEvaluations

public int getMaxEvaluations()

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

Specified by:

getMaxEvaluations in interface BivariateIntegrator

Returns:

the maximal number of function evaluations

getXMin

public double getXMin()

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

Specified by:

getXMin in interface BivariateIntegrator

Returns:

the dimension of the integration domain

getXMax

public double getXMax()

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

Specified by:

getXMax in interface BivariateIntegrator

Returns:

the dimension of the integration domain

getYMin

public double getYMin()

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

Specified by:

getYMin in interface BivariateIntegrator

Returns:

the dimension of the integration domain

getYMax

public double getYMax()

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

Specified by:

getYMax in interface BivariateIntegrator

Returns:

the dimension of the integration domain