This file is indexed.

/usr/include/openturns/swig/SquaredExponential_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
%feature("docstring") OT::SquaredExponential
"Squared exponential covariance model.

Available constructors:
    SquaredExponential(*dim=1, theta=0.1*)

    SquaredExponential(*scale*)

    SquaredExponential(*scale, sigma*)

Parameters
----------
dim : int, :math:`dim \\\\geq 0`
    Input dimension.
theta : float
    Coefficient :math:`\\\\theta` of the covariance function.
scale : sequence of floats
    Scale coefficients :math:`\\\\theta`.
    The spatial dimension is the size of vector.
sigma : sequence of floats
    Amplitude coefficients :math:`\\\\sigma`.
    Should be of size 1

Notes
-----
The covariance function of input dimension *dim* is:

.. math::

    C(s, t) = \\\\sigma^2 e^{-\\\\frac{1}{2} ||\\\\frac{s-t}{\\\\theta}||_{2}^{2}}

where the division is vectorial, :math:`\\\\sigma` is the amplitude (default value is 1.0). Note that the model is unidimensional.

See Also
--------
CovarianceModel, AbsoluteExponential, GeneralizedExponential, MaternModel

Examples
--------
>>> import openturns as ot
>>> covarianceModel = ot.SquaredExponential(2)
>>> t = [0.1, 0.3]
>>> s = [0.2, 0.4]
>>> print(covarianceModel(s, t))
[[ 0.9999 ]]
>>> tau = [0.1, 0.3]
>>> print(covarianceModel(tau))
[[ 0.9995 ]]"