This file is indexed.

/usr/include/openturns/swig/PolygonArray_doc.i is in libopenturns-dev 1.9-5.

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
67
68
%feature("docstring") OT::PolygonArray
"Polygon array.

Available constructors:
    PolygonArray(*legend=' '*)

    PolygonArray(*polygons, legend=' '*)

    PolygonArray(*coordinates, verticesNumber, palette, legend=' '*)

Parameters
----------
legend : str
    Legend of the Cloud.
polygons : sequence of :class:`~openturns.Polygon`
    Sequence of polygons.
coordinates : 2-d sequence of float
    The list of coordinates.
verticesNumber : int
    Number of vertices.
palette : sequence of str
    Polygon colors.

Examples
--------
>>> import openturns as ot
>>> ot.RandomGenerator.SetSeed(0)
>>> generator = ot.Normal(2)
>>> size = 5
>>> array = []
>>> palette = ot.Drawable.BuildDefaultPalette(size)
>>> for i in range(size):
...     vertices = generator.getSample(3)
...     array.append(ot.Polygon(vertices, palette[i], palette[size - i - 1]))
>>> graph = ot.Graph('An array of polygons', 'x', 'y', True, '')
>>> graph.add(ot.PolygonArray(array))"

// ---------------------------------------------------------------------

%feature("docstring") OT::PolygonArray::setCoordinatesAndVerticesNumber
"Accessor to the coordinates of polygons.

Parameters
----------
coordinates : 2-d sequence of float
    The list of coordinates.
verticesNumber : int
    number of vertices."

// ---------------------------------------------------------------------

%feature("docstring") OT::PolygonArray::getCoordinates
"Accessor to the color of each polygon.

Returns
-------
coordinates : :class:`~openturns.Sample`
    Polygon coordinates."

// ---------------------------------------------------------------------

%feature("docstring") OT::PolygonArray::getVerticesNumber
"Accessor to the number of vertices.

Returns
-------
verticesNumber : int
    Number of vertices."