Functions

General mathematical functions

Function(*args)

Function base class.

FunctionImplementation(*args)

Function base class.

SymbolicFunction(*args)

Symbolic function.

TranslationFunction(*args)

Translation function.

LinearFunction(*args)

Linear numerical math function.

QuadraticFunction(*args)

Quadratic function.

DatabaseFunction(*args)

Pre-evaluated function.

PythonFunction(inputDim, outputDim[, func, ...])

Override Function from Python.

OpenTURNSPythonFunction([n, p])

Override Function from Python.

MemoizeFunction(*args)

Function which keeps tracks of input and output.

Algebra of functions

AggregatedFunction(*args)

Aggregated function.

ComposedFunction(*args)

Composed function.

DistanceToDomainFunction(*args)

Function which outputs the Euclidean distance to a Domain \mathcal{D}.

DualLinearCombinationFunction(*args)

Linear combination of functions with vectorial weights.

IdentityFunction(*args)

Identity function.

IndicatorFunction(*args)

Indicator function of a Domain \mathcal{D}.

LinearCombinationFunction(*args)

Linear combination of functions.

ParametricFunction(*args)

Parametric function.

ProductFunction(*args)

Product function.

PointToPointEvaluation(*args)

Evaluation of the composition f \circ g where g acts on points and f produces points.

FieldToFieldConnection(*args)

Composition function f \circ g where g acts on fields and f produces fields.

FieldToPointConnection(*args)

Composition function f \circ g where g acts on fields and f produces points.

PointToFieldConnection(*args)

Composition function f \circ g where g acts on points and f produces fields.

PointToPointConnection(*args)

Composition function f \circ g where g acts on points and f produces points.

Field and mixed functions

Refer to Field functions.

FieldFunction(*args)

Function mapping a field to a field.

FieldToPointFunction(*args)

Function mapping a field into a point.

PointToFieldFunction(*args)

Function mapping a point into a field.

ParametricPointToFieldFunction(*args)

Parametric Point to Field function.

VertexValuePointToFieldFunction(*args)

Function mapping a (vertex, value) point to a field.

ValueFunction(*args)

Function mapping a field to a field.

VertexValueFunction(*args)

Function mapping a field to a field.

PythonFieldFunction(inputMesh, inputDim, ...)

Override FieldFunction from Python.

PythonFieldToPointFunction(inputMesh, ...[, ...])

Override FieldToPointFunction from Python.

PythonPointToFieldFunction(inputDim, ...[, func])

Override PointToFieldFunction from Python.

OpenTURNSPythonFieldFunction(inputMesh, ...)

Override FieldFunction from Python.

OpenTURNSPythonFieldToPointFunction(...)

Override FieldToPointFunction from Python.

OpenTURNSPythonPointToFieldFunction(...)

Override PointToFieldFunction from Python.

Collection of functions

Basis(*args)

Basis.

OrthogonalBasis(*args)

Orthogonal basis.

BasisSequence(*args)

Sequence of basis.

Finite differentiation schemes

CenteredFiniteDifferenceGradient(*args)

First order centered finite-difference scheme.

CenteredFiniteDifferenceHessian(*args)

Second order centered finite-difference scheme.

FiniteDifferenceGradient(*args)

Base class for first order finite-difference schemes.

FiniteDifferenceHessian(*args)

Base class for second order centered finite-difference scheme.

NonCenteredFiniteDifferenceGradient(*args)

First order non-centered finite-difference scheme.

FiniteDifferenceStep(*args)

Base class to define finite difference steps.

ConstantStep(*args)

Constant step.

BlendedStep(*args)

Blended step.

Evaluation functions

Evaluation(*args)

Numerical math evaluation implementation.

EvaluationImplementation(*args)

Numerical math evaluation implementation.

AggregatedEvaluation(*args)

Aggregated numerical math evaluation implementation.

ComposedEvaluation(*args)

Proxy of C++ OT::ComposedEvaluation.

DatabaseEvaluation(*args)

Data based math evaluation implementation.

DistanceToDomainEvaluation(*args)

Proxy of C++ OT::DistanceToDomainEvaluation.

DualLinearCombinationEvaluation(*args)

Dual linear combination evaluation implementation.

IndicatorEvaluation(*args)

Proxy of C++ OT::IndicatorEvaluation.

LinearCombinationEvaluation(*args)

Proxy of C++ OT::LinearCombinationEvaluation.

LinearEvaluation(*args)

Linear numerical math evaluation implementation.

MarginalEvaluation(*args)

Proxy of C++ OT::MarginalEvaluation.

