Created by Scott Robert Ladd at Coyote Gulch Productions.
A STL-compatible array class. More...
#include <array.h>
This class defines a simple array with elements stored in contiguous allocated memory. The Standard C++ valarray is focused on numerical applications and largely incompatible with the STL. The std::vector includes dyanmic array features that simply aren't necessary for many applications.
libcoyotl::array< Type >::array | ( | size_t | a_length | ) |
Constructs an array with a_length uninitialized elements. /param a_length number of elements in the array
References libcoyotl::array< Type >::m_array, and libcoyotl::array< Type >::m_size.
libcoyotl::array< Type >::array | ( | size_t | a_length, |
const Type & | a_init_value | ||
) |
Constructs an array with specific number of elements initialized to given value. /param a_length number of elements in the array /param a_init_value initial value of all array elements
References libcoyotl::array< Type >::m_array, and libcoyotl::array< Type >::m_size.
libcoyotl::array< Type >::array | ( | const array< Type > & | a_source | ) |
Creates a new array identical to an existing one.
a_source | - The a_source object |
References libcoyotl::array< Type >::m_array, and libcoyotl::array< Type >::m_size.
libcoyotl::array< Type >::array | ( | size_t | a_length, |
const Type * | a_carray | ||
) |
Constructs a new array by copying the elements of the specified C-style array. /param a_length number of elements in the array /param a_carray pointer to an array of with a_length elements
References libcoyotl::array< Type >::m_array, and libcoyotl::array< Type >::m_size.
libcoyotl::array< Type >::~array | ( | ) | throw () [virtual] |
A virtual destructor. By default, it does nothing; this is a placeholder that identifies this class as a potential base, ensuring that objects of a derived class will have their destructors called if they are destroyed through a base-class pointer.
void libcoyotl::array< Type >::append | ( | const array< Type > & | a_array | ) |
Appends the a_other array to the target, extending the length of the target by the length of a_other.
a_array | - Array to be appended to the target |
References libcoyotl::array< Type >::m_array, and libcoyotl::array< Type >::m_size.
array< Type >::iterator libcoyotl::array< Type >::begin | ( | ) | throw () [inline] |
Returns an iterator to the first elements of the array.
array< Type >::const_iterator libcoyotl::array< Type >::begin | ( | ) | const throw () [inline] |
Returns a const iterator to the first element of the array.
const Type * libcoyotl::array< Type >::c_array | ( | ) | const throw () [inline] |
Returns a pointer to the internal C-style array encapsulated by this array. The returned pointer is constant, so no elements can be change via this function.
bool libcoyotl::array< Type >::empty | ( | ) | const throw () [inline] |
Always false, as an array is never "empty". Required by Standard C++ algorithms and container definitions.
array< Type >::iterator libcoyotl::array< Type >::end | ( | ) | throw () [inline] |
Returns an iterator to the first element beyond the end of the array.
array< Type >::const_iterator libcoyotl::array< Type >::end | ( | ) | const throw () [inline] |
Returns a const iterator to the first element beyond the end of the array.
size_t libcoyotl::array< Type >::max_size | ( | ) | const throw () [inline] |
Returns the maximum size of the container, which is the same as the size(). Required by Standard C++ algorithms and container definitions.
bool libcoyotl::array< Type >::operator!= | ( | const array< Type > & | a_comparand | ) | const throw () [inline] |
Compares corresponding elements of the target array to the argument array, checking for inequality.
a_comparand | - Comparand array |
bool libcoyotl::array< Type >::operator< | ( | const array< Type > & | a_comparand | ) | const throw () [inline] |
Compares corresponding elements of the target array and the comparand array, checking that all target elements are less than comparand elements.
a_comparand | - Comparand array |
bool libcoyotl::array< Type >::operator<= | ( | const array< Type > & | a_comparand | ) | const throw () [inline] |
Compares corresponding elements of the target array and the comparand array, checking that all target elements are less than or equal to comparand elements.
a_comparand | - Comparand array |
array< Type > & libcoyotl::array< Type >::operator= | ( | const array< Type > & | a_source | ) | throw () |
Assigns an existing object the state of another.
a_source | - The source object |
array< Type > & libcoyotl::array< Type >::operator= | ( | const Type & | a_value | ) | throw () |
Assigns a given value to all elements in an array.
a_value | - Value to be assigned |
array< Type > & libcoyotl::array< Type >::operator= | ( | const Type * | a_carray | ) | throw () |
Assign elements from a c-style array, assuming that c_array contains at least the number of elements in the target array.
a_carray | - A pointer to a C-style array |
bool libcoyotl::array< Type >::operator== | ( | const array< Type > & | a_comparand | ) | const throw () [inline] |
Compares corresponding elements of the target array to the argument array, checking for equality.
a_comparand | - Comparand array |
bool libcoyotl::array< Type >::operator> | ( | const array< Type > & | a_comparand | ) | const throw () [inline] |
Compares corresponding elements of the target array and the comparand array, checking that all target elements are greater than comparand elements.
a_comparand | - Comparand array |
bool libcoyotl::array< Type >::operator>= | ( | const array< Type > & | a_comparand | ) | const throw () [inline] |
Compares corresponding elements of the target array and the comparand array, checking that all target elements are greater than or equal to comparand elements.
a_comparand | - Comparand array |
Type & libcoyotl::array< Type >::operator[] | ( | size_t | n | ) | throw (LIBCOYOTL_ARRAY_EXCEPTIONS) [inline] |
Returns a reference to a specific element in an array.
n | - Index of an element |
Type libcoyotl::array< Type >::operator[] | ( | size_t | n | ) | const throw (LIBCOYOTL_ARRAY_EXCEPTIONS) [inline] |
Returns a specific element in an array.
n | - Index of an element |
array< Type >::reverse_iterator libcoyotl::array< Type >::rbegin | ( | ) | throw () [inline] |
Returns a reverse iterator to the first element beyond the end of the array.
array< Type >::const_reverse_iterator libcoyotl::array< Type >::rbegin | ( | ) | const throw () [inline] |
Returns a reverse iterator to the first element beyond the end of the array.
array< Type >::reverse_iterator libcoyotl::array< Type >::rend | ( | ) | throw () [inline] |
Returns a reverse iterator to the first element of the array.
array< Type >::const_reverse_iterator libcoyotl::array< Type >::rend | ( | ) | const throw () [inline] |
Returns a const reverse iterator to the first element of the array.
size_t libcoyotl::array< Type >::size | ( | ) | const throw () [inline] |
Returns the number of elements in an array. Required by Standard C++ algorithms and container definitions.
void libcoyotl::array< Type >::swap | ( | array< Type > & | a_source | ) | throw () |
Exchanges the corresponding elements of two arrays; used by various Standard C++ algorithms.
a_source | - Another array |
© 1996-2005 Scott Robert Ladd. All rights reserved.
HTML documentation generated by Dimitri van Heesch's excellent Doxygen tool.