Implement a simple unordered set of {T} with maximum set at creation time. More...

#include <Containers_T.h>

Collaboration diagram for ACE_Bounded_Set< T >:

Classes
struct	Search_Structure

Public Types
enum	{ DEFAULT_SIZE = 10 }

typedef ACE_Bounded_Set_Iterator< T >	ITERATOR

Public Member Functions
	ACE_Bounded_Set (void)
	Construct a Bounded_Set using the default size. More...

	ACE_Bounded_Set (size_t size)
	Construct a Bounded_Set with the provided sizeB. More...

	ACE_Bounded_Set (const ACE_Bounded_Set< T > &)
	Construct a Bounded_Set that is a copy of the provides Bounded_Set. More...

void	operator= (const ACE_Bounded_Set< T > &)
	Assignment operator. More...

	~ACE_Bounded_Set (void)
	Destructor. More...

int	is_empty (void) const
	Returns 1 if the container is empty, otherwise returns 0. More...

int	is_full (void) const
	Returns 1 if the container is full, otherwise returns 0. More...

int	insert (const T &new_item)
	Inserts a new element unique to the set. More...

int	remove (const T &item)
	Finds the specified element and removes it from the set. More...

int	find (const T &item) const
	Finds if item occurs in the set. Returns 0 if finds, else -1. More...

size_t	size (void) const
	Size of the set. More...

void	dump (void) const
	Dump the state of an object. More...

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Private Attributes
Search_Structure *	search_structure_
	Holds the contents of the set. More...

size_t	cur_size_
	Current size of the set. More...

size_t	max_size_
	Maximum size of the set. More...

Friends
class	ACE_Bounded_Set_Iterator< T >

Detailed Description

template<class T>
class ACE_Bounded_Set< T >

Implement a simple unordered set of {T} with maximum set at creation time.

This implementation of an unordered set uses a Bounded array. This implementation does not allow duplicates. It provides linear insert/remove/find operations. Insertion/removal does not invalidate iterators, but caution should be taken to ensure expected behavior. Once initialized, the object has a maximum size which can only be increased by the assignment of another larger Bounded_Set.

Requirements and Performance Characteristics

Internal Structure Bounded array which can grow via assignment
Duplicates allowed? No
Random access allowed? No
Search speed Linear
Insert/replace speed Linear
Iterator still valid after change to container? Yes
Frees memory for removed elements? No
Items inserted by Value
Requirements for contained type
1. Default constructor
2. Copy constructor
3. operator=
4. operator==

Member Typedef Documentation

template<class T >

typedef ACE_Bounded_Set_Iterator<T> ACE_Bounded_Set< T >::ITERATOR

Member Enumeration Documentation

template<class T >

anonymous enum

Enumerator
DEFAULT_SIZE

Constructor & Destructor Documentation

template<class T >

ACE_Bounded_Set< T >::ACE_Bounded_Set ( void )

Construct a Bounded_Set using the default size.

The default constructor initializes the Bounded_Set to a maximum size specified by the DEFAULT_SIZE.

template<class T >

ACE_Bounded_Set< T >::ACE_Bounded_Set ( size_t size )

Construct a Bounded_Set with the provided sizeB.

Initialize the Bounded_Set to have a maximum size equal to the size parameter specified.

template<class T >

ACE_Bounded_Set< T >::ACE_Bounded_Set ( const ACE_Bounded_Set< T > & bs )

Construct a Bounded_Set that is a copy of the provides Bounded_Set.

Initialize the Bounded_Set to be a copy of the Bounded_Set parameter.

template<class T >

ACE_Bounded_Set< T >::~ACE_Bounded_Set ( void )

Destructor.

Clean up the underlying dynamically allocated memory that is used by the Bounded_Set.

Member Function Documentation

template<class T >

void ACE_Bounded_Set< T >::dump ( void ) const

Dump the state of an object.

template<class T >

int ACE_Bounded_Set< T >::find ( const T & item ) const

Finds if item occurs in the set. Returns 0 if finds, else -1.

find preforms a linear search for {item} and returns 0 on successful find and -1 otherwise.

template<class T >

int ACE_Bounded_Set< T >::insert ( const T & new_item )

Inserts a new element unique to the set.

Insert new_item into the set (doesn't allow duplicates) in linear time. Returns -1 if failures occur, 1 if item is already present, else 0.

template<class T >

int ACE_Bounded_Set< T >::is_empty ( void ) const

inline

Returns 1 if the container is empty, otherwise returns 0.

A constant time check is performed to determine if the Bounded_Set is empty.

template<class T >

int ACE_Bounded_Set< T >::is_full ( void ) const

inline

Returns 1 if the container is full, otherwise returns 0.

Performs a constant time check to determine if the Bounded_Set is at capacity.

template<class T >

void ACE_Bounded_Set< T >::operator= ( const ACE_Bounded_Set< T > & bs )

Assignment operator.

The assignment will make a deep copy of the Bounded_Set provided. If the rhs has more elements than the capacity of the lhs, then the lhs will be deleted and reallocated to accomadate the larger number of elements.

template<class T >

int ACE_Bounded_Set< T >::remove ( const T & item )

Finds the specified element and removes it from the set.

Remove first occurrence of item from the set. Returns 0 if it removes the item, -1 if it can't find the item, and -1 if a failure occurs. The linear remove operation does not reclaim the memory associated with the removed item.

template<class T >

size_t ACE_Bounded_Set< T >::size ( void ) const

Size of the set.

Returns a size_t representing the current size of the set.

Friends And Related Function Documentation

template<class T >

friend class ACE_Bounded_Set_Iterator< T >

friend

Member Data Documentation

template<class T >

ACE_Bounded_Set< T >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

template<class T >

size_t ACE_Bounded_Set< T >::cur_size_

private

Current size of the set.

template<class T >

size_t ACE_Bounded_Set< T >::max_size_

private

Maximum size of the set.

template<class T >

Search_Structure* ACE_Bounded_Set< T >::search_structure_

private

Holds the contents of the set.

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

Classes

Public Types

Public Member Functions

Public Attributes

Private Attributes

Friends

Detailed Description

template<class T> class ACE_Bounded_Set< T >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class T>
class ACE_Bounded_Set< T >