GaussLegendre

(Source code, png, hires.png, pdf)

../../_images/GaussLegendre.png
class GaussLegendre(*args)

Tensorized integration algorithm of Gauss-Legendre.

Available constructors:

GaussLegendre(dimension=1)

GaussLegendre(discretization)

Parameters:

dimension : int, dimension>0

The dimension of the functions to integrate. The default discretization is GaussLegendre-DefaultMarginalIntegrationPointsNumber in each dimension, see ResourceMap.

discretization : sequence of int

The number of nodes in each dimension. The sequence must be non-empty and must contain only positive values.

Notes

The Gauss-Legendre algorithm enables to approximate the definite integral:

\int_{\vect{a}}^\vect{b} f(\vect{t})\di{\vect{t}}

with f: \Rset^d \mapsto \Rset^p, \vect{a}, \vect{b}\in\Rset^d using a fixed tensorized Gauss-Legendre approximation:

\int_{\vect{a}}^\vect{b} f(\vect{t})\di{\vect{t}} = \sum_{\vect{n}\in \cN}\left(\prod_{i=1}^d w^{N_i}_{n_i}\right)f(\xi^{N_1}_{n_1},\dots,\xi^{N_d}_{n_d})

where \xi^{N_i}_{n_i} is the n_i`th node of the :math:`N_i-points Gauss-Legendre 1D integration rule and w^{N_i}_{n_i} the associated weight.

Examples

Create a Gauss-Legendre algorithm:

>>> import openturns as ot
>>> algo = ot.GaussLegendre(2)
>>> algo = ot.GaussLegendre([2, 4, 5])

Methods

getClassName() Accessor to the object’s name.
getDiscretization() Accessor to the discretization of the tensorized rule.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getNodes() Accessor to the integration nodes.
getShadowedId() Accessor to the object’s shadowed id.
getVisibility() Accessor to the object’s visibility state.
getWeights() Accessor to the integration weights.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
integrate(*args) Evaluation of the integral of f on an interval.
integrateWithNodes(function, interval)
setName(name) Accessor to the object’s name.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

x.__init__(…) initializes x; see help(type(x)) for signature

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getDiscretization()

Accessor to the discretization of the tensorized rule.

Returns:

discretization : Indices

The number of integration point in each dimension.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getNodes()

Accessor to the integration nodes.

Returns:

nodes : Sample

The tensorized Gauss-Legendre integration nodes on [0,1]^d where d>0 is the dimension of the integration algorithm.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

getWeights()

Accessor to the integration weights.

Returns:

weights : Point

The tensorized Gauss-Legendre integration weights on [0,1]^d where d>0 is the dimension of the integration algorithm.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

integrate(*args)

Evaluation of the integral of f on an interval.

Available usages:

integrate(f, interval)

integrate(f, interval, xi)

Parameters:

f : Function, f: \Rset^d \mapsto \Rset^p

The integrand function.

interval : Interval, interval \in \Rset^d

The integration domain.

xi : Sample

The integration nodes.

Returns:

value : Point

Approximation of the integral.

Examples

>>> import openturns as ot
>>> f = ot.SymbolicFunction(['x'], ['sin(x)'])
>>> a = -2.5
>>> b = 4.5
>>> algoGL = ot.GaussLegendre([10])
>>> value = algoGL.integrate(f, ot.Interval(a, b))[0]
>>> print(value)
-0.590...
setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.