/usr/include/openturns/swig/Indices_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 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 | %feature("docstring") OT::Indices
"Collection of unsigned integers.
Available constructors:
Indices(*size=0, value=0*)
Indices(*sequence*)
Parameters
----------
size : int, :math:`size \\\\geq 0`
Size of the collection.
value : positive int
Value set to the *size* elements.
sequence : sequence of int
Components of the vector.
Examples
--------
>>> import openturns as ot
Use the first constructor:
>>> ot.Indices(3)
[0,0,0]
>>> ot.Indices(3, 4)
[4,4,4]
Use the second constructor:
>>> vector = ot.Indices([100, 30, 70])
>>> vector
[100,30,70]
Use some functionalities:
>>> vector[1] = 20
>>> vector
[100,20,70]
>>> vector.add(50)
>>> vector
[100,20,70,50]"
// ---------------------------------------------------------------------
%feature("docstring") OT::Indices::check
"Check that no value is repeated and no value exceed the given bound.
Parameters
----------
bound : positive int
A bound.
Returns
-------
check : bool
*True* if no value is repeated and no value exceed the given bound."
// ---------------------------------------------------------------------
%feature("docstring") OT::Indices::fill
"Fill the indices with a linear progression.
Starting from the start value *initialValue* by step *stepSize*.
Parameters
----------
initialValue : positive int
Initial value. By default it is equal to 0.
stepSize : positive int
Step size. By default it is equal to 1.
Examples
--------
>>> import openturns as ot
>>> indices = ot.Indices(3)
>>> indices.fill()
>>> print(indices)
[0,1,2]
>>> indices = ot.Indices(3)
>>> indices.fill(2, 4)
>>> print(indices)
[2,6,10]"
// ---------------------------------------------------------------------
%feature("docstring") OT::Indices::isIncreasing
"Check if the indices are increasing.
Returns
-------
isIncreasing : bool
*True* if the indices are increasing.
Examples
--------
>>> import openturns as ot
>>> indices = ot.Indices(3)
>>> indices.fill()
>>> indices.isIncreasing()
True"
|