MemoizeEvaluation(*args)

Evaluation which keeps tracks of input and output.

NoEvaluation(*args)

Proxy of C++ OT::NoEvaluation.

ParametricEvaluation(*args)

Proxy of C++ OT::ParametricEvaluation.

PiecewiseHermiteEvaluation(*args)

Piecewise Hermite interpolation evaluation.

PiecewiseLinearEvaluation(*args)

Piecewise linear interpolation evaluation.

P1LagrangeInterpolation(*args)

P1 interpolation of values between two meshes.

P1LagrangeEvaluation(*args)

Evaluation of a P1 Lagrange interpolation over a field.

ProductEvaluation(*args)

Proxy of C++ OT::ProductEvaluation.

ProductPolynomialEvaluation(*args)

Product polynomial evaluation implementation.

QuadraticEvaluation(*args)

Proxy of C++ OT::QuadraticEvaluation.

SymbolicEvaluation(*args)

Proxy of C++ OT::SymbolicEvaluation.

TranslationEvaluation(*args)

Translation evaluation.

Gradient functions

GradientImplementation(*args)

Numerical math gradient implementation.

SymbolicGradient(*args)

Proxy of C++ OT::SymbolicGradient.

ComposedGradient(*args)

Proxy of C++ OT::ComposedGradient.

ConstantGradient(*args)

Proxy of C++ OT::ConstantGradient.

DualLinearCombinationGradient(*args)

Dual linear combination gradient implementation.

LinearCombinationGradient(*args)

Proxy of C++ OT::LinearCombinationGradient.

LinearGradient(*args)

Linear numerical math gradient implementation.

NoGradient(*args)

Proxy of C++ OT::NoGradient.

ParametricGradient(*args)

Proxy of C++ OT::ParametricGradient.

ProductGradient(*args)

Proxy of C++ OT::ProductGradient.

MarginalGradient(*args)

Proxy of C++ OT::MarginalGradient.

Hessian functions

HessianImplementation(*args)

Numerical math hessian implementation.

SymbolicHessian(*args)

Proxy of C++ OT::SymbolicHessian.

ComposedHessian(*args)

Proxy of C++ OT::ComposedHessian.

ConstantHessian(*args)

Proxy of C++ OT::ConstantHessian.

DualLinearCombinationHessian(*args)

Dual linear combination hessian implementation.

LinearCombinationHessian(*args)

Proxy of C++ OT::LinearCombinationHessian.

NoHessian(*args)

Proxy of C++ OT::NoHessian.

NullHessian(*args)

Proxy of C++ OT::NullHessian.

ParametricHessian(*args)

Proxy of C++ OT::ParametricHessian.

ProductHessian(*args)

Proxy of C++ OT::ProductHessian.

MarginalHessian(*args)

Proxy of C++ OT::MarginalHessian.

Differential equation solvers

ODESolver(*args)

ODE solver base class.

RungeKutta(*args)

Runge-Kutta fourth-order method.

Fehlberg(*args)

Adaptive order Fehlberg method.

Special functions

Special functions are implemented as C++ static methods and are available as Python functions.

SpecFunc.AccurateSum(v)

Accurate summation.

SpecFunc.BesselI0(x)

Modified first kind Bessel function of order 0.

SpecFunc.BesselI1(x)

Modified first kind Bessel function of order 1.

SpecFunc.BesselK(nu, x)

Modified second kind Bessel function of order \nu.

SpecFunc.BesselKDerivative(nu, x)

Derivative of the modified second kind Bessel function of order \nu.

SpecFunc.Beta(a, b)

Beta function \mathrm{B}.

SpecFunc.BitCount(n)

Compute the number of bits set to 1 in an integer.

SpecFunc.Clip01(prob[, tail])

Clip a value on [0, 1].

SpecFunc.Dawson(*args)

Dawson function.

SpecFunc.Debye(x, n)

Debye function of order n.

SpecFunc.DeltaLogBesselI10(x)

Difference between the logarithms of Bessel I1 and I0.

SpecFunc.DiGamma(*args)

Digamma function.

SpecFunc.DiGammaInv(a)

Inverse of the DiGamma function.

SpecFunc.DiLog(x)

Dilogarithm function.

SpecFunc.Ei(*args)

Exponential integral function.

SpecFunc.Erf(*args)

Error function Erf.

SpecFunc.ErfC(*args)

Complementary error function ErfC.

SpecFunc.ErfCX(*args)

ErfCX function.

SpecFunc.ErfI(*args)

Imaginary error function ErfI.

