Public Member Functions |
| virtual | ~Array () |
| | Destructor.
|
| | Array (const T &aDefaultValue=T(), int aSize=0, int aCapacity=Array_CAPMIN) |
| | Default constructor.
|
| | Array (const Array< T > &aArray) |
| | Coppy constructor.
|
| bool | arrayEquals (const Array< T > &aArray) const |
| T & | operator[] (int aIndex) const |
| | Get the array element at a specified index.
|
| Array< T > & | operator= (const Array< T > &aArray) |
| | Assign this array to a specified array.
|
| bool | operator== (const Array< T > &aArray) const |
| | Determine if two arrays are equal.
|
| bool | computeNewCapacity (int aMinCapacity, int &rNewCapacity) |
| | Compute a new capacity that is at least as large as a specified minimum capacity; this method does not change the capacity, it simply computes a new recommended capacity.
|
| bool | ensureCapacity (int aCapacity) |
| | Ensure that the capacity of this array is at least the specified amount.
|
| void | trim () |
| | Trim the capacity of this array so that it is one larger than the size of this array.
|
| int | getCapacity () const |
| | Get the capacity of this storage instance.
|
| void | setCapacityIncrement (int aIncrement) |
| | Set the amount by which the capacity is increased when the capacity of of the array in exceeded.
|
| int | getCapacityIncrement () const |
| | Get the amount by which the capacity is increased.
|
| bool | setSize (int aSize) |
| | Set the size of the array.
|
| int | getSize () const |
| | Get the size of the array.
|
| int | size () const |
| | Alternate name for getSize().
|
| int | append (const T &aValue) |
| | Append a value onto the array.
|
| int | append (const Array< T > &aArray) |
| | Append an array of values.
|
| int | append (int aSize, const T *aArray) |
| | Append an array of values.
|
| int | insert (int aIndex, const T &aValue) |
| | Insert a value into the array at a specified index.
|
| int | remove (int aIndex) |
| | Remove a value from the array at a specified index.
|
| void | set (int aIndex, const T &aValue) |
| | Set the value at a specified index.
|
| T * | get () |
| | Get a pointer to the low-level array.
|
| const T * | get () const |
| | Get a pointer to the low-level array.
|
| T & | get (int aIndex) const |
| | Get the value at a specified array index.
|
| T & | getLast () const |
| | Get the last value in the array.
|
| int | findIndex (const T &aValue) const |
| | Linear search for an element matching a given value.
|
| int | rfindIndex (const T &aValue) const |
| | Linear search in reverse for an element matching a given value.
|
| int | searchBinary (const T &aValue, bool aFindFirst=false, int aLo=-1, int aHi=-1) const |
| | Search for the largest value in the array that is less than or equal to a specified value.
|
template<class T>
| bool OpenSim::Array< T >::computeNewCapacity |
( |
int |
aMinCapacity, |
|
|
int & |
rNewCapacity |
|
) |
| |
|
inline |
Compute a new capacity that is at least as large as a specified minimum capacity; this method does not change the capacity, it simply computes a new recommended capacity.
If the capacity increment is negative, the current capacity is doubled until the computed capacity is greater than or equal to the specified minimum capacity. If the capacity increment is positive, the current capacity increment by this amount until the computed capacity is greater than or equal to the specified minimum capacity. If the capacity increment is zero, the computed capacity is set to the current capacity and false is returned.
- Parameters
-
| rNewCapacity | New computed capacity. |
| aMinCapacity | Minimum new computed capacity. The computed capacity is incremented until it is at least as large as aMinCapacity, assuming the capacity increment is not zero. |
- Returns
- True if the new capacity was increased, false otherwise (i.e., if the capacity increment is set to 0).
- See Also
- setCapacityIncrement()
Get the value at a specified array index.
If the index is negative or passed the end of the array, an exception is thrown.
For faster execution, the array elements can be accessed through the overloaded operator[], which does no bounds checking.
- Parameters
-
| aIndex | Index of the desired array element. |
- Returns
- Reference to the array element.
- Exceptions
-
- See Also
- operator[].
Get the array element at a specified index.
This overloaded operator can be used both to set and get element values:
Array<T> array(2);
T value = array[i];
array[i] = value;
This operator is intended for accessing array elements with as little overhead as possible, so no error checking is performed. The caller must make sure the specified index is within the bounds of the array. If error checking is desired, use Array::get().
- Parameters
-
| aIndex | Index of the desired element (0 <= aIndex < _size). |
- Returns
- Reference to the array element.
- See Also
- get().
template<class T>
| int OpenSim::Array< T >::searchBinary |
( |
const T & |
aValue, |
|
|
bool |
aFindFirst = false, |
|
|
int |
aLo = -1, |
|
|
int |
aHi = -1 |
|
) |
| const |
|
inline |
Search for the largest value in the array that is less than or equal to a specified value.
If there is more than one element with this largest value, the index of the first of these elements can optionally be found, but this can be up to twice as costly.
This method assumes that the array element values monotonically increase as the array index increases. Note that monotonically increase means never decrease, so it is permissible for elements to
A binary search is performed (i.e., the array is repeatedly subdivided into two bins one of which must contain the specified until the approprite element is identified), so the performance of this method is approximately ln(n), where n is the size of the array.
- Parameters
-
| aValue | Value to which the array elements are compared. |
| aFindFirst | If true, find the first element that satisfies the search. If false, the index of any element that satisfies the search can be returned- which index will be returned depends on the length of the array and is therefore somewhat arbitrary. By default, this flag is false. |
| aLo | Lowest array index to consider in the search. |
| aHi | Highest array index to consider in the search. |
- Returns
- Index of the array element that has the largest value that is less than or equal to aValue. If there is more than one such elements with the same value and aFindFirst is set to true, the index of the first of these elements is returned. If an error is encountered (e.g., the array is empty), or the array contains no element that is less than or equal to aValue, -1 is returned.
Set the size of the array.
This method can be used to either increase or decrease the size of the array. If this size of the array is increased, the new elements are initialized to the default value that was specified at the time of construction.
Note that the size of an array is different than its capacity. The size indicates how many valid elements are stored in an array. The capacity indicates how much the size of the array can be increased without allocated more memory. At all times size <= capacity.
- Parameters
-
| aSize | Desired size of the array. The size must be greater than or equal to zero. |
1.8.1.2 
