1%feature("docstring") OT::Indices
2"Collection of unsigned integers.
3
4Available constructors:
5    Indices(*size=0, value=0*)
6
7    Indices(*sequence*)
8
9Parameters
10----------
11size : int, :math:`size \geq 0`
12    Size of the collection.
13value : positive int
14    Value set to the *size* elements.
15sequence : sequence of int
16    Components of the vector.
17
18Examples
19--------
20>>> import openturns as ot
21
22Use the first constructor:
23
24>>> ot.Indices(3)
25[0,0,0]
26>>> ot.Indices(3, 4)
27[4,4,4]
28
29Use the second constructor:
30
31>>> vector = ot.Indices([100, 30, 70])
32>>> vector
33[100,30,70]
34
35Use some functionalities:
36
37>>> vector[1] = 20
38>>> vector
39[100,20,70]
40>>> vector.add(50)
41>>> vector
42[100,20,70,50]"
43
44// ---------------------------------------------------------------------
45
46%feature("docstring") OT::Indices::check
47"Check that no value is repeated and no value exceeds the given bound.
48
49Parameters
50----------
51bound : positive int
52    The bound value.
53
54Returns
55-------
56check : bool
57    *True* if no value is repeated and all values are < bound."
58
59// ---------------------------------------------------------------------
60
61%feature("docstring") OT::Indices::complement
62"Build the complement of the current indices wrt :math:`\{0,\dots,n-1\}`.
63
64Parameters
65----------
66bound : positive int
67    The value of :math:`n`.
68
69Returns
70-------
71complement : :class:`~openturns.Indices`
72    The increasing collection of integers in :math:`\{0,\dots,n-1\}` not in the current indices.
73
74Examples
75--------
76>>> import openturns as ot
77>>> indices = ot.Indices([1, 3, 4])
78>>> print(indices.complement(7))
79[0,2,5,6]"
80
81// ---------------------------------------------------------------------
82
83%feature("docstring") OT::Indices::fill
84"Fill the indices with a linear progression.
85
86Starting from the start value *initialValue* by step *stepSize*.
87
88Parameters
89----------
90initialValue : positive int
91    Initial value. By default it is equal to 0.
92stepSize : positive int
93    Step size. By default it is equal to 1.
94
95Examples
96--------
97>>> import openturns as ot
98>>> indices = ot.Indices(3)
99>>> indices.fill()
100>>> print(indices)
101[0,1,2]
102>>> indices = ot.Indices(3)
103>>> indices.fill(2, 4)
104>>> print(indices)
105[2,6,10]"
106
107// ---------------------------------------------------------------------
108
109%feature("docstring") OT::Indices::isIncreasing
110"Check if the indices are increasing.
111
112Returns
113-------
114isIncreasing : bool
115    *True* if the indices are increasing.
116
117Examples
118--------
119>>> import openturns as ot
120>>> indices = ot.Indices(3)
121>>> indices.fill()
122>>> indices.isIncreasing()
123True"
124