File: functions.rst

package info (click to toggle)
openturns 1.7-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 38,588 kB
  • ctags: 26,495
  • sloc: cpp: 144,032; python: 26,855; ansic: 7,868; sh: 419; makefile: 263; yacc: 123; lex: 44
file content (255 lines) | stat: -rw-r--r-- 5,970 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
=========
Functions
=========

.. currentmodule:: openturns

General mathematical functions
==============================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    NumericalMathFunction
    PythonFunction
    OpenTURNSPythonFunction

Various functions
=================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    ComposedNumericalMathFunction
    LinearNumericalMathFunction
    ProductNumericalMathFunction
    QuadraticNumericalMathFunction

Dynamical functions
===================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    DynamicalFunction
    PythonDynamicalFunction
    SpatialFunction
    TemporalFunction

Collection of functions
=======================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    Basis
    FunctionalBasis
    OrthogonalBasis
    BasisSequence

Finite differentiation schemes
==============================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    CenteredFiniteDifferenceGradient
    CenteredFiniteDifferenceHessian
    FiniteDifferenceGradient
    FiniteDifferenceHessian
    NonCenteredFiniteDifferenceGradient
    FiniteDifferenceStep
    ConstantStep
    BlendedStep

Evaluation functions
====================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    NumericalMathEvaluationImplementation
    AggregatedNumericalMathEvaluationImplementation
    AnalyticalNumericalMathEvaluationImplementation
    ComposedNumericalMathEvaluationImplementation
    DatabaseNumericalMathEvaluationImplementation
    DualLinearCombinationEvaluationImplementation
    IndicatorNumericalMathEvaluationImplementation
    LinearCombinationEvaluationImplementation
    LinearNumericalMathEvaluationImplementation
    MarginalTransformationEvaluation
    NoNumericalMathEvaluationImplementation
    ParametricEvaluationImplementation
    PiecewiseHermiteEvaluationImplementation
    PiecewiseLinearEvaluationImplementation
    P1LagrangeEvaluationImplementation
    ProductNumericalMathEvaluationImplementation
    ProductPolynomialEvaluationImplementation
    QuadraticNumericalMathEvaluationImplementation

Gradient functions
==================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    NumericalMathGradientImplementation
    AnalyticalNumericalMathGradientImplementation
    ComposedNumericalMathGradientImplementation
    ConstantNumericalMathGradientImplementation
    DualLinearCombinationGradientImplementation
    LinearCombinationGradientImplementation
    LinearNumericalMathGradientImplementation
    NoNumericalMathGradientImplementation
    ParametricGradientImplementation
    ProductNumericalMathGradientImplementation

Hessian functions
=================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    NumericalMathHessianImplementation
    AnalyticalNumericalMathHessianImplementation
    ComposedNumericalMathHessianImplementation
    ConstantNumericalMathHessianImplementation
    DualLinearCombinationHessianImplementation
    LinearCombinationHessianImplementation
    NoNumericalMathHessianImplementation
    ParametricHessianImplementation
    ProductNumericalMathHessianImplementation

Cross-validation algorithm
==========================

.. autosummary::
    :toctree: _generated/
    :template: class.rst_t

    ODESolver
    RungeKutta

Special constants & functions
=============================

Numerical constants
-------------------

.. FAILS: http://trac.openturns.org/ticket/724

    .. autodata:: SpecFunc.EULERSQRT6_PI

    .. autodata:: SpecFunc.EulerConstant

    .. autodata:: SpecFunc.ISQRT2PI

    .. autodata:: SpecFunc.LogMaxNumericalScalar

    .. autodata:: SpecFunc.LogMinNumericalScalar

    .. autodata:: SpecFunc.LOGSQRT2PI

    .. autodata:: SpecFunc.MaxNumericalScalar

    .. autodata:: SpecFunc.MaximumIteration

    .. autodata:: SpecFunc.MinNumericalScalar

    .. autodata:: SpecFunc.NumericalScalarEpsilon

    .. autodata:: SpecFunc.PI2_3

    .. autodata:: SpecFunc.PI2_6

    .. autodata:: SpecFunc.PI_SQRT3

    .. autodata:: SpecFunc.PI_SQRT6

    .. autodata:: SpecFunc.Precision

    .. autodata:: SpecFunc.SQRT2PI

    .. autodata:: SpecFunc.SQRT3_PI

    .. autodata:: SpecFunc.ZETA3

Special functions
-----------------

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

.. autosummary::
    :toctree: _generated/
    :template: function.rst_t

    SpecFunc_BesselI0
    SpecFunc_BesselI1
    SpecFunc_BesselK
    SpecFunc_Beta
    SpecFunc_BitCount
    SpecFunc_Cbrt
    SpecFunc_Dawson
    SpecFunc_Debye
    SpecFunc_DiGamma
    SpecFunc_DiGammaInv
    SpecFunc_DiLog
    SpecFunc_Ei
    SpecFunc_Erf
    SpecFunc_ErfC
    SpecFunc_ErfCX
    SpecFunc_ErfI
    SpecFunc_ErfInverse
    SpecFunc_Expm1
    SpecFunc_Faddeeva
    SpecFunc_FaddeevaIm
    SpecFunc_Gamma
    SpecFunc_GammaCorrection
    SpecFunc_HyperGeom_1_1
    SpecFunc_HyperGeom_2_1
    SpecFunc_HyperGeom_2_2
    SpecFunc_IGamma1pm1
    SpecFunc_IncompleteBeta
    SpecFunc_IncompleteBetaInverse
    SpecFunc_IncompleteGamma
    SpecFunc_IncompleteGammaInverse
    SpecFunc_LambertW
    SpecFunc_LnBeta
    SpecFunc_LnGamma
    SpecFunc_Log1MExp
    SpecFunc_Log1p
    SpecFunc_LogBesselI0
    SpecFunc_LogBesselI1
    SpecFunc_LogBesselK
    SpecFunc_LogBeta
    SpecFunc_LogGamma
    SpecFunc_LogGamma1p
    SpecFunc_NextPowerOfTwo
    SpecFunc_Psi
    SpecFunc_RegularizedIncompleteBeta
    SpecFunc_RegularizedIncompleteBetaInverse
    SpecFunc_RegularizedIncompleteGamma
    SpecFunc_RegularizedIncompleteGammaInverse
    SpecFunc_TriGamma

External code coupling
======================

.. autosummary::
    :toctree: _generated/
    :template: function.rst_t

    coupling_tools.replace
    coupling_tools.execute
    coupling_tools.get_value
    coupling_tools.get_line_col
    coupling_tools.get_regex