/usr/include/openturns/swig/ExponentialCauchy_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | %feature("docstring") OT::ExponentialCauchy
"Absolute exponential covariance model.
Available constructors:
ExponentialCauchy(*sigma, theta*)
Parameters
----------
sigma : sequence of floats
Amplitude coefficients :math:`\\\\sigma`.
Should be of size 1
theta : sequence of floats
Scale coefficients.
The spatial dimension is the size of vector.
Notes
-----
The second order model instanciate both a :class:`openturns.AbsoluteExponential` as covariance function and :class:`openturns.CauchyModel` as
spectral model.
Examples
--------
>>> import openturns as ot
>>> model = ot.ExponentialCauchy([1.0], [10.0, 10.0])
>>> t = [0.1, 0.3]
>>> s = [0.2, 0.4]
>>> print(model.computeCovariance(s, t))
[[ 0.980199 ]]
>>> tau = [0.1, 0.3]
>>> print(model.computeCovariance(tau))
[[ 0.960789 ]]
>>> f = 0.3
>>> print(model.computeSpectralDensity(f))
[[ (0.00315075,0) ]]
>>> f = 10
>>> print(model.computeSpectralDensity(f))
[[ (2.56648e-09,0) ]]"
// ---------------------------------------------------------------------
%define OT_ExponentialCauchy_getAmplitude_doc
"Get the amplitude parameter of the the second order model.
Returns
-------
amplitude : :class:`~openturns.NumericalPoint`
The used amplitude parameter."
%enddef
%feature("docstring") OT::ExponentialCauchy::getAmplitude
OT_ExponentialCauchy_getAmplitude_doc
// ---------------------------------------------------------------------
%define OT_ExponentialCauchy_getScale_doc
"Get the scale parameter of the second order model.
Returns
-------
scale : :class:`~openturns.NumericalPoint`
The used scale parameter."
%enddef
%feature("docstring") OT::ExponentialCauchy::getScale
OT_ExponentialCauchy_getScale_doc
// ---------------------------------------------------------------------
|