Cpl::Container::Map< ITEM > Class Template Reference

This template class implements an Map using an AVL Binary tree (i.e. More...

Detailed Description

template<class ITEM>
class Cpl::Container::Map< ITEM >

This template class implements an Map using an AVL Binary tree (i.e.

a sorted list with fast searches, inserts, and deletes).

Template ARGS: ITEM - Data type of the object stored in the Map. 'ITEM' must be a sub-class of the Cpl::Container::MapItem base class.

#include <Map.h>

Inheritance diagram for Cpl::Container::Map< ITEM >:

Public Member Functions
	Map () noexcept
	Constructor.
	Map (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	This is a special constructor for when the Map is statically declared (i.e.
Operations to manage items in the Map
bool	insert (ITEM &node)
	Inserts an item into the tree.
ITEM *	remove (const Key &keyOfItemToDelete)
	Removes the node (if it exists) that has the matching key.
bool	removeItem (ITEM &node)
	Removes the specified item from the tree.
ITEM *	find (const Key &keyToFind) const
	Searches for a item with a matching key.
bool	isInMap (ITEM &node) const
	Returns true if the specified item is in the map; else false is returned.
ITEM *	first () const
	Returns the first item in the tree. Returns 0 if tree is empty.
ITEM *	last () const
	Returns the last item in the tree. Returns 0 if tree is empty.
ITEM *	next (ITEM &current) const
	Returns the next item in the tree. Returns 0 if at the end-of-tree.
ITEM *	previous (ITEM &current) const
	Returns the previous item in the tree. Returns 0 if at the start-of-tree.
ITEM *	getFirst ()
	Removes the first item in the list.
ITEM *	getLast ()
	Removes the last item in the list.
Operations on the Map itself
void	move (Map< ITEM > &dst)
	Moves the content of the this Map to the specified Map.
void	clearTheMap ()
	Empties the Map.

Constructor & Destructor Documentation

Map() [1/2]

template<class ITEM >

Cpl::Container::Map< ITEM >::Map ( )

inlinenoexcept

Constructor.

Map() [2/2]

template<class ITEM >

Cpl::Container::Map< ITEM >::Map

(

const char *

ignoreThisParameter_usedToCreateAUniqueConstructor

)

This is a special constructor for when the Map is statically declared (i.e.

it is initialized as part of C++ startup BEFORE main() is executed. C/C++ guarantees that all statically declared data will be initialized to zero by default (see r.8.4 in C++ Programming Language, Second Edition). Since the head & tail pointers are initialized to zero - then the C/C++ default is OK. Why do I care about all this? Because if you attempt to build static list(s), then the order of when the Map is constructed vs. when the static elements are added to the list is a problem! To avoid this problem, a alternate constructor that does NOT initialize the head & tail pointers is provided. It assumes that the pointers are already set zero because the list is "static". Whew!

Member Function Documentation

clearTheMap()

template<class ITEM >

void Cpl::Container::Map< ITEM >::clearTheMap

(

)

Empties the Map.

All references to the item(s) in the Map are lost.

find()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::find

(

const Key &

keyToFind

)

const

Searches for a item with a matching key.

Returns the node that matches, else 0.

first()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::first

(

)

const

Returns the first item in the tree. Returns 0 if tree is empty.

getFirst()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::getFirst

(

)

Removes the first item in the list.

Returns 0 if the list is empty.

getLast()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::getLast

(

)

Removes the last item in the list.

Returns 0 if the list is empty.

insert()

template<class ITEM >

bool Cpl::Container::Map< ITEM >::insert

(

ITEM &

node

)

Inserts an item into the tree.

If the node is successfully inserted, then the method return true. If the tree already contains a node with the same key, then the method returns false.

isInMap()

template<class ITEM >

bool Cpl::Container::Map< ITEM >::isInMap

(

ITEM &

node

)

const

Returns true if the specified item is in the map; else false is returned.

last()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::last

(

)

const

Returns the last item in the tree. Returns 0 if tree is empty.

move()

template<class ITEM >

void Cpl::Container::Map< ITEM >::move

(

Map< ITEM > &

dst

)

Moves the content of the this Map to the specified Map.

next()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::next

(

ITEM &

current

)

const

Returns the next item in the tree. Returns 0 if at the end-of-tree.

previous()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::previous

(

ITEM &

current

)

const

Returns the previous item in the tree. Returns 0 if at the start-of-tree.

remove()

template<class ITEM >

ITEM * Cpl::Container::Map< ITEM >::remove

(

const Key &

keyOfItemToDelete

)

Removes the node (if it exists) that has the matching key.

Returns the node removed from the tree or 0 if no key match was found.

removeItem()

template<class ITEM >

bool Cpl::Container::Map< ITEM >::removeItem

(

ITEM &

node

)

Removes the specified item from the tree.

Returns true when the node was found and removed; else false is returned (i.e. node not exists in the tree).

---

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

• Cpl/Container/Map.h