SpecFunc.ErfInverse(x)

Inverse of the error function Erf.

SpecFunc.Expm1(z)

Expm1 function.

SpecFunc.Factorial(n)

Factorial function.

SpecFunc.Faddeeva(z)

Complex Faddeeva function.

SpecFunc.FaddeevaIm(x)

Imaginary part of the Faddeeva function.

SpecFunc.Gamma(*args)

Gamma function \Gamma.

SpecFunc.GammaCorrection(a)

GammaCorrection function.

SpecFunc.HyperGeom_1_1(*args)

Hypergeometric function of type (1,1).

SpecFunc.HyperGeom_2_1(p1, p2, q1, x)

Hypergeometric function of type (2,1).

SpecFunc.HyperGeom_2_2(p1, p2, q1, q2, x)

Hypergeometric function of type (2,2).

SpecFunc.IGamma1pm1(a)

IGamma1pm1 function.

SpecFunc.IncompleteBeta(a, b, x[, tail])

Incomplete Beta function.

SpecFunc.IncompleteBetaInverse(a, b, x[, tail])

Inverse of the incomplete Beta function.

SpecFunc.IncompleteGamma(a, x[, tail])

Incomplete Gamma function.

SpecFunc.IncompleteGammaInverse(a, x[, tail])

Inverse of the incomplete Gamma function with respect to x.

SpecFunc.IPow(x, n)

Raise the given x to the integral power n.

SpecFunc.IRoot(x, n)

Extract the n integral root of the given x.

SpecFunc.IsNormal(value)

Check for non-NaN and non-Inf values.

SpecFunc.LambertW(x[, principal])

Lambert W function.

SpecFunc.Log1MExp(x)

Log1MExp function.

SpecFunc.Log1p(z)

Log1p function.

SpecFunc.Log2(n)

Integer base 2 logarithm of n.

SpecFunc.LogBesselI0(x)

Logarithm of the modified first kind Bessel function of order 0.

SpecFunc.LogBesselI1(x)

Logarithm of the modified first kind Bessel function of order 1.

SpecFunc.LogBesselK(nu, x)

Logarithm of the modified second kind Bessel function of order \nu.

SpecFunc.LogBeta(a, b)

Logarithm of the Beta function.

SpecFunc.LogFactorial(n)

Logarithm of the factorial function.

SpecFunc.LogGamma(*args)

Logarithm of the Gamma function.

SpecFunc.LogGamma1p(a)

LogGamma1p function.

SpecFunc.NextPowerOfTwo(n)

Smallest power of two greater or equal to the given n.

SpecFunc.Psi(*args)

Psi function, alias for digamma function.

SpecFunc.RegularizedIncompleteBeta(a, b, x)

Regularized incomplete Beta function.

SpecFunc.RegularizedIncompleteBetaInverse(a, b, x)

Inverse of the regularized incomplete Beta function.

SpecFunc.RegularizedIncompleteGamma(a, x[, tail])

Regularized incomplete Gamma function.

SpecFunc.RegularizedIncompleteGammaInverse(a, x)

Inverse of the regularized incomplete Gamma function.

SpecFunc.Stirlerr(n)

Error of the Stirling approximation of the factorial logarithm.

SpecFunc.TriGamma(x)

TriGamma function.

Special constants

  • SpecFunc.Infinity : inf

  • SpecFunc.MaxScalar : maximum float value

  • SpecFunc.LogMaxScalar : log of SpecFunc.MaxScalar

  • SpecFunc.MinScalar : minimum positive float value

  • SpecFunc.LowestScalar : -inf

  • SpecFunc.LogMinScalar : log of SpecFunc.MinScalar

External code coupling

These methods are dedicated to coupling external codes by means of text files.

coupling_tools.replace(infile, outfile, ...)

Replace values in a file using delimiters.

coupling_tools.execute(cmd[, cwd, shell, ...])

Launch an external process.

coupling_tools.get_value(filename[, token, ...])

Get a value from a file using a delimiter and/or offsets.

coupling_tools.get_line_col(filename[, ...])

Get a value at specific line/columns coordinates.

coupling_tools.get_regex(filename, patterns)

Get values from a file using regex.

coupling_tools.get(filename[, tokens, ...])

Get several values from a file using delimiters and/or offsets.

1-D functions

UniVariateFunction(*args)

Base class for univariate functions.

Testing module

This module is dedicated to the development in the library.

testing.assert_almost_equal(*args)

Raises an exception if two objects are not equal up to desired tolerance.

testing.DistributionValidation(*args)

Automates distribution tests.