Polaris: Array.h Source File

Array.h Go to the documentation of this file. #ifndef _ARRAY_H #define _ARRAY_H /// /// /// /// \class Array /// \brief A template for an array of objects /// \defgroup Polaris /// \ingroup Polaris /// Base /// \see Array.h /// \see Array.h /// /// \endcode /// \section Overview Overview /// This class is a template for forming an array of objects. /// /// \endcode /// \section Description Description /// The Array class offers three improvements from a simple array of /// objects; It knows its size, it can be resized, and it knows how to /// print itself. This class differs from the List class in that /// random access is cheap to perform while resizing is expensive. /// /// The objects stored in Array must have two methods: a constructor /// that takes no arguments, and operator=(). /// /// Arrays are indexed from 0. /// #include "ClassNames.h" #include <stream.h> #include "p-assert.h" /// template<class T> class Array { public: inline Array(); inline Array(int size); inline Array(const Array<T> &other); inline ~Array(); inline int entries() const; ///< Return the size of the array. inline const T & operator[] (int sub) const; inline T & operator[] (int sub); ///< Access an element in the array. inline void clear(); ///< Delete all the elements of the array and set the size ///< to zero. inline void resize(int size); ///< Resize the array to the given value. inline void print(ostream &out) const; ///< gcc-2.96 need the stupid "<>" pair ///< inline friend ostream & operator << (ostream &o, const Array<T> & a); friend ostream & operator << <> (ostream &o, const Array<T> & a); ///< Print Array as a comma separated list where each element is ///< printed out in the form subscript:object. inline void print(ostream &out, char *sep) const; ///< Print Array with 'sep' separating each element. The ///< subscripts are not printed. inline Array<T> & operator = (const Array<T> & l); ///< Copy the contents of the other array into myself. inline int structures_OK() const; ///< Check the structure of the data for errors or inconsistency ///< Return 0 and print error message if problems found, otherwise ///< return 1 without message. private: T *_array; int _entries; }; ///< implementation template <class T> inline Array<T>::Array() { #ifdef CLASS_INSTANCE_REGISTRY register_instance(ARRAY_CLASS, sizeof(Array), this); #endif _entries = 0; _array = 0; } template <class T> inline Array<T>::Array(int size) { #ifdef CLASS_INSTANCE_REGISTRY register_instance(ARRAY_CLASS, sizeof(Array), this); #endif _entries = 0; _array = 0; resize(size); } template <class T> inline Array<T>::Array(const Array<T> &other) { #ifdef CLASS_INSTANCE_REGISTRY register_instance(ARRAY_CLASS, sizeof(Array), this); #endif _entries = 0; _array = 0; *this = other; } template <class T> inline Array<T>::~Array() { #ifdef CLASS_INSTANCE_REGISTRY unregister_instance(ARRAY_CLASS, this); #endif if (_array) delete [] _array; } template <class T> inline int Array<T>::entries() const { return _entries; } template <class T> inline const T & Array<T>::operator[] (int sub) const { p_assert(0 <= sub && sub < _entries, "Subscript out of range for Array::operator[]()."); return _array[sub]; } template <class T> inline T & Array<T>::operator[] (int sub) { p_assert(0 <= sub && sub < _entries, "Subscript out of range for Array::operator[]()."); return _array[sub]; } template <class T> inline void Array<T>::clear() { _entries = 0; if (_array) { delete [] _array; _array = 0; } } template <class T> inline void Array<T>::resize(int size) { if (size < 0) size = 0; if (size != _entries) { int min_size = (size < _entries) ? size : _entries; T * old_array = _array; _entries = size; _array = new T [_entries]; for (int i = 0; i < min_size; ++i) _array[i] = old_array[i]; if (old_array) delete [] old_array; } } template <class T> inline Array<T> & Array<T>::operator = (const Array<T> & other) { if (_entries != other._entries) resize(other._entries); for (int i = 0; i < _entries; ++i) _array[i] = other._array[i]; return *this; } template <class T> inline void Array<T>::print(ostream & out, char *sep) const { if (_entries > 0) { out << _array[0]; for (int i = 1; i < _entries; ++i) out << sep << _array[i]; } } template <class T> inline void Array<T>::print(ostream & out) const { if (_entries > 0) { out << 0 << ":" << _array[0]; for (int i = 1; i < _entries; ++i) out << ", " << i << ":" << _array[i]; } } template <class T> ostream & operator << (ostream &o, const Array<T> & a) { a.print(o); return o; } template <class T> inline int Array<T>::structures_OK() const { if (_entries < 0) { cerr << "\n\nError: Array::structures_OK(): Has a negative size.\n"; return 0; } else if (_array == 0 && _entries != 0) { cerr << "\n\nError: Array::structures_OK(): _array field is NULL.\n"; return 0; } return 1; } #endif

© 1995-2005 University of Illinois, Urbana-Champaign. All rights reserved.  Fri Mar 25 23:05:37 2005