| template <> |
| class RArray< TUint > : private RPointerArrayBase |
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.
| 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) |
| 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 | aGranularity | ) | [inline, explicit] |
Constructs an array object for an array of unsigned integers with the specified granularity.
panic
USER 127, if aGranularity is not positive or is greater than or equal to 0x10000000.
| TInt aGranularity | The granularity of the array. |
| 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.
panic
USER 192, if aMinGrowBy<=0 or aMinGrowBy>65535.
panic
USER 193, if aFactor<=257 or aFactor>32767.
| 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.
| TInt | Append | ( | TUint | anEntry | ) | [inline] |
Appends an unsigned integer onto the array.
KErrNone, if the insertion is successful, otherwise one of the system wide error codes.
| TUint anEntry | The unsigned integer to be appended. |
| 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.
| TUint anEntry | The unsigned integer to be appended. |
| void | Close | ( | ) | [inline] |
Closes the array and frees all memory allocated to the array.
The function must be called before this array object goes out of scope.
| void | Compress | ( | ) | [inline] |
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.
| TInt | Count | ( | ) | const [inline] |
Gets the number of unsigned integers in the array.
The number of unsigned integers in the array.
| 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.
The index of the first matching unsigned integer within the array. KErrNotFound, if no matching entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| 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.
This is either: the index of the matching unsigned integer within the array; KErrNotFound, if no suitable entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| 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.
KErrNone, if a matching unsigned integer is found. KErrNotFound, if no suitable entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| TInt & 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. |
| 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.
The index of the matching unsigned integer within the array;
leave
KErrNotFound, if no matching entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| 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.
leave
KErrNotFound, if no matching entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| TInt & 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. |
| 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.
The index of the first matching unsigned integer within the array.
leave
KErrNotFound, if no matching entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| 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.
The index of the last matching unsigned integer within the array. KErrNotFound, if no matching entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| 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.
The index of the last matching unsigned integer within the array.
leave
KErrNotFound, if no matching entry can be found.
| TUint anEntry | The unsigned integer to be found. |
| void | GranularCompress | ( | ) | [inline] |
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.
| TInt | Insert | ( | TUint | anEntry, |
| TInt | aPos | |||
| ) | [inline] | |||
Inserts an unsigned integer into the array at the specified position.
KErrNone, if the insertion is successful, otherwise one of the system wide error codes.
panic
USER 131, if aPos is negative, or is greater than the number of entries currently in the array.
| 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.
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.
| TUint anEntry | The unsigned integer to be inserted. |
| 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.
KErrNone, if the insertion is successful, otherwise one of the system wide error codes.
| TUint anEntry | The unsigned integer to be inserted. |
| void | InsertInOrderAllowRepeatsL | ( | 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.
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.
| TUint anEntry | The unsigned integer to be inserted. |
| 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.
| TUint anEntry | The unsigned integer to be inserted. |
| 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.
panic
USER 131, if aPos is negative, or is greater than the number of entries currently in the array.
| void | Remove | ( | TInt | anIndex | ) | [inline] |
Removes the unsigned integer at the specified position from the array.
panic
USER 130, if anIndex is negative, or is greater than the number of entries currently in the array.
| TInt 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. |
| 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.
KErrNone If the operation completed successfully
KErrNoMemory If the requested amount of memory could not be allocated
| TInt aCount | The number of integers for which space should be reserved |
| void | ReserveL | ( | 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.
leave
KErrNoMemory If the requested amount of memory could not be allocated
| TInt aCount | The number of integers for which space should be reserved |
| void | Reset | ( | ) | [inline] |
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.
| 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.
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.
| 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.
KErrNone, if a matching entry is found; KErrNotFound, if no matching entry exists.
| TUint anEntry | The unsigned integer to be found. |
| TInt & 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. |
| TInt aMode | Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values. |
| 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.
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
KErrNotFound if no matching entry exists.
| 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.
leave
KErrNotFound if no matching entry exists.
| TUint anEntry | The unsigned integer to be found. |
| TInt & 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. |
| TInt aMode | Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values. |
| 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.
A reference to the const unsigned integer at position anIndex within the array.
panic
USER 130, if anIndex is negative, or is greater than the number of entries currently in the array.
| TInt 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. |
| 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.
A reference to the non-const unsigned integer at position anIndex within the array.
panic
USER 130, if anIndex is negative, or is greater than the number of entries currently in the array.
| TInt 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. |