OrthogonalProductFunctionFactory

class OrthogonalProductFunctionFactory(*args)

Base class for orthogonal multivariate functions.

Available constructors:

OrthogonalProductFunctionFactory(functions)

OrthogonalProductFunctionFactory(functions, enumerateFunction)

Parameters:

functions : list of OrthogonalUniVariateFunctionFamily

List of orthogonal univariate function factories with the same dimension as the orthogonal basis.

enumerateFunction : EnumerateFunction

Associates to an integer its multi-index image in the \Nset^d dimension, which is the dimension of the basis. This multi-index represents the collection of degrees of the univariate polynomials.

Notes

OrthogonalProductFunctionFactory is a particular case of implementation of the OrthogonalBasis in the case of polynomial chaos expansion. It provides to the OrthogonalBasis the persistent types of the univariate orthogonal polynomials (e.g. Hermite, Legendre, Laguerre and Jacobi) needed to determine the distribution measure of projection of the input variable. Let’s note that the exact hessian and gradient have been implemented for the product of polynomials. To facilitate the construction of the basis it is recommanded to use the class StandardDistributionPolynomialFactory.

Examples

>>> import openturns as ot
>>> from math import pi
>>> funcColl = [ot.HaarWaveletFactory(), ot.FourierSeriesFactory()]
>>> dim = len(funcColl)
>>> enumerateFunction = ot.LinearEnumerateFunction(dim)
>>> productBasis = ot.OrthogonalProductFunctionFactory(funcColl, enumerateFunction)

Methods

add(elt) Add an element in the Basis.
build(index) Get the term of the basis collection at a given index.
getClassName() Accessor to the object’s name.
getDimension() Get the dimension of the Basis.
getEnumerateFunction() Return the enumerate function.
getFunctionFamilyCollection() Get the collection of univariate orthogonal function families.
getId() Accessor to the object’s id.
getMeasure() Get the measure upon which the basis is orthogonal.
getName() Accessor to the object’s name.
getShadowedId() Accessor to the object’s shadowed id.
getSize() Get the size of the Basis.
getSubBasis(indices) Get a sub-basis of the Basis.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
isFunctional() Tell whether the basis is functional.
isOrthogonal() Tell whether the basis is orthogonal.
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

add(elt)

Add an element in the Basis.

Parameters:

function : Function

Function added in the Basis.

Examples

>>> import openturns as ot
>>> dimension = 3
>>> input = ['x0', 'x1', 'x2']
>>> functions = []
>>> for i in range(2):
...     functions.append(ot.SymbolicFunction(input, [input[i]]))
>>> basis = ot.Basis(functions)
>>> basis.add(ot.SymbolicFunction(input, [input[2]]))
build(index)

Get the term of the basis collection at a given index.

Parameters:

index : int

Indicates the term of the basis which must be constructed. In other words, index is used by a bijection from \Nset to \Nset^d (with d the dimension of the basis). The bijection is detailed in EnumerateFunction.

Returns:

function : Function

The term of the basis collection at the index index.

Examples

>>> import openturns as ot
>>> # Create an orthogonal basis
>>> polynomialCollection = [ot.LegendreFactory(), ot.LaguerreFactory(), ot.HermiteFactory()]
>>> productBasis = ot.OrthogonalBasis(ot.OrthogonalProductPolynomialFactory(polynomialCollection))
>>> termBasis = productBasis.build(4)
>>> print(termBasis.getEvaluation())
-1.11803 + 3.3541 * x0^2
>>> termBasis = productBasis.build(5)
>>> print(termBasis.getEvaluation())
(1.73205 * x0) * (-1 + x1)
getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getDimension()

Get the dimension of the Basis.

Returns:

dimension : int

Dimension of the Basis.

getEnumerateFunction()

Return the enumerate function.

Returns:

enumerateFunction : EnumerateFunction

Enumerate function that translates unidimensional indices into multidimensional indices.

getFunctionFamilyCollection()

Get the collection of univariate orthogonal function families.

Returns:

polynomialFamily : list of OrthogonalUniVariateFunctionFamily

List of orthogonal univariate function families.

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getMeasure()

Get the measure upon which the basis is orthogonal.

Returns:

measure : Distribution

Measure upon which the basis is orthogonal.

Examples

>>> import openturns as ot
>>> # Create an orthogonal basis
>>> polynomialCollection = [ot.LegendreFactory(), ot.LaguerreFactory(), ot.HermiteFactory()]
>>> productBasis = ot.OrthogonalBasis(ot.OrthogonalProductPolynomialFactory(polynomialCollection))
>>> measure = productBasis.getMeasure()
>>> print(measure.getMarginal(0))
Uniform(a = -1, b = 1)
>>> print(measure.getMarginal(1))
Gamma(k = 1, lambda = 1, gamma = 0)
>>> print(measure.getMarginal(2))
Normal(mu = 0, sigma = 1)
getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getSize()

Get the size of the Basis.

Returns:

size : int

Size of the Basis.

getSubBasis(indices)

Get a sub-basis of the Basis.

Parameters:

indices : list of int

Indices of the terms of the Basis put in the sub-basis.

Returns:

subBasis : list of Function

Functions defining a sub-basis.

Examples

>>> import openturns as ot
>>> dimension = 3
>>> input = ['x0', 'x1', 'x2']
>>> functions = []
>>> for i in range(dimension):
...     functions.append(ot.SymbolicFunction(input, [input[i]]))
>>> basis = ot.Basis(functions)
>>> subbasis = basis.getSubBasis([1])
>>> print(subbasis[0].getEvaluation())
[x0,x1,x2]->[x1]
getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

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.

isFunctional()

Tell whether the basis is functional.

Returns:

isOrthogonal : bool

True if the basis is functional i.e. if its terms are a solution to an equation (e.g. a basis made up of Legendre functions).

isOrthogonal()

Tell whether the basis is orthogonal.

Returns:

isOrthogonal : bool

True if the basis is orthogonal.

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.