CDPL.Util.UIArray Class Reference

An array of unsigned integers. More...

Inheritance diagram for CDPL.Util.UIArray:

Public Member Functions
None	__init__ ()
	Creates an empty array.
None	__init__ (UIArray array)
	Initializes a copy of the UIArray instance array. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
int	getSize ()
	Returns the number of elements stored in the array. More...
bool	isEmpty ()
	Tells whether the array is empty (getSize() == 0). More...
None	resize (int num_elem, int value)
	Inserts or erases elements at the end so that the size becomes num_elem. More...
None	reserve (int num_elem)
	Preallocates memory for (at least) num_elem elements. More...
int	getCapacity ()
	Returns the number of elements for which memory has been allocated. More...
None	clear ()
	Erases all elements.
UIArray	assign (UIArray array)
	Replaces the current state of self with a copy of the state of the UIArray instance array. More...
None	assign (int num_elem, int value)
	This function fills the array with num_elem copies of the given value. More...
None	addElement (int value)
	Inserts a new element at the end of the array. More...
None	addElements (UIArray values)
None	insertElement (int idx, int value)
	Inserts a new element before the location specified by the index idx. More...
None	insertElements (int idx, int num_elem, int value)
	Inserts num_elem copies of value before the location specified by the index idx. More...
None	insertElements (int index, UIArray values)
None	popLastElement ()
	Removes the last element of the array. More...
None	removeElement (int idx)
	Removes the element at the position specified by the index idx. More...
None	removeElements (int begin_idx, int end_idx)
int	getFirstElement ()
	Returns a reference to the first element of the array. More...
int	getLastElement ()
	Returns a reference to the last element of the array. More...
int	getElement (int idx)
	Returns a reference to the element at index idx. More...
None	setElement (int idx, int value)
	Assigns a new value to the element specified by the index idx. More...
None	__delitem__ (int idx)
int	__getitem__ (int idx)
int	__len__ ()
None	__setitem__ (int index, int value)
bool	__eq__ (UIArray array)
	Returns the result of the comparison operation self == array. More...
bool	__ne__ (UIArray array)
	Returns the result of the comparison operation self != array. More...
bool	__le__ (UIArray array)
	Returns the result of the comparison operation self <= array. More...
bool	__ge__ (UIArray array)
	Returns the result of the comparison operation self >= array. More...
bool	__lt__ (UIArray array)
	Returns the result of the comparison operation self < array. More...
bool	__gt__ (UIArray array)
	Returns the result of the comparison operation self > array. More...

Properties
	objectID = property(getObjectID)
	size = property(getSize)

Detailed Description

An array of unsigned integers.

Constructor & Destructor Documentation

__init__()

None CDPL.Util.UIArray.__init__

(

UIArray

array

)

Initializes a copy of the UIArray instance array.

Parameters

array

The UIArray instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Util.UIArray.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python UIArray instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two UIArray instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

getSize()

int CDPL.Util.UIArray.getSize

(

)

Returns the number of elements stored in the array.

Returns

The size of the array.

isEmpty()

bool CDPL.Util.UIArray.isEmpty

(

)

Tells whether the array is empty (getSize() == 0).

Returns

True if the array is empty, False otherwise.

resize()

None CDPL.Util.UIArray.resize	(	int	num_elem,
		int	value
	)

Inserts or erases elements at the end so that the size becomes num_elem.

Parameters

num_elem	The new size.
value	The value for newly inserted elements.

reserve()

None CDPL.Util.UIArray.reserve

(

int

num_elem

)

Preallocates memory for (at least) num_elem elements.

If num_elem is less than or equal to the current capacity, this call has no effect. Otherwise, it is a request for allocation of additional memory. If the request is successful, then the capacity is greater than or equal to num_elem. Otherwise, the capacity is unchanged. In either case, the number of elements will not change.

Parameters

num_elem

The number of elements to reserve memory for.

See also

getCapacity()

getCapacity()

int CDPL.Util.UIArray.getCapacity

(

)

Returns the number of elements for which memory has been allocated.

The capacity is always greater than or equal to the number of currently stored elements.

Returns

The current capacity.

assign() [1/2]

UIArray CDPL.Util.UIArray.assign

(

UIArray

array

)

Replaces the current state of self with a copy of the state of the UIArray instance array.

Parameters

array

The UIArray instance to copy.

Returns

self

assign() [2/2]

None CDPL.Util.UIArray.assign	(	int	num_elem,
		int	value
	)

This function fills the array with num_elem copies of the given value.

Note that the assignment completely changes the array and the new size is the same as the number of elements assigned. Old data will be lost.

Parameters

num_elem	The number of elements to be assigned.
value	The value to be assigned.

