RArray< TUint > Class Template Reference

#include <e32cmn.h>

template <>

class RArray< TUint > : private RPointerArrayBase

Inherits from

RArray< TUint >
- RPointerArrayBase

Public Member Functions
	RArray()
	RArray(TInt)
	RArray(TInt, TInt)
	RArray(TUint *, TInt)
TInt	Append(TUint)
void	AppendL(TUint)
TArray< TUint >	Array()
void	Close()
void	Compress()
TInt	Count()
TInt	Find(TUint)
TInt	FindInOrder(TUint)
TInt	FindInOrder(TUint, TInt &)
TInt	FindInOrderL(TUint)
void	FindInOrderL(TUint, TInt &)
TInt	FindL(TUint)
TInt	FindReverse(TUint)
TInt	FindReverseL(TUint)
void	GranularCompress()
TInt	Insert(TUint, TInt)
TInt	InsertInOrder(TUint)
TInt	InsertInOrderAllowRepeats(TUint)
void	InsertInOrderAllowRepeatsL(TUint)
void	InsertInOrderL(TUint)
void	InsertL(TUint, TInt)
void	Remove(TInt)
TInt	Reserve(TInt)
void	ReserveL(TInt)
void	Reset()
void	Sort()
TInt	SpecificFindInOrder(TUint, TInt)
TInt	SpecificFindInOrder(TUint, TInt &, TInt)
TInt	SpecificFindInOrderL(TUint, TInt)
void	SpecificFindInOrderL(TUint, TInt &, TInt)
const TUint &	operator[](TInt)
TUint &	operator[](TInt)

Inherited Functions
	RPointerArrayBase::Append(const TAny *)
	RPointerArrayBase::At(TInt)const
	RPointerArrayBase::BinarySearch(const TAny *,TInt &,TGeneralLinearOrder)const
	RPointerArrayBase::BinarySearch(const TAny *,TInt &,TGeneralLinearOrder,TInt)const
	RPointerArrayBase::BinarySearchSigned(TInt,TInt &)const
	RPointerArrayBase::BinarySearchSigned(TInt,TInt &,TInt)const
	RPointerArrayBase::BinarySearchUnsigned(TUint,TInt &)const
	RPointerArrayBase::BinarySearchUnsigned(TUint,TInt &,TInt)const
	RPointerArrayBase::DoReserve(TInt)
	RPointerArrayBase::Entries()
	RPointerArrayBase::Find(const TAny *)const
	RPointerArrayBase::Find(const TAny *,TGeneralIdentityRelation)const
	RPointerArrayBase::FindIsq(const TAny *,TGeneralLinearOrder)const
	RPointerArrayBase::FindIsq(const TAny *,TGeneralLinearOrder,TInt)const
	RPointerArrayBase::FindIsqSigned(TInt)const
	RPointerArrayBase::FindIsqSigned(TInt,TInt)const
	RPointerArrayBase::FindIsqUnsigned(TUint)const
	RPointerArrayBase::FindIsqUnsigned(TUint,TInt)const
	RPointerArrayBase::FindReverse(const TAny *)const
	RPointerArrayBase::FindReverse(const TAny *,TGeneralIdentityRelation)const
	RPointerArrayBase::GetCount(const CBase *)
	RPointerArrayBase::GetElementPtr(const CBase *,TInt)
	RPointerArrayBase::HeapSort(TGeneralLinearOrder)
	RPointerArrayBase::HeapSortSigned()
	RPointerArrayBase::HeapSortUnsigned()
	RPointerArrayBase::Insert(const TAny *,TInt)
	RPointerArrayBase::InsertIsq(const TAny *,TGeneralLinearOrder,TBool)
	RPointerArrayBase::InsertIsqSigned(TInt,TBool)
	RPointerArrayBase::InsertIsqUnsigned(TUint,TBool)
	RPointerArrayBase::RPointerArrayBase()
	RPointerArrayBase::RPointerArrayBase(TAny **,TInt)
	RPointerArrayBase::RPointerArrayBase(TInt)
	RPointerArrayBase::RPointerArrayBase(TInt,TInt)
	RPointerArrayBase::ZeroCount()

