Indices

class Indices(*args)

Collection of unsigned integers.

Available constructors:

Indices(size=0, value=0)

Indices(sequence)

Parameters:

size : int, 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]

Methods

add(*args) Append a component (in-place).
at(*args) Access to an element of the collection.
check(bound) Check that no value is repeated and no value exceed the given bound.
clear() Reset the collection to zero dimension.
fill([initialValue, stepSize]) Fill the indices with a linear progression.
getClassName() Accessor to the object’s name.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getShadowedId() Accessor to the object’s shadowed id.
getSize() Get the collection’s dimension (or size).
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
isEmpty() Tell if the collection is empty.
isIncreasing() Check if the indices are increasing.
resize(newSize) Change the size of the collection.
setName(name) Accessor to the object’s name.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)
add(*args)

Append a component (in-place).

Parameters:

value : type depends on the type of the collection.

The component to append.

Examples

>>> import openturns as ot
>>> x = ot.NumericalPoint(2)
>>> x.add(1.)
>>> print(x)
[0,0,1]
at(*args)

Access to an element of the collection.

Parameters:

index : positive int

Position of the element to access.

Returns:

element : type depends on the type of the collection

Element of the collection at the position index.

check(bound)

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.

clear()

Reset the collection to zero dimension.

Examples

>>> import openturns as ot
>>> x = ot.NumericalPoint(2)
>>> x.clear()
>>> x
class=NumericalPoint name=Unnamed dimension=0 values=[]
fill(initialValue=0, stepSize=1)

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]
getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getSize()

Get the collection’s dimension (or size).

Returns:

n : int

The number of components in the collection.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

isEmpty()

Tell if the collection is empty.

Returns:

isEmpty : bool

True if there is no element in the collection.

Examples

>>> import openturns as ot
>>> x = ot.NumericalPoint(2)
>>> x.isEmpty()
False
>>> x.clear()
>>> x.isEmpty()
True
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
resize(newSize)

Change the size of the collection.

Parameters:

newSize : positive int

New size of the collection.

Notes

If the new size is smaller than the older one, the last elements are thrown away, else the new elements are set to the default value of the element type.

Examples

>>> import openturns as ot
>>> x = ot.NumericalPoint(2, 4)
>>> print(x)
[4,4]
>>> x.resize(1)
>>> print(x)
[4]
>>> x.resize(4)
>>> print(x)
[4,0,0,0]
setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.