File: functions.rst

package info (click to toggle)
openturns 1.24-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 66,204 kB
  • sloc: cpp: 256,662; python: 63,381; ansic: 4,414; javascript: 406; sh: 180; xml: 164; yacc: 123; makefile: 98; lex: 55
file content (319 lines) | stat: -rw-r--r-- 6,557 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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
=========
Functions
=========

.. currentmodule:: openturns

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

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

    Function
    FunctionImplementation
    SymbolicFunction
    TranslationFunction

    :template: classWithPlot.rst_t
    LinearFunction
    QuadraticFunction

    :template: class.rst_t
    DatabaseFunction
    PythonFunction
    OpenTURNSPythonFunction
    MemoizeFunction

Algebra of functions
====================

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

    AggregatedFunction

    :template: classWithPlot.rst_t
    ComposedFunction

    :template: class.rst_t
    DistanceToDomainFunction
    DualLinearCombinationFunction
    IdentityFunction

    :template: classWithPlot.rst_t
    IndicatorFunction
    LinearCombinationFunction

    :template: class.rst_t
    ParametricFunction

    :template: classWithPlot.rst_t
    ProductFunction

    :template: class.rst_t
    PointToPointEvaluation
    FieldToFieldConnection
    FieldToPointConnection
    PointToFieldConnection
    PointToPointConnection

Field and mixed functions
=========================

Refer to :ref:`field_function`.

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

    FieldFunction
    FieldToPointFunction
    PointToFieldFunction
    ParametricPointToFieldFunction
    VertexValuePointToFieldFunction
    ValueFunction
    VertexValueFunction
    PythonFieldFunction
    PythonFieldToPointFunction
    PythonPointToFieldFunction
    OpenTURNSPythonFieldFunction
    OpenTURNSPythonFieldToPointFunction
    OpenTURNSPythonPointToFieldFunction

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

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

    Basis
    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

    Evaluation
    EvaluationImplementation
    AggregatedEvaluation
    ComposedEvaluation
    DatabaseEvaluation
    DistanceToDomainEvaluation
    DualLinearCombinationEvaluation
    IndicatorEvaluation
    LinearCombinationEvaluation
    LinearEvaluation
    MarginalEvaluation
    MemoizeEvaluation
    NoEvaluation
    ParametricEvaluation
    PiecewiseHermiteEvaluation
    PiecewiseLinearEvaluation
    P1LagrangeInterpolation

    :template: classWithPlot.rst_t
    P1LagrangeEvaluation

    :template: class.rst_t
    ProductEvaluation
    ProductPolynomialEvaluation
    QuadraticEvaluation
    SymbolicEvaluation
    TranslationEvaluation

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

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

    GradientImplementation
    SymbolicGradient
    ComposedGradient
    ConstantGradient
    DualLinearCombinationGradient
    LinearCombinationGradient
    LinearGradient
    NoGradient
    ParametricGradient
    ProductGradient
    MarginalGradient

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

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

    HessianImplementation
    SymbolicHessian
    ComposedHessian
    ConstantHessian
    DualLinearCombinationHessian
    LinearCombinationHessian
    NoHessian
    NullHessian
    ParametricHessian
    ProductHessian
    MarginalHessian

Differential equation solvers
=============================

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

    ODESolver

    :template: ODESolver.rst_t
    RungeKutta
    Fehlberg

Special functions
=================

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

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

    SpecFunc.AccurateSum
    SpecFunc.BesselI0
    SpecFunc.BesselI1
    SpecFunc.BesselK
    SpecFunc.BesselKDerivative
    SpecFunc.Beta
    SpecFunc.BitCount
    SpecFunc.Clip01
    SpecFunc.Dawson
    SpecFunc.Debye
    SpecFunc.DeltaLogBesselI10
    SpecFunc.DiGamma
    SpecFunc.DiGammaInv
    SpecFunc.DiLog
    SpecFunc.Ei
    SpecFunc.Erf
    SpecFunc.ErfC
    SpecFunc.ErfCX
    SpecFunc.ErfI
    SpecFunc.ErfInverse
    SpecFunc.Expm1
    SpecFunc.Factorial
    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.IPow
    SpecFunc.IRoot
    SpecFunc.IsNormal
    SpecFunc.LambertW
    SpecFunc.Log1MExp
    SpecFunc.Log1p
    SpecFunc.Log2
    SpecFunc.LogBesselI0
    SpecFunc.LogBesselI1
    SpecFunc.LogBesselK
    SpecFunc.LogBeta
    SpecFunc.LogFactorial
    SpecFunc.LogGamma
    SpecFunc.LogGamma1p
    SpecFunc.NextPowerOfTwo
    SpecFunc.Psi
    SpecFunc.RegularizedIncompleteBeta
    SpecFunc.RegularizedIncompleteBetaInverse
    SpecFunc.RegularizedIncompleteGamma
    SpecFunc.RegularizedIncompleteGammaInverse
    SpecFunc.Stirlerr
    SpecFunc.TriGamma

.. _coupling_tools:


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.

.. 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
    coupling_tools.get

1-D functions
=============

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

    UniVariateFunction

.. _testing_module:

Testing module
==============
This module is dedicated to the development in the library.

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

    testing.assert_almost_equal

    :template: class.rst_t

    testing.DistributionValidation