addElement()

None CDPL.Util.UIArray.addElement

(

int

value

)

Inserts a new element at the end of the array.

Parameters

value

The value of the new element.

addElements()

None CDPL.Util.UIArray.addElements

(

UIArray

values

)

Parameters

values

insertElement()

None CDPL.Util.UIArray.insertElement	(	int	idx,
		int	value
	)

Inserts a new element before the location specified by the index idx.

Parameters

idx	The location where to insert the new element.
value	The value of the element to insert.

Exceptions

Base.IndexError

if the array is empty or idx is not in the range [0, getSize()].

insertElements() [1/2]

None CDPL.Util.UIArray.insertElements	(	int	idx,
		int	num_elem,
		int	value
	)

Inserts num_elem copies of value before the location specified by the index idx.

Parameters

idx	The location where to insert the new elements.
num_elem	The number of elements to insert.
value	The value of the elements to insert.

Exceptions

Base.IndexError

if idx is not in the range [0, getSize()].

insertElements() [2/2]

None CDPL.Util.UIArray.insertElements	(	int	index,
		UIArray	values
	)

Parameters

index
values

popLastElement()

None CDPL.Util.UIArray.popLastElement

(

)

Removes the last element of the array.

Exceptions

Base.OperationFailed

if the array is empty.

removeElement()

None CDPL.Util.UIArray.removeElement

(

int

idx

)

Removes the element at the position specified by the index idx.

Parameters

idx	The zero-based index of the element to remove.

Exceptions

Base.IndexError

if the array is empty or idx is not in the range [0, getSize() - 1].

removeElements()

None CDPL.Util.UIArray.removeElements	(	int	begin_idx,
		int	end_idx
	)

Parameters

begin_idx
end_idx

getFirstElement()

int CDPL.Util.UIArray.getFirstElement

(

)

Returns a reference to the first element of the array.

Returns

A reference to the first element.

Exceptions

Base.OperationFailed

if the array is empty.

getLastElement()

int CDPL.Util.UIArray.getLastElement

(

)

Returns a reference to the last element of the array.

Returns

A reference to the last element.

Exceptions

Base.OperationFailed

if the array is empty.

getElement()

int CDPL.Util.UIArray.getElement

(

int

idx

)

Returns a reference to the element at index idx.

The method is equivalent to operator[](std::size_t).

Parameters

idx	The zero-based index of the element.

Returns

A reference to the element.

Exceptions

Base.IndexError

if the array is empty or idx is not in the range [0, getSize() - 1].

setElement()

None CDPL.Util.UIArray.setElement	(	int	idx,
		int	value
	)

Assigns a new value to the element specified by the index idx.

Parameters

idx	The zero-based index of the element for which to assign a new value.
value	The new value of the element after assignment.

Exceptions

Base.IndexError

if the array is empty or idx is not in the range [0, getSize() - 1].

__delitem__()

None CDPL.Util.UIArray.__delitem__

(

int

idx

)

Parameters

idx

__getitem__()

int CDPL.Util.UIArray.__getitem__

(

int

idx

)

Parameters

idx

Returns

__len__()

int CDPL.Util.UIArray.__len__

(

)

Returns

__setitem__()

None CDPL.Util.UIArray.__setitem__	(	int	index,
		int	value
	)

Parameters

index
value

__eq__()

bool CDPL.Util.UIArray.__eq__

(

UIArray

array

)

Returns the result of the comparison operation self == array.

Parameters

array

The UIArray instance to be compared with.

Returns

The result of the comparison operation.

__ne__()

bool CDPL.Util.UIArray.__ne__

(

UIArray

array

)

Returns the result of the comparison operation self != array.

Parameters

array

The UIArray instance to be compared with.

Returns

The result of the comparison operation.

__le__()

bool CDPL.Util.UIArray.__le__

(

UIArray

array

)

Returns the result of the comparison operation self <= array.

Parameters

array

The UIArray instance to be compared with.

Returns

The result of the comparison operation.

__ge__()

bool CDPL.Util.UIArray.__ge__

(

UIArray

array

)

Returns the result of the comparison operation self >= array.

Parameters

array

The UIArray instance to be compared with.

Returns

The result of the comparison operation.

__lt__()

bool CDPL.Util.UIArray.__lt__

(

UIArray

array

)

Returns the result of the comparison operation self < array.

Parameters

array

The UIArray instance to be compared with.

Returns

The result of the comparison operation.

__gt__()

bool CDPL.Util.UIArray.__gt__

(

UIArray

array

)

Returns the result of the comparison operation self > array.

Parameters

array

The UIArray instance to be compared with.

Returns

The result of the comparison operation.