#include <Array.h>
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  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 lowlevel array.  
const T *  get () const 
Get a pointer to the lowlevel 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.  
Protected Attributes  
int  _size 
Size of the array.  
int  _capacity 
Current capacity of the array.  
int  _capacityIncrement 
Increment by which the current capacity is increased when the capacity of this storage instance is reached.  
T  _defaultValue 
Default value of elements.  
T *  _array 
Array of values.  
Friends  
std::ostream &  operator<< (std::ostream &aOut, const Array< T > &aArray) 
Implementation of the output operator. 
virtual OpenSim::Array< T >::~Array  (  )  [inline, virtual] 
Destructor.
When the array is deleted, references to elements of this array become invalid.
OpenSim::Array< T >::Array  (  const T &  aDefaultValue = T() , 

int  aSize = 0 , 

int  aCapacity = Array_CAPMIN  
)  [inline] 
Default constructor.
aDefaultValue  Default value of an array element. This value is used to initialize array elements as the size of the array is changed.  
aSize  Initial size of the array. The array elements are initialized to aDefaultValue.  
aCapacity  Initial capacity of the array. The initial capacity is guarranteed to be at least as large as aSize + 1. 
OpenSim::Array< T >::Array  (  const Array< T > &  aArray  )  [inline] 
Coppy constructor.
aArray  Array to be copied. 
int OpenSim::Array< T >::append  (  int  aSize,  
const T *  aArray  
)  [inline] 
Append an array of values.
aSize  Size of the array to append.  
aArray  Array of values to append. 
int OpenSim::Array< T >::append  (  const Array< T > &  aArray  )  [inline] 
Append an array of values.
aArray  Array of values to append. 
int OpenSim::Array< T >::append  (  const T &  aValue  )  [inline] 
Append a value onto the array.
aValue  Value to be appended. 
bool OpenSim::Array< T >::arrayEquals  (  const Array< T > &  aArray  )  const [inline] 
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.
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. 
bool OpenSim::Array< T >::ensureCapacity  (  int  aCapacity  )  [inline] 
Ensure that the capacity of this array is at least the specified amount.
Note that the newly allocated array elements are not initialized.
aCapacity  Desired capacity. 
int OpenSim::Array< T >::findIndex  (  const T &  aValue  )  const [inline] 
Linear search for an element matching a given value.
aValue  Value to which the array elements are compared. 
T& OpenSim::Array< T >::get  (  int  aIndex  )  const [inline] 
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.
aIndex  Index of the desired array element. 
Exception  if (aIndex<0)(aIndex>=_size). 
const T* OpenSim::Array< T >::get  (  )  const [inline] 
Get a pointer to the lowlevel array.
T* OpenSim::Array< T >::get  (  )  [inline] 
Get a pointer to the lowlevel array.
int OpenSim::Array< T >::getCapacity  (  )  const [inline] 
Get the capacity of this storage instance.
int OpenSim::Array< T >::getCapacityIncrement  (  )  const [inline] 
Get the amount by which the capacity is increased.
T& OpenSim::Array< T >::getLast  (  )  const [inline] 
Get the last value in the array.
Exception  if the array is empty. 
int OpenSim::Array< T >::getSize  (  )  const [inline] 
Get the size of the array.
int OpenSim::Array< T >::insert  (  int  aIndex,  
const T &  aValue  
)  [inline] 
Insert a value into the array at a specified index.
This method is relatively computationally costly since many of the array elements may need to be shifted.
aValue  Value to be inserted.  
aIndex  Index at which to insert the new value. All current elements from aIndex to the end of the array are shifted one place in the direction of the end of the array. If the specified index is greater than the current size of the array, the size of the array is increased to aIndex+1 and the itervening new elements are initialized to the default value that was specified at the time of construction. 
Array<T>& OpenSim::Array< T >::operator=  (  const Array< T > &  aArray  )  [inline] 
Assign this array to a specified array.
This operator makes a complete copy of the specified array; all member variables are copied. So, the result is two identical, independent arrays.
aArray  Array to be copied. 
bool OpenSim::Array< T >::operator==  (  const Array< T > &  aArray  )  const [inline] 
Determine if two arrays are equal.
Two arrays are equal if their contents are equal. That is, each array must be the same length and their corresponding array elements must be equal.
aArray  Array to be tested as equal. 
T& OpenSim::Array< T >::operator[]  (  int  aIndex  )  const [inline] 
Get the array element at a specified index.
This overloaded operator can be used both to set and get element values:
<T> array(2);
value = array[i];
[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().
aIndex  Index of the desired element (0 <= aIndex < _size). 
int OpenSim::Array< T >::remove  (  int  aIndex  )  [inline] 
Remove a value from the array at a specified index.
This method is relatively computationally costly since many of the array elements may need to be shifted.
aIndex  Index of the value to remove. All elements from aIndex to the end of the array are shifted one place toward the beginning of the array. If aIndex is less than 0 or greater than or equal to the current size of the array, no element is removed. 
int OpenSim::Array< T >::rfindIndex  (  const T &  aValue  )  const [inline] 
Linear search in reverse for an element matching a given value.
aValue  Value to which the array elements are compared. 
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.
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. 
void OpenSim::Array< T >::set  (  int  aIndex,  
const T &  aValue  
)  [inline] 
Set the value at a specified index.
aIndex  Index of the array element to be set. It is permissible for aIndex to be past the current end of the array the capacity will be increased if necessary. Values between the current end of the array and aIndex are not initialized.  
aValue  Value. 
void OpenSim::Array< T >::setCapacityIncrement  (  int  aIncrement  )  [inline] 
Set the amount by which the capacity is increased when the capacity of of the array in exceeded.
If the specified increment is negative, the capacity is set to double whenever the capacity is exceeded.
aIncrement  Desired capacity increment. 
bool OpenSim::Array< T >::setSize  (  int  aSize  )  [inline] 
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.
aSize  Desired size of the array. The size must be greater than or equal to zero. 
void OpenSim::Array< T >::trim  (  )  [inline] 
Trim the capacity of this array so that it is one larger than the size of this array.
This is useful for reducing the amount of memory used by this array. This capacity is kept at one larger than the size so that, for example, an array of characters can be treated as a NULL terminated string.
std::ostream& operator<<  (  std::ostream &  aOut,  
const Array< T > &  aArray  
)  [friend] 
T* OpenSim::Array< T >::_array [protected] 
Array of values.
int OpenSim::Array< T >::_capacity [protected] 
Current capacity of the array.
int OpenSim::Array< T >::_capacityIncrement [protected] 
Increment by which the current capacity is increased when the capacity of this storage instance is reached.
If negative, capacity doubles.
T OpenSim::Array< T >::_defaultValue [protected] 
Default value of elements.
int OpenSim::Array< T >::_size [protected] 
Size of the array.
Also the index of the first empty array element.