Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACE_Vector Class Template Reference

Defines an STL-like vector container. More...

#include <Vector_T.h>

Inheritance diagram for ACE_Vector:

Inheritance graph
[legend]
Collaboration diagram for ACE_Vector:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ACE_Array_Iterator<
T > 
Iterator

Public Methods

 ACE_Vector (const size_t init_size=DEFAULT_SIZE, ACE_Allocator *alloc=0)
 ~ACE_Vector ()
size_t capacity (void) const
size_t size (void) const
void clear (void)
void resize (const size_t new_size, const T &t)
void push_back (const T &elem)
void pop_back (void)
void dump (void) const

Protected Attributes

size_t length_
size_t curr_max_size_

Detailed Description

template<class T, size_t DEFAULT_SIZE = ACE_VECTOR_DEFAULT_SIZE>
class ACE_Vector< T, DEFAULT_SIZE >

Defines an STL-like vector container.

This is an STL-like template vector container, a wrapper around ACE_Array. It provides at least the basic std::vector look and feel: push_back(), clear(), resize(), capacity(). This template class uses the copy semantic paradigm, though it is okay to use reference counted smart pointers (see ACE_Ptr<T>) with this template class.

Requirements and Performance Characteristics

Definition at line 65 of file Vector_T.h.


Member Typedef Documentation

template<class T, size_t DEFAULT_SIZE = ACE_VECTOR_DEFAULT_SIZE>
typedef ACE_Array_Iterator<T> ACE_Vector::Iterator
 

A short name for iterator for ACE_Vector.

Definition at line 71 of file Vector_T.h.


Constructor & Destructor Documentation

template<class T, size_t DEFAULT_SIZE>
ACE_INLINE ACE_Vector< T, DEFAULT_SIZE >::ACE_Vector const size_t    init_size = DEFAULT_SIZE,
ACE_Allocator   alloc = 0
 

General constructor.

Parameters:
init_size  Initial size of the vector with the default value of DEFAULT_SIZE
alloc  Pointer to an ACE allocator. If it is NULL then the default ACE allocator is used

Definition at line 5 of file Vector_T.i.

References curr_max_size_, length_, and ACE_Array_Base::max_size.

00007   : ACE_Array<T> (init_size == 0 ? DEFAULT_SIZE : init_size, alloc)
00008 {
00009   length_ = 0;
00010   curr_max_size_ = this->max_size ();
00011 }

template<class T, size_t DEFAULT_SIZE>
ACE_INLINE ACE_Vector< T, DEFAULT_SIZE >::~ACE_Vector  
 

Destructor.

Definition at line 14 of file Vector_T.i.

00015 {
00016 }


Member Function Documentation

template<class T, size_t DEFAULT_SIZE>
ACE_INLINE size_t ACE_Vector< T, DEFAULT_SIZE >::capacity void    const
 

Returns the current vector capacity, that is, the currently allocated buffer size.

Returns:
Current buffer size of the vector

Definition at line 19 of file Vector_T.i.

References curr_max_size_.

00020 {
00021   return curr_max_size_;
00022 }

template<class T, size_t DEFAULT_SIZE>
ACE_INLINE void ACE_Vector< T, DEFAULT_SIZE >::clear void   
 

Clears out the vector. It does not reallocate the vector's buffer, it is just sets the vector's dynamic size to 0.

Definition at line 31 of file Vector_T.i.

References length_.

00032 {
00033   length_ = 0;
00034 }

template<class T, size_t DEFAULT_SIZE>
void ACE_Vector< T, DEFAULT_SIZE >::dump void    const
 

This function dumps the content of the vector. TO BE MOVED out of this class. It needs to be implemented as a global template function that accepts a const ACE_Vector<T>, in order to make instances of this class compile on Linux, AIX. G++ and xlC have template instantiation algoriths, which are different from the one in Visual C++. The algorithms try to instantiate ALL methods declared in the template class, regardless of whether the functions are used or not. That is, all of the classes, that are used as elements in ACE_Vector's, have to have the dump() methods defined in them (seems to be overkill).

This function calls T::dump() for each element of the vector.

Definition at line 46 of file Vector_T.cpp.

References size.

00047 {
00048 #if 0
00049   // Can't do this unless the vector is an object with a dump
00050   // function.
00051   for (size_t i = 0; i < this->size (); ++i)
00052     (*this)[i].dump ();
00053 #endif /* 0 */
00054 }

template<class T, size_t DEFAULT_SIZE>
ACE_INLINE void ACE_Vector< T, DEFAULT_SIZE >::pop_back void   
 

Deletes the last element from the vector ("pop back"). What this function really does is decrement the dynamic size of the vector. The vector's buffer does not get reallocated for performance.

Definition at line 37 of file Vector_T.i.

References length_.

00038 {
00039   if (length_ > 0)
00040     --length_;
00041 }

template<class T, size_t DEFAULT_SIZE>
void ACE_Vector< T, DEFAULT_SIZE >::push_back const T &    elem
 

Appends a new element to the vector ("push back"). If the dynamic size of the vector is equal to the capacity of the vector (vector is at capacity), the vector automatically doubles its capacity.

Parameters:
elem  A reference to the new element to be appended. By default, this parameters gets initialized with the default value of the class T.

Definition at line 34 of file Vector_T.cpp.

References curr_max_size_, length_, ACE_Array_Base::max_size, and ACE_Array_Base::size.

00035 {
00036   if (length_ == curr_max_size_)
00037     {
00038       ACE_Array<T>::size (curr_max_size_ * 2);
00039       curr_max_size_ = this->max_size ();
00040     }
00041   ++length_;
00042   (*this)[length_-1] = elem;
00043 }

template<class T, size_t DEFAULT_SIZE>
void ACE_Vector< T, DEFAULT_SIZE >::resize const size_t    new_size,
const T &    t
 

Resizes the vector to the new capacity. If the vector's current capacity is smaller than the size to be specified, then the buffer gets reallocated. If the new capacity is less than the current capacity of the vector, the buffer size stays the same.

Parameters:
new_size  New capacity of the vector
t  A filler value (of the class T) for initializing the elements of the vector with. By default, if this parameter is not specified, the default value of the class T will be used (for more detail, see the initialization clause for this parameter).

Definition at line 21 of file Vector_T.cpp.

References curr_max_size_, length_, ACE_Array_Base::max_size, and ACE_Array_Base::size.

00023 {
00024   ACE_Array<T>::size (new_size);
00025   if (new_size > length_)
00026     for (size_t i = length_; i < new_size; ++i)
00027       (*this)[i]=t;
00028 
00029   curr_max_size_ = this->max_size ();
00030   length_ = new_size;
00031 }

template<class T, size_t DEFAULT_SIZE>
ACE_INLINE size_t ACE_Vector< T, DEFAULT_SIZE >::size void    const
 

Returns the vector's dynamic size / actual current size of the vector. Do not confuse it with ACE_Array::size(), which returns the array's capacity. Unfortunately, ACE is not very consistent with the function names.

Returns:
Dynamic size / actual current size of the vector.

Reimplemented from ACE_Array_Base.

Definition at line 25 of file Vector_T.i.

References length_.

Referenced by dump.

00026 {
00027   return length_;
00028 }


Member Data Documentation

template<class T, size_t DEFAULT_SIZE = ACE_VECTOR_DEFAULT_SIZE>
size_t ACE_Vector::curr_max_size_ [protected]
 

Current capacity (buffer size) of the vector.

Definition at line 176 of file Vector_T.h.

Referenced by ACE_Vector, capacity, push_back, and resize.

template<class T, size_t DEFAULT_SIZE = ACE_VECTOR_DEFAULT_SIZE>
size_t ACE_Vector::length_ [protected]
 

Dynamic size (length) of the vector.

Definition at line 171 of file Vector_T.h.

Referenced by ACE_Vector, clear, pop_back, push_back, resize, and size.


The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:59:06 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002