Detailed Description

Array of unsigned integers.

The array is a simple and efficient specialized array of unsigned integers offering standard array behaviour.

The derivation from RPointerArrayBase is private.

Constructor & Destructor Documentation

RArray ( )

RArray

(

)

[inline]

Default C++ constructor.

This constructs an array object for an array of unsigned integers with default granularity.

The default granularity of the array is 8.

RArray ( TInt )

RArray

(

TInt

aGranularity

)

[inline, explicit]

Constructs an array object for an array of unsigned integers with the specified granularity.

Parameters
aGranularity	The granularity of the array.

Panic Codes
USER	127, if aGranularity is not positive or is greater than or equal to 0x10000000.

RArray ( TInt, TInt )

RArray	(	TInt	aMinGrowBy,
		TInt	aFactor
	)	[inline]

C++ constructor with minimum growth step and exponential growth factor.

This constructs an array object for an array of unsigned integers with the specified minimum growth step and exponential growth factor.

Parameters
aMinGrowBy	The minimum growth step of the array. Must be between 1 and 65535 inclusive.
aFactor	The factor by which the array grows, multiplied by 256. For example 512 specifies a factor of 2. Must be between 257 and 32767 inclusive.

Panic Codes
USER	192, if aMinGrowBy<=0 or aMinGrowBy>65535.
USER	193, if aFactor<=257 or aFactor>32767.

RArray ( TUint *, TInt )

RArray	(	TUint *	aEntries,
		TInt	aCount
	)	[inline]

C++ constructor with a pointer to the first array entry in a pre-existing array, and the number of entries in that array.

This constructor takes a pointer to a pre-existing set of entries of type TUint objects. Ownership of the set of entries does not transfer to this RArray object.

The purpose of constructing an array in this way is to allow sorting and finding operations to be done without further allocation of memory.

Parameters
aEntries	A pointer to the first entry of type class TUint in the set of entries belonging to the existing array.
aCount	The number of entries in the existing array.

Member Function Documentation

Append ( TUint )

TInt

Append

(

TUint

anEntry

)

[inline]

Appends an unsigned integer onto the array.

Parameters
anEntry	The unsigned integer to be appended.

Return Value: KErrNone, if the insertion is successful, otherwise one of the system wide error codes.

AppendL ( TUint )

void

AppendL

(

TUint

anEntry

)

[inline]

Appends an unsigned integer onto the array.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be appended.

Array ( )

TArray< TUint >

Array

(

)

const [inline]

Constructs and returns a generic array.

Close ( )

void

(

)

[inline]

Reimplemented from RPointerArrayBase::Close()

Closes the array and frees all memory allocated to the array.

The function must be called before this array object goes out of scope.

Compress ( )

void

Compress

(

)

[inline]

Reimplemented from RPointerArrayBase::Compress()

Compresses the array down to a minimum.

After a call to this function, the memory allocated to the array is just sufficient for its entries. Subsequently adding a new unsigned integer to the array always results in a re-allocation of memory.

Count ( )

TInt

Count

(

)

const [inline]

Reimplemented from RPointerArrayBase::Count()const

Gets the number of unsigned integers in the array.

Return Value: The number of unsigned integers in the array.

Find ( TUint )

TInt

Find

(

TUint

anEntry

)

const [inline]

Finds the first unsigned integer in the array which matches the specified value, using a sequential search.

The find operation always starts at the low index end of the array. There is no assumption about the order of entries in the array.

Parameters
anEntry	The unsigned integer to be found.

Return Value: The index of the first matching unsigned integer within the array. KErrNotFound, if no matching entry can be found.

FindInOrder ( TUint )

TInt

FindInOrder

(

TUint

anEntry

)

const [inline]

Finds the unsigned integer in the array which matches the specified value, using a binary search technique.

The functions assume that existing entries within the array are in unsigned integer order.

Parameters
anEntry	The unsigned integer to be found.

Return Value: This is either: the index of the matching unsigned integer within the array; KErrNotFound, if no suitable entry can be found.

FindInOrder ( TUint, TInt & )

TInt	FindInOrder	(	TUint	anEntry,
			TInt &	anIndex
		)	const [inline]

Finds the unsigned integer in the array which matches the specified value, using a binary search technique.

If the index cannot be found, the function returns the index of the last unsigned integer within the array which logically precedes anEntry.

The functions assume that existing entries within the array are in unsigned integer order.

Parameters

anEntry

The unsigned integer to be found.

anIndex

A TInt supplied by the caller. On return, contains an index value. If the function returns KErrNone, this is the index of the matching unsigned integer within the array. If the function returns KErrNotFound, this is the index of the first unsigned integer within the array that is bigger than the unsigned integer being searched for - if no unsigned integers within the array are bigger, then the index value is the same as the total number of unsigned integers within the array.

Return Value: KErrNone, if a matching unsigned integer is found. KErrNotFound, if no suitable entry can be found.

FindInOrderL ( TUint )

TInt

FindInOrderL

(

TUint

anEntry

)

const [inline]

Finds the unsigned integer in the array which matches the specified value, using a binary search technique.

The functions assume that existing entries within the array are in unsigned integer order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be found.

Return Value: The index of the matching unsigned integer within the array;

Leave Codes
KErrNotFound,	if no matching entry can be found.

FindInOrderL ( TUint, TInt & )

void	FindInOrderL	(	TUint	anEntry,
			TInt &	anIndex
		)	const [inline]

Finds the unsigned integer in the array which matches the specified value, using a binary search technique.

If the index cannot be found, the function returns the index of the last unsigned integer within the array which logically precedes anEntry. The functions assume that existing entries within the array are in unsigned integer order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters

anEntry

The unsigned integer to be found.

anIndex

A TInt supplied by the caller. On return, contains an index value of the matching unsigned integer within the array. If the function leaves with KErrNotFound, this is the index of the first unsigned integer within the array that is bigger than the unsigned integer being searched for - if no unsigned integers within the array are bigger, then the index value is the same as the total number of unsigned integers within the array.

Leave Codes
KErrNotFound,	if no matching entry can be found.

FindL ( TUint )

TInt

FindL

(

TUint

anEntry

)

const [inline]

Finds the first unsigned integer in the array which matches the specified value, using a sequential search.

The find operation always starts at the low index end of the array. There is no assumption about the order of entries in the array.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be found.

Return Value: The index of the first matching unsigned integer within the array.

Leave Codes
KErrNotFound,	if no matching entry can be found.

FindReverse ( TUint )

TInt

FindReverse

(

TUint

anEntry

)

const [inline]

Finds the last unsigned integer in the array which matches the specified value, using a sequential search.

The find operation always starts at the high index end of the array. There is no assumption about the order of entries in the array.

Parameters
anEntry	The unsigned integer to be found.

Return Value: The index of the last matching unsigned integer within the array. KErrNotFound, if no matching entry can be found.

FindReverseL ( TUint )

TInt

FindReverseL

(

TUint

anEntry

)

const [inline]

Finds the last unsigned integer in the array which matches the specified value, using a sequential search.

The find operation always starts at the high index end of the array. There is no assumption about the order of entries in the array.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be found.

Return Value: The index of the last matching unsigned integer within the array.

Leave Codes
KErrNotFound,	if no matching entry can be found.

GranularCompress ( )

void

GranularCompress

(

)

[inline]

Reimplemented from RPointerArrayBase::GranularCompress()

Compresses the array down to a granular boundary.

After a call to this function, the memory allocated to the array is sufficient for its contained entries. Adding new unsigned integers to the array does not result in a re-allocation of memory until the total number of entries reaches a multiple of the granularity.

Insert ( TUint, TInt )

TInt	Insert	(	TUint	anEntry,
			TInt	aPos
		)	[inline]

Inserts an unsigned integer into the array at the specified position.

Parameters
anEntry	The unsigned integer to be inserted.
aPos	The position within the array where the unsigned integer is to be inserted. The position is relative to zero, i.e. zero implies that an entry is inserted at the beginning of the array.

Return Value: KErrNone, if the insertion is successful, otherwise one of the system wide error codes.

Panic Codes
USER	131, if aPos is negative, or is greater than the number of entries currently in the array.

InsertInOrder ( TUint )

TInt

InsertInOrder

(

TUint

anEntry

)

[inline]

Inserts an unsigned integer into the array in unsigned integer order.

No duplicate entries are permitted. The array remains unchanged following an attempt to insert a duplicate entry.

The function assumes that existing entries within the array are in unsigned integer order.

Parameters
anEntry	The unsigned integer to be inserted.

Return Value: KErrNone, if the insertion is successful; KErrAlreadyExists, if an attempt is being made to insert a duplicate entry; otherwise one of the other system wide error codes.

InsertInOrderAllowRepeats ( TUint )

TInt

InsertInOrderAllowRepeats

(

TUint

anEntry

)

[inline]

Inserts an unsigned integer into the array in unsigned integer order, allowing duplicates.

If the new integer is a duplicate of an existing entry in the array, then the new unsigned integer is inserted after the existing one. If more than one duplicate entry already exists in the array, then any new duplicate unsigned integer is inserted after the last one.

The function assumes that existing entries within the array are in unsigned integer order.

Parameters
anEntry	The unsigned integer to be inserted.

Return Value: KErrNone, if the insertion is successful, otherwise one of the system wide error codes.

InsertInOrderAllowRepeatsL ( TUint )

void

InsertInOrderAllowRepeatsL

(

TUint

anEntry

)

[inline]

Inserts an unsigned integer into the array in unsigned integer order, allowing duplicates.

The function assumes that existing entries within the array are in unsigned integer order.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be inserted.

InsertInOrderL ( TUint )

void

InsertInOrderL

(

TUint

anEntry

)

[inline]

Inserts an unsigned integer into the array in unsigned integer order.

No duplicate entries are permitted.

The function assumes that existing entries within the array are in unsigned integer order.

The function leaves with one of the system wide error codes, if the operation fails.

Note that the array remains unchanged following an attempt to insert a duplicate entry.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be inserted.

InsertL ( TUint, TInt )

void	InsertL	(	TUint	anEntry,
			TInt	aPos
		)	[inline]

Inserts an unsigned integer into the array at the specified position.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters
anEntry	The unsigned integer to be inserted.
aPos	The position within the array where the unsigned integer is to be inserted. The position is relative to zero, i.e. zero implies that an entry is inserted at the beginning of the array.

Panic Codes
USER	131, if aPos is negative, or is greater than the number of entries currently in the array.

Remove ( TInt )

void

Remove

(

TInt

anIndex

)

[inline]

Reimplemented from RPointerArrayBase::Remove(TInt)

Removes the unsigned integer at the specified position from the array.

Parameters
anIndex	The position within the array from where the unsigned integer is to be removed. The position is relative to zero, i.e. zero implies that an entry at the beginning of the array is to be removed.

Panic Codes
USER	130, if anIndex is negative, or is greater than the number of entries currently in the array.

Reserve ( TInt )

TInt

Reserve

(

TInt

aCount

)

[inline]

Reserves space for the specified number of elements.

After a call to this function, the memory allocated to the array is sufficient to hold the number of integers specified. Adding new integers to the array does not result in a re-allocation of memory until the the total number of integers exceeds the specified count.

Parameters
aCount	The number of integers for which space should be reserved

Return Value: KErrNone If the operation completed successfully KErrNoMemory If the requested amount of memory could not be allocated

ReserveL ( TInt )

void

ReserveL

(

TInt

aCount

)

[inline]

Reserves space for the specified number of elements.

Parameters
aCount	The number of integers for which space should be reserved

Leave Codes
KErrNoMemory	If the requested amount of memory could not be allocated

Reset ( )

void

Reset

(

)

[inline]

Reimplemented from RPointerArrayBase::Reset()

Empties the array.

It frees all memory allocated to the array and resets the internal state so that it is ready to be reused.

This array object can be allowed to go out of scope after a call to this function.

Sort ( )

void

Sort

(

)

[inline]

Sorts the array entries into unsigned integer order.

SpecificFindInOrder ( TUint, TInt )

TInt	SpecificFindInOrder	(	TUint	anEntry,
			TInt	aMode
		)	const [inline]

Finds the unsigned integer in the array that matches the specified unsigned integer using a binary search technique.

In the case that there is more than one matching element, finds the first, last or any match as specified by the value of aMode.

The function assumes that the array is in unsigned integer order.

See also: TArrayFindMode

Parameters
anEntry	The unsigned integer to be found..
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Return Value: KErrNotFound, if there is no matching element, otherwise the array index of a matching element - what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.

SpecificFindInOrder ( TUint, TInt &, TInt )

TInt	SpecificFindInOrder	(	TUint	anEntry,
			TInt &	anIndex,
			TInt	aMode
		)	const [inline]

Finds the unsigned integer in the array that matches the specified unsigned integer using a binary search technique.

In the case that there is more than one matching element, finds the first, last or any match as specified.

The function assumes that the array is in unsigned integer order.

See also: TArrayFindMode

Parameters
anEntry	The unsigned integer to be found.
anIndex	A TInt type supplied by the caller. On return, it contains an index value depending on whether a match is found and on the value of aMode. If there is no matching element in the array, then this is the index of the first element in the array that is bigger than the element being searched for - if no elements in the array are bigger, then the index value is the same as the total number of elements in the array. If there is a matching element, then what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Return Value: KErrNone, if a matching entry is found; KErrNotFound, if no matching entry exists.

SpecificFindInOrderL ( TUint, TInt )

TInt	SpecificFindInOrderL	(	TUint	anEntry,
			TInt	aMode
		)	const [inline]

Finds the unsigned integer in the array that matches the specified unsigned integer using a binary search technique.

In the case that there is more than one matching element, finds the first, last or any match as specified.

The function assumes that the array is in unsigned integer order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

See also: TArrayFindMode

Parameters
anEntry	The unsigned integer to be found.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Return Value: The array index of a matching element - what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.

Leave Codes
KErrNotFound	if no matching entry exists.

SpecificFindInOrderL ( TUint, TInt &, TInt )

void	SpecificFindInOrderL	(	TUint	anEntry,
			TInt &	anIndex,
			TInt	aMode
		)	const [inline]

Finds the unsigned integer in the array that matches the specified unsigned integer using a binary search technique.

Where there is more than one matching element, it finds the first, last or any matching element as specified by the value of aMode.

The function assumes that the array is in unsigned integer order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

See also: TArrayFindMode

Parameters
anEntry	The unsigned integer to be found.
anIndex	A TInt type supplied by the caller. On return, it contains an index value depending on whether a match is found and on the value of aMode. If there is no matching element in the array, then this is the index of the first element in the array that is bigger than the element being searched for - if no elements in the array are bigger, then the index value is the same as the total number of elements in the array. If there is a matching element, then what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Leave Codes
KErrNotFound	if no matching entry exists.

operator[] ( TInt )

const TUint &

operator[]

(

TInt

anIndex

)

const [inline]

Gets a reference to the unsigned integer located at the specified position within the array.

The compiler uses this variant if the returned reference is used in an expression where the reference cannot be modified.

Parameters
anIndex	The position of the unsigned integer within the array, relative to zero, i.e. zero implies the entry at the beginning of the array.

Return Value: A reference to the const unsigned integer at position anIndex within the array.

Panic Codes
USER	130, if anIndex is negative, or is greater than the number of entries currently in the array.

operator[] ( TInt )

TUint &

operator[]

(

TInt

anIndex

)

[inline]

Gets a reference to the unsigned integer located at the specified position within the array.

The compiler uses this variant if the returned reference is used in an expression where the reference can be modified.

Parameters
anIndex	The position of the unsigned integer within the array, relative to zero, i.e. zero implies the entry at the beginning of the array.

Return Value: A reference to the non-const unsigned integer at position anIndex within the array.

Panic Codes
USER	130, if anIndex is negative, or is greater than the number of entries currently in the array.