---

ACE_Array_Base Class Template Reference

Implement a simple dynamic array. More...

#include <Array_Base.h>

Inheritance diagram for ACE_Array_Base:

[legend]Collaboration diagram for ACE_Array_Base:

[legend]List of all members.

Public Types
typedef T	TYPE
typedef ACE_Array_Iterator< T >	ITERATOR
Public Methods
	ACE_Array_Base (size_t size=0, ACE_Allocator *alloc=0)
	Dynamically create an uninitialized array. More...
	ACE_Array_Base (size_t size, const T &default_value, ACE_Allocator *alloc=0)
	Dynamically initialize the entire array to the <default_value>. More...
	ACE_Array_Base (const ACE_Array_Base< T > &s)
void	operator= (const ACE_Array_Base< T > &s)
	~ACE_Array_Base (void)
	Clean up the array (e.g., delete dynamically allocated memory). More...
T &	operator[] (size_t slot)
	Set item in the array at location <slot>. Doesn't perform range checking. More...
const T &	operator[] (size_t slot) const
	Get item in the array at location <slot>. Doesn't perform range checking. More...
int	set (const T &new_item, size_t slot)
	Set an item in the array at location <slot>. Returns -1 if <slot> is not in range, else returns 0. More...
int	get (T &item, size_t slot) const
size_t	size (void) const
	Returns the <cur_size_> of the array. More...
int	size (size_t new_size)
size_t	max_size (void) const
	Returns the <max_size_> of the array. More...
int	max_size (size_t new_size)
Private Methods
int	in_range (size_t slot) const
	Returns 1 if <slot> is within range, i.e., 0 >= <slot> < <cur_size_>, else returns 0. More...
Private Attributes
size_t	max_size_
	Maximum size of the array, i.e., the total number of <T> elements in <array_>. More...
size_t	cur_size_
T *	array_
	Pointer to the array's storage buffer. More...
ACE_Allocator *	allocator_
	Allocation strategy of the ACE_Array_Base. More...
Friends
class	ACE_Array_Iterator< T >

---

Detailed Description

template<class T>
class ACE_Array_Base< T >

Implement a simple dynamic array.

This parametric class implements a simple dynamic array; resizing must be controlled by the user. No comparison or find operations are implemented.

Definition at line 41 of file Array_Base.h.

---

Member Typedef Documentation

template<class T> typedef ACE_Array_Iterator<T> ACE_Array_Base::ITERATOR

Reimplemented in ACE_Array. Definition at line 47 of file Array_Base.h.

template<class T> typedef T ACE_Array_Base::TYPE

Reimplemented in ACE_Array. Definition at line 46 of file Array_Base.h.

---

Constructor & Destructor Documentation

template<class T> ACE_Array_Base< T >::ACE_Array_Base (  size_t    size = 0, ACE_Allocator *    alloc = 0 )

Dynamically create an uninitialized array. Definition at line 23 of file Array_Base.cpp. References ACE_ALLOCATOR, allocator_, array_, ACE_Allocator::instance, and size. : max_size_ (size), cur_size_ (size), allocator_ (alloc) { if (this->allocator_ == 0) this->allocator_ = ACE_Allocator::instance (); if (size != 0) { ACE_ALLOCATOR (this->array_, (T *) this->allocator_->malloc (size * sizeof (T))); for (size_t i = 0; i < size; ++i) new (&array_[i]) T; } else this->array_ = 0; }

template<class T> ACE_Array_Base< T >::ACE_Array_Base (  size_t    size, const T &    default_value, ACE_Allocator *    alloc = 0 )

Dynamically initialize the entire array to the <default_value>. Definition at line 44 of file Array_Base.cpp. References ACE_ALLOCATOR, allocator_, array_, ACE_Allocator::instance, and size. : max_size_ (size), cur_size_ (size), allocator_ (alloc) { if (this->allocator_ == 0) this->allocator_ = ACE_Allocator::instance (); if (size != 0) { ACE_ALLOCATOR (this->array_, (T *) this->allocator_->malloc (size * sizeof (T))); for (size_t i = 0; i < size; ++i) new (&array_[i]) T (default_value); } else this->array_ = 0; }

template<class T> ACE_Array_Base< T >::ACE_Array_Base (  const ACE_Array_Base< T > &    s )

The copy constructor performs initialization by making an exact copy of the contents of parameter <s>, i.e., *this == s will return true. Definition at line 68 of file Array_Base.cpp. References ACE_ALLOCATOR, allocator_, array_, ACE_Allocator::instance, and size. : max_size_ (s.size ()), cur_size_ (s.size ()), allocator_ (s.allocator_) { if (this->allocator_ == 0) this->allocator_ = ACE_Allocator::instance (); ACE_ALLOCATOR (this->array_, (T *) this->allocator_->malloc (s.size () * sizeof (T))); for (size_t i = 0; i < this->size (); i++) new (&this->array_[i]) T (s.array_[i]); }

template<class T> ACE_INLINE ACE_Array_Base< T >::~ACE_Array_Base (  void    )

Clean up the array (e.g., delete dynamically allocated memory). Definition at line 7 of file Array_Base.inl. References ACE_DES_ARRAY_FREE. { ACE_DES_ARRAY_FREE (this->array_, this->max_size_, this->allocator_->free, T); }

---

Member Function Documentation

template<class T> int ACE_Array_Base< T >::get (  T &    item, size_t    slot )  const

Get an item in the array at location <slot>. Returns -1 if <slot> is not in range, else returns 0. Note that this function copies the item. If you want to avoid the copy, you can use the const operator[], but then you'll be responsible for range checking. Definition at line 132 of file Array_Base.cpp. References array_, and in_range. { if (this->in_range (slot)) { // Copies the item. If you don't want to copy, use operator [] // instead (but then you'll be responsible for range checking). item = this->array_[slot]; return 0; } else return -1; }

template<class T> ACE_INLINE int ACE_Array_Base< T >::in_range (  size_t    slot )  const [private]

Returns 1 if <slot> is within range, i.e., 0 >= <slot> < <cur_size_>, else returns 0. Definition at line 28 of file Array_Base.inl. References cur_size_. Referenced by get, and set. { return index < this->cur_size_; }

template<class T> int ACE_Array_Base< T >::max_size (  size_t    new_size )

Changes the size of the array to match <new_size>. It copies the old contents into the new array. Return -1 on failure. It does not affect new_size Definition at line 146 of file Array_Base.cpp. References ACE_ALLOCATOR_RETURN, ACE_DES_ARRAY_FREE, array_, cur_size_, and max_size_. { if (new_size > this->max_size_) { T *tmp; ACE_ALLOCATOR_RETURN (tmp, (T *) this->allocator_->malloc (new_size * sizeof (T)), -1); for (size_t i = 0; i < this->cur_size_; ++i) new (&tmp[i]) T (this->array_[i]); // Initialize the new portion of the array that exceeds the // previously allocated section. for (size_t j = this->cur_size_; j < new_size; j++) new (&tmp[j]) T; ACE_DES_ARRAY_FREE (this->array_, this->max_size_, this->allocator_->free, T); this->array_ = tmp; this->max_size_ = new_size; this->cur_size_ = new_size; } return 0; }

template<class T> ACE_INLINE size_t ACE_Array_Base< T >::max_size (  void    )  const

Returns the <max_size_> of the array. Definition at line 22 of file Array_Base.inl. References max_size_. Referenced by ACE_Vector::ACE_Vector, ACE_Vector::push_back, ACE_Vector::resize, and size. { return this->max_size_; }

template<class T> void ACE_Array_Base< T >::operator= (  const ACE_Array_Base< T > &    s )

Assignment operator performs an assignment by making an exact copy of the contents of parameter <s>, i.e., *this == s will return true. Note that if the <max_size_> of <array_> is >= than <s.max_size_> we can copy it without reallocating. However, if <max_size_> is < <s.max_size_> we must delete the <array_>, reallocate a new <array_>, and then copy the contents of <s>. Definition at line 85 of file Array_Base.cpp. References ACE_ALLOCATOR, ACE_DES_ARRAY_FREE, ACE_DES_ARRAY_NOFREE, array_, cur_size_, max_size_, and size. Referenced by ACE_Array::operator=. { // Check for "self-assignment". if (this != &s) { if (this->max_size_ < s.size ()) { ACE_DES_ARRAY_FREE (this->array_, this->max_size_, this->allocator_->free, T); ACE_ALLOCATOR (this->array_, (T *) this->allocator_->malloc (s.size () * sizeof (T))); this->max_size_ = s.size (); } else { ACE_DES_ARRAY_NOFREE (this->array_, s.size (), T); } this->cur_size_ = s.size (); for (size_t i = 0; i < this->size (); i++) new (&this->array_[i]) T (s.array_[i]); } }

template<class T> ACE_INLINE const T & ACE_Array_Base< T >::operator[] (  size_t    slot )  const

Get item in the array at location <slot>. Doesn't perform range checking. Definition at line 40 of file Array_Base.inl. References array_. { return this->array_[index]; }

template<class T> ACE_INLINE T & ACE_Array_Base< T >::operator[] (  size_t    slot )

Set item in the array at location <slot>. Doesn't perform range checking. Definition at line 34 of file Array_Base.inl. References array_. { return this->array_[index]; }

template<class T> int ACE_Array_Base< T >::set (  const T &    new_item, size_t    slot )

Set an item in the array at location <slot>. Returns -1 if <slot> is not in range, else returns 0. Definition at line 118 of file Array_Base.cpp. References array_, and in_range. { if (this->in_range (slot)) { this->array_[slot] = new_item; return 0; } else return -1; }

template<class T> int ACE_Array_Base< T >::size (  size_t    new_size )

Changes the size of the array to match <new_size>. It copies the old contents into the new array. Return -1 on failure. Definition at line 176 of file Array_Base.cpp. References cur_size_, and max_size. { int r = this->max_size (new_size); if (r != 0) return r; this->cur_size_ = new_size; return 0; }

template<class T> ACE_INLINE size_t ACE_Array_Base< T >::size (  void    )  const

Returns the <cur_size_> of the array. Reimplemented in ACE_Vector. Definition at line 16 of file Array_Base.inl. References cur_size_. Referenced by ACE_Array_Base, operator=, ACE_Array::operator==, ACE_Vector::push_back, and ACE_Vector::resize. { return this->cur_size_; }

---

Friends And Related Function Documentation

template<class T> friend class ACE_Array_Iterator< T > [friend]

Definition at line 147 of file Array_Base.h.

---

Member Data Documentation

template<class T> ACE_Allocator* ACE_Array_Base::allocator_ [private]

Allocation strategy of the ACE_Array_Base. Definition at line 145 of file Array_Base.h. Referenced by ACE_Array_Base.

template<class T> T* ACE_Array_Base::array_ [private]

Pointer to the array's storage buffer. Definition at line 142 of file Array_Base.h. Referenced by ACE_Array_Base, get, max_size, operator=, operator[], and set.

template<class T> size_t ACE_Array_Base::cur_size_ [private]

Current size of the array. This starts out being == to <max_size_>. However, if we are assigned a smaller array, then <cur_size_> will become less than <max_size_>. The purpose of keeping track of both sizes is to avoid reallocating memory if we don't have to. Definition at line 139 of file Array_Base.h. Referenced by in_range, max_size, operator=, and size.

template<class T> size_t ACE_Array_Base::max_size_ [private]

Maximum size of the array, i.e., the total number of <T> elements in <array_>. Definition at line 130 of file Array_Base.h. Referenced by max_size, and operator=.

---

The documentation for this class was generated from the following files:

• Array_Base.h
• Array_Base.cpp
• Array_Base.inl

---