Index of Topics

- A -

alloc_mult_size() [String]
alloc_size_increment() [strstreambuf]
allocate() [streambuf]
append() [WCIsvSList<Type>,WCIsvDList<Type>]
append() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
append() [WCPtrOrderedVector<Type>]
append() [WCPtrSList<Type>,WCPtrDList<Type>]
append() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
append() [WCValOrderedVector<Type>]
append() [WCValSList<Type>,WCValDList<Type>]
append() [WCValSListIter<Type>,WCValDListIter<Type>]
attach() [filebuf]
attach() [fstreambase]

- B -

bad() [ios]
base() [streambuf]
bitalloc() [ios]
bitHash() [WCPtrHashDict<Key,Value>]
bitHash() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
bitHash() [WCValHashDict<Key,Value>]
bitHash() [WCValHashTable<Type>,WCValHashSet<Type>]
blen() [streambuf]
buckets() [WCPtrHashDict<Key,Value>]
buckets() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
buckets() [WCValHashDict<Key,Value>]
buckets() [WCValHashTable<Type>,WCValHashSet<Type>]

- C -

cerr
cin
clear() [ios]
clear() [WCIsvSList<Type>,WCIsvDList<Type>]
clear() [WCPtrHashDict<Key,Value>]
clear() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
clear() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
clear() [WCPtrSkipListDict<Key,Value>]
clear() [WCPtrSList<Type>,WCPtrDList<Type>]
clear() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
clear() [WCPtrVector<Type>]
clear() [WCQueue<Type,FType>]
clear() [WCStack<Type,FType>]
clear() [WCValHashDict<Key,Value>]
clear() [WCValHashTable<Type>,WCValHashSet<Type>]
clear() [WCValSkipList<Type>,WCValSkipListSet<Type>]
clear() [WCValSkipListDict<Key,Value>]
clear() [WCValSList<Type>,WCValDList<Type>]
clear() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
clear() [WCValVector<Type>]
clearAndDestroy() [WCIsvSList<Type>,WCIsvDList<Type>]
clearAndDestroy() [WCPtrHashDict<Key,Value>]
clearAndDestroy() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
clearAndDestroy() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
clearAndDestroy() [WCPtrSkipListDict<Key,Value>]
clearAndDestroy() [WCPtrSList<Type>,WCPtrDList<Type>]
clearAndDestroy() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
clearAndDestroy() [WCPtrVector<Type>]
clearAndDestroy() [WCValSList<Type>,WCValDList<Type>]
clog
close() [filebuf]
close() [fstreambase]
Common Types
Complex abs() [Complex]
Complex acos() [Complex]
Complex acosh() [Complex]
Complex arg() [Complex]
Complex asin() [Complex]
Complex asinh() [Complex]
Complex atan() [Complex]
Complex atanh() [Complex]
Complex Class
Complex Class Description
Complex conj() [Complex]
Complex cos() [Complex]
Complex cosh() [Complex]
Complex exp() [Complex]
Complex imag() [Complex]
Complex log() [Complex]
Complex log10() [Complex]
Complex norm() [Complex]
Complex operator !=() [Complex]
Complex operator *() [Complex]
Complex operator +() [Complex]
Complex operator -() [Complex]
Complex operator /() [Complex]
Complex operator <<() [Complex]
Complex operator ==() [Complex]
Complex operator >>() [Complex]
Complex polar() [Complex]
Complex pow() [Complex]
Complex real() [Complex]
Complex sin() [Complex]
Complex sinh() [Complex]
Complex sqrt() [Complex]
Complex tan() [Complex]
Complex tanh() [Complex]
Complex() [Complex]
Container Allocators and Deallocators
Container Exception Classes
container() [WCIsvConstSListIter<Type>,WCIsvConstDListIter<Type>]
container() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
container() [WCPtrConstSListIter<Type>,WCPtrConstDListIter<Type>]
container() [WCPtrHashDictIter<Key,Value>]
container() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]
container() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
container() [WCValConstSListIter<Type>,WCValConstDListIter<Type>]
container() [WCValHashDictIter<Key,Value>]
container() [WCValHashSetIter<Type>,WCValHashTableIter<Type>]
container() [WCValSListIter<Type>,WCValDListIter<Type>]
contains() [WCIsvSList<Type>,WCIsvDList<Type>]
contains() [WCPtrHashDict<Key,Value>]
contains() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
contains() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
contains() [WCPtrSkipListDict<Key,Value>]
contains() [WCPtrSList<Type>,WCPtrDList<Type>]
contains() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
contains() [WCValHashDict<Key,Value>]
contains() [WCValHashTable<Type>,WCValHashSet<Type>]
contains() [WCValSkipList<Type>,WCValSkipListSet<Type>]
contains() [WCValSkipListDict<Key,Value>]
contains() [WCValSList<Type>,WCValDList<Type>]
contains() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
cout
current() [WCIsvConstSListIter<Type>,WCIsvConstDListIter<Type>]
current() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
current() [WCPtrConstSListIter<Type>,WCPtrConstDListIter<Type>]
current() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]
current() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
current() [WCValConstSListIter<Type>,WCValConstDListIter<Type>]
current() [WCValHashSetIter<Type>,WCValHashTableIter<Type>]
current() [WCValSListIter<Type>,WCValDListIter<Type>]

- D -

dbp() [streambuf]
do_sgetn() [streambuf]
do_sputn() [streambuf]
doallocate() [streambuf]
doallocate() [strstreambuf]

- E -

eatwhite() [istream]
eback() [streambuf]
ebuf() [streambuf]
egptr() [streambuf]
entries() [WCIsvSList<Type>,WCIsvDList<Type>]
entries() [WCPtrHashDict<Key,Value>]
entries() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
entries() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
entries() [WCPtrSkipListDict<Key,Value>]
entries() [WCPtrSList<Type>,WCPtrDList<Type>]
entries() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
entries() [WCQueue<Type,FType>]
entries() [WCStack<Type,FType>]
entries() [WCValHashDict<Key,Value>]
entries() [WCValHashTable<Type>,WCValHashSet<Type>]
entries() [WCValSkipList<Type>,WCValSkipListSet<Type>]
entries() [WCValSkipListDict<Key,Value>]
entries() [WCValSList<Type>,WCValDList<Type>]
entries() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
eof() [ios]
epptr() [streambuf]
exceptions() [ios]
exceptions() [WCExcept]
exceptions() [WCIterExcept]

- F -

fail() [ios]
fd() [filebuf]
fd() [fstreambase]
filebuf Class Description
filebuf() [filebuf]
fill() [ios]
find() [WCIsvSList<Type>,WCIsvDList<Type>]
find() [WCPtrHashDict<Key,Value>]
find() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
find() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
find() [WCPtrSkipListDict<Key,Value>]
find() [WCPtrSList<Type>,WCPtrDList<Type>]
find() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
find() [WCValHashDict<Key,Value>]
find() [WCValHashTable<Type>,WCValHashSet<Type>]
find() [WCValSkipList<Type>,WCValSkipListSet<Type>]
find() [WCValSkipListDict<Key,Value>]
find() [WCValSList<Type>,WCValDList<Type>]
find() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
findKeyAndValue() [WCPtrHashDict<Key,Value>]
findKeyAndValue() [WCPtrSkipListDict<Key,Value>]
findKeyAndValue() [WCValHashDict<Key,Value>]
findKeyAndValue() [WCValSkipListDict<Key,Value>]
findLast() [WCIsvSList<Type>,WCIsvDList<Type>]
findLast() [WCPtrSList<Type>,WCPtrDList<Type>]
findLast() [WCValSList<Type>,WCValDList<Type>]
first() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
first() [WCQueue<Type,FType>]
first() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
flags() [ios]
flush() [ostream]
fmtflags [ios]
forAll() [WCIsvSList<Type>,WCIsvDList<Type>]
forAll() [WCPtrHashDict<Key,Value>]
forAll() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
forAll() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
forAll() [WCPtrSkipListDict<Key,Value>]
forAll() [WCPtrSList<Type>,WCPtrDList<Type>]
forAll() [WCValHashDict<Key,Value>]
forAll() [WCValHashTable<Type>,WCValHashSet<Type>]
forAll() [WCValSkipList<Type>,WCValSkipListSet<Type>]
forAll() [WCValSkipListDict<Key,Value>]
forAll() [WCValSList<Type>,WCValDList<Type>]
Formatted Input:  Extractors
Formatted Output:  Inserters
freeze() [strstreambuf]
fstream Class Description
fstream() [fstream]
fstreambase Class Description
fstreambase() [fstreambase]

- G -

gbump() [streambuf]
gcount() [istream]
get() [istream]
get() [WCIsvSList<Type>,WCIsvDList<Type>]
get() [WCPtrSList<Type>,WCPtrDList<Type>]
get() [WCQueue<Type,FType>]
get() [WCValSList<Type>,WCValDList<Type>]
get_at() [String]
getline() [istream]
good() [ios]
gptr() [streambuf]

- H -

Hash Containers
Hash Iterators
Header Files

- I -

ifstream Class Description
ifstream() [ifstream]
ignore() [istream]
imag() [Complex]
in_avail() [streambuf]
index() [String]
index() [WCIsvSList<Type>,WCIsvDList<Type>]
index() [WCPtrSList<Type>,WCPtrDList<Type>]
index() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
index() [WCValSList<Type>,WCValDList<Type>]
index() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
init() [ios]
Input/Output Classes
insert() [WCIsvDListIter<Type>]
insert() [WCIsvSList<Type>,WCIsvDList<Type>]
insert() [WCPtrDListIter<Type>]
insert() [WCPtrHashDict<Key,Value>]
insert() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
insert() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
insert() [WCPtrSkipListDict<Key,Value>]
insert() [WCPtrSList<Type>,WCPtrDList<Type>]
insert() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
insert() [WCQueue<Type,FType>]
insert() [WCValDListIter<Type>]
insert() [WCValHashDict<Key,Value>]
insert() [WCValHashTable<Type>,WCValHashSet<Type>]
insert() [WCValSkipList<Type>,WCValSkipListSet<Type>]
insert() [WCValSkipListDict<Key,Value>]
insert() [WCValSList<Type>,WCValDList<Type>]
insert() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
insertAt() [WCPtrOrderedVector<Type>]
insertAt() [WCValOrderedVector<Type>]
ios Class Description
ios() [ios]
iostate [ios]
iostream Class Description
iostream() [iostream]
ipfx() [istream]
is_open() [filebuf]
is_open() [fstreambase]
isEmpty() [WCIsvSList<Type>,WCIsvDList<Type>]
isEmpty() [WCPtrHashDict<Key,Value>]
isEmpty() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
isEmpty() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
isEmpty() [WCPtrSkipListDict<Key,Value>]
isEmpty() [WCPtrSList<Type>,WCPtrDList<Type>]
isEmpty() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
isEmpty() [WCQueue<Type,FType>]
isEmpty() [WCStack<Type,FType>]
isEmpty() [WCValHashDict<Key,Value>]
isEmpty() [WCValHashTable<Type>,WCValHashSet<Type>]
isEmpty() [WCValSkipList<Type>,WCValSkipListSet<Type>]
isEmpty() [WCValSkipListDict<Key,Value>]
isEmpty() [WCValSList<Type>,WCValDList<Type>]
isEmpty() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
isfx() [istream]
istream Class Description
istream Input
istream() [istream]
istrstream Class Description
istrstream() [istrstream]
iword() [ios]

- K -

key() [WCPtrHashDictIter<Key,Value>]
key() [WCValHashDictIter<Key,Value>]

- L -

last() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
last() [WCQueue<Type,FType>]
last() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
length() [String]
length() [WCPtrVector<Type>]
length() [WCValVector<Type>]
Library Functions and Types
List Containers
List Iterators
lower() [String]

- M -

manipulator dec() [manipulator]
manipulator endl() [manipulator]
manipulator ends() [manipulator]
manipulator flush() [manipulator]
manipulator hex() [manipulator]
manipulator oct() [manipulator]
manipulator resetiosflags() [manipulator]
manipulator setbase() [manipulator]
manipulator setfill() [manipulator]
manipulator setiosflags() [manipulator]
manipulator setprecision() [manipulator]
manipulator setw() [manipulator]
manipulator setwidth() [manipulator]
manipulator ws() [manipulator]
Manipulators [manipulator]
match() [String]

- O -

occurencesOf() [WCPtrHashTable<Type>]
occurencesOf() [WCValHashTable<Type>]
occurrencesOf() [WCPtrSkipList<Type>]
occurrencesOf() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
occurrencesOf() [WCValSkipList<Type>]
occurrencesOf() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
ofstream Class Description
ofstream() [ofstream]
open() [filebuf]
open() [fstream]
open() [fstreambase]
open() [ifstream]
open() [ofstream]
openmode [ios]
openprot [filebuf]
operator !() [ios]
operator !() [String]
operator ()() [String]
operator ()() [WCIsvConstSListIter<Type>,WCIsvConstDListIter<Type>]
operator ()() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
operator ()() [WCPtrConstSListIter<Type>,WCPtrConstDListIter<Type>]
operator ()() [WCPtrHashDictIter<Key,Value>]
operator ()() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]
operator ()() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
operator ()() [WCValConstSListIter<Type>,WCValConstDListIter<Type>]
operator ()() [WCValHashDictIter<Key,Value>]
operator ()() [WCValHashSetIter<Type>,WCValHashTableIter<Type>]
operator ()() [WCValSListIter<Type>,WCValDListIter<Type>]
operator *=() [Complex]
operator +() [Complex]
operator ++() [WCIsvConstSListIter<Type>,WCIsvConstDListIter<Type>]
operator ++() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
operator ++() [WCPtrConstSListIter<Type>,WCPtrConstDListIter<Type>]
operator ++() [WCPtrHashDictIter<Key,Value>]
operator ++() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]
operator ++() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
operator ++() [WCValConstSListIter<Type>,WCValConstDListIter<Type>]
operator ++() [WCValHashDictIter<Key,Value>]
operator ++() [WCValHashSetIter<Type>,WCValHashTableIter<Type>]
operator ++() [WCValSListIter<Type>,WCValDListIter<Type>]
operator +=() [Complex]
operator +=() [String]
operator +=() [WCIsvConstSListIter<Type>,WCIsvConstDListIter<Type>]
operator +=() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
operator +=() [WCPtrConstSListIter<Type>,WCPtrConstDListIter<Type>]
operator +=() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
operator +=() [WCValConstSListIter<Type>,WCValConstDListIter<Type>]
operator +=() [WCValSListIter<Type>,WCValDListIter<Type>]
operator -() [Complex]
operator --() [WCIsvConstDListIter<Type>]
operator --() [WCIsvDListIter<Type>]
operator --() [WCPtrConstDListIter<Type>]
operator --() [WCPtrDListIter<Type>]
operator --() [WCValConstDListIter<Type>]
operator --() [WCValDListIter<Type>]
operator -=() [Complex]
operator -=() [WCIsvConstDListIter<Type>]
operator -=() [WCIsvDListIter<Type>]
operator -=() [WCPtrConstDListIter<Type>]
operator -=() [WCPtrDListIter<Type>]
operator -=() [WCValConstDListIter<Type>]
operator -=() [WCValDListIter<Type>]
operator /=() [Complex]
operator <<() [ostream]
operator =() [Complex]
operator =() [iostream]
operator =() [istream]
operator =() [ostream]
operator =() [String]
operator =() [WCIsvSList<Type>,WCIsvDList<Type>]
operator =() [WCPtrHashDict<Key,Value>]
operator =() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
operator =() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
operator =() [WCPtrSkipListDict<Key,Value>]
operator =() [WCPtrSList<Type>,WCPtrDList<Type>]
operator =() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
operator =() [WCPtrVector<Type>]
operator =() [WCValHashDict<Key,Value>]
operator =() [WCValHashTable<Type>,WCValHashSet<Type>]
operator =() [WCValSkipList<Type>,WCValSkipListSet<Type>]
operator =() [WCValSkipListDict<Key,Value>]
operator =() [WCValSList<Type>,WCValDList<Type>]
operator =() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
operator =() [WCValVector<Type>]
operator ==() [WCIsvSList<Type>,WCIsvDList<Type>]
operator ==() [WCPtrHashDict<Key,Value>]
operator ==() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
operator ==() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
operator ==() [WCPtrSkipListDict<Key,Value>]
operator ==() [WCPtrSList<Type>,WCPtrDList<Type>]
operator ==() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
operator ==() [WCPtrVector<Type>]
operator ==() [WCValHashDict<Key,Value>]
operator ==() [WCValHashTable<Type>,WCValHashSet<Type>]
operator ==() [WCValSkipList<Type>,WCValSkipListSet<Type>]
operator ==() [WCValSkipListDict<Key,Value>]
operator ==() [WCValSList<Type>,WCValDList<Type>]
operator ==() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
operator ==() [WCValVector<Type>]
operator >>() [istream]
operator []() [String]
operator []() [WCPtrHashDict<Key,Value>]
operator []() [WCPtrSkipListDict<Key,Value>]
operator []() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
operator []() [WCPtrVector<Type>]
operator []() [WCValHashDict<Key,Value>]
operator []() [WCValSkipListDict<Key,Value>]
operator []() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
operator []() [WCValVector<Type>]
operator char const *() [String]
operator char() [String]
operator void *() [ios]
opfx() [ostream]
osfx() [ostream]
ostream Class Description
ostream Output
ostream() [ostream]
ostrstream Class Description
ostrstream() [ostrstream]
out_waiting() [streambuf]
overflow() [filebuf]
overflow() [stdiobuf]
overflow() [streambuf]
overflow() [strstreambuf]

- P -

pbackfail() [filebuf]
pbackfail() [streambuf]
pbase() [streambuf]
pbump() [streambuf]
pcount() [ostrstream]
peek() [istream]
pop() [WCStack<Type,FType>]
pptr() [streambuf]
precision() [ios]
Predefined Objects
prepend() [WCPtrOrderedVector<Type>]
prepend() [WCValOrderedVector<Type>]
push() [WCStack<Type,FType>]
put() [ostream]
put_at() [String]
putback() [istream]
pword() [ios]

- Q -

Queue Container

- R -

rdbuf() [fstreambase]
rdbuf() [ios]
rdbuf() [strstreambase]
rdstate() [ios]
read() [istream]
real() [Complex]
remove() [WCPtrHashDict<Key,Value>]
remove() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
remove() [WCPtrSkipList<Type>,WCPtrSkipListSet<Type>]
remove() [WCPtrSkipListDict<Key,Value>]
remove() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
remove() [WCValHashDict<Key,Value>]
remove() [WCValHashTable<Type>,WCValHashSet<Type>]
remove() [WCValSkipList<Type>,WCValSkipListSet<Type>]
remove() [WCValSkipListDict<Key,Value>]
remove() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
removeAll() [WCPtrHashTable<Type>]
removeAll() [WCPtrSkipList<Type>]
removeAll() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
removeAll() [WCValHashTable<Type>]
removeAll() [WCValSkipList<Type>]
removeAll() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
removeAt() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
removeAt() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
removeFirst() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
removeFirst() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
removeLast() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
removeLast() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
reset() [WCIsvConstSListIter<Type>,WCIsvConstDListIter<Type>]
reset() [WCIsvSListIter<Type>,WCIsvDListIter<Type>]
reset() [WCPtrConstSListIter<Type>,WCPtrConstDListIter<Type>]
reset() [WCPtrHashDictIter<Key,Value>]
reset() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]
reset() [WCPtrSListIter<Type>,WCPtrDListIter<Type>]
reset() [WCValConstSListIter<Type>,WCValConstDListIter<Type>]
reset() [WCValHashDictIter<Key,Value>]
reset() [WCValHashSetIter<Type>,WCValHashTableIter<Type>]
reset() [WCValSListIter<Type>,WCValDListIter<Type>]
resize() [WCPtrHashDict<Key,Value>]
resize() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]
resize() [WCPtrSortedVector<Type>,WCPtrOrderedVector<Type>]
resize() [WCPtrVector<Type>]
resize() [WCValHashDict<Key,Value>]
resize() [WCValHashTable<Type>,WCValHashSet<Type>]
resize() [WCValSortedVector<Type>,WCValOrderedVector<Type>]
resize() [WCValVector<Type>]

- S -

sbumpc() [streambuf]
seekdir [ios]
seekg() [istream]
seekoff() [filebuf]
seekoff() [streambuf]
seekoff() [strstreambuf]
seekp() [ostream]
seekpos() [streambuf]
setb() [streambuf]
setbuf() [filebuf]
setbuf() [fstreambase]
setbuf() [streambuf]
setbuf() [strstreambuf]
setf() [ios]
setg() [streambuf]
setp() [streambuf]
setstate() [ios]
sgetc() [streambuf]
sgetchar() [streambuf]
sgetn() [streambuf]
Skip List Containers
snextc() [streambuf]
speekc() [streambuf]
sputbackc() [streambuf]
sputc() [streambuf]
sputn() [streambuf]
Stack Container
stdiobuf Class Description
stdiobuf() [stdiobuf]
stossc() [streambuf]
str() [ostrstream]
str() [strstream]
str() [strstreambuf]
streambuf Class Description
streambuf() [streambuf]
String Class
String Class Description
String operator !=() [String]
String operator +() [String]
String operator <() [String]
String operator <<() [String]
String operator <=() [String]
String operator ==() [String]
String operator >() [String]
String operator >=() [String]
String operator >>() [String]
String valid() [String]
String() [String]
strstream Class Description
strstream() [strstream]
strstreambase Class Description
strstreambase() [strstreambase]
strstreambuf Class Description
strstreambuf() [strstreambuf]
sync() [filebuf]
sync() [istream]
sync() [stdiobuf]
sync() [streambuf]
sync() [strstreambuf]
sync_with_stdio() [ios]

- T -

tellg() [istream]
tellp() [ostream]
tie() [ios]
top() [WCStack<Type,FType>]

- U -

unbuffered() [streambuf]
underflow() [filebuf]
underflow() [stdiobuf]
underflow() [streambuf]
underflow() [strstreambuf]
Unformatted Input
Unformatted Output
unsetf() [ios]
upper() [String]

- V -

valid() [String]
value() [WCPtrHashDictIter<Key,Value>]
value() [WCValHashDictIter<Key,Value>]
Vector Containers

- W -

wc_state [WCExcept]
WCDLink Class Description
WCDLink() [WCDLink]
WCExcept Class Description
WCExcept() [WCExcept]
WCIsvConstDListIter() [WCIsvConstDListIter<Type>]
WCIsvConstSListIter() [WCIsvConstSListIter<Type>]
WCIsvConstSListIter<Type>, WCIsvConstDListIter<Type> Class Description
WCIsvDList() [WCIsvDList<Type>]
WCIsvDListIter() [WCIsvDListIter<Type>]
WCIsvSList() [WCIsvSList<Type>]
WCIsvSList<Type>, WCIsvDList<Type> Class Description
WCIsvSListIter() [WCIsvSListIter<Type>]
WCIsvSListIter<Type>, WCIsvDListIter<Type> Class Description
wciter_state [WCIterExcept]
WCIterExcept Class Description
WCIterExcept() [WCIterExcept]
WCPtrConstDListIter() [WCPtrConstDListIter<Type>]
WCPtrConstSListIter() [WCPtrConstSListIter<Type>]
WCPtrConstSListIter<Type>, WCPtrConstDListIter<Type> Class Description
WCPtrDList() [WCPtrDList<Type>]
WCPtrDListIter() [WCPtrDListIter<Type>]
WCPtrHashDict() [WCPtrHashDict<Key,Value>]
WCPtrHashDict<Key,Value> Class Description
WCPtrHashDictIter() [WCPtrHashDictIter<Key,Value>]
WCPtrHashDictIter<Key,Value> Class Description
WCPtrHashSet() [WCPtrHashSet<Type>]
WCPtrHashSetIter() [WCPtrHashSetIter<Type>]
WCPtrHashSetIter<Type>, WCPtrHashTableIter<Type> Class Description
WCPtrHashTable() [WCPtrHashTable<Type>]
WCPtrHashTable<Type>, WCPtrHashSet<Type> Class Description
WCPtrHashTableIter() [WCPtrHashTableIter<Type>]
WCPtrOrderedVector() [WCPtrOrderedVector<Type>]
WCPtrSkipList() [WCPtrSkipList<Type>]
WCPtrSkipList<Type>, WCPtrSkipListSet<Type> Class Description
WCPtrSkipListDict() [WCPtrSkipListDict<Key,Value>]
WCPtrSkipListDict<Key,Value> Class Description
WCPtrSkipListSet() [WCPtrSkipListSet<Type>]
WCPtrSList() [WCPtrSList<Type>]
WCPtrSList<Type>, WCPtrDList<Type> Class Description
WCPtrSListIter() [WCPtrSListIter<Type>]
WCPtrSListIter<Type>, WCPtrDListIter<Type> Class Description
WCPtrSortedVector() [WCPtrSortedVector<Type>]
WCPtrSortedVector<Type>, WCPtrOrderedVector<Type> Class Description
WCPtrVector() [WCPtrVector<Type>]
WCPtrVector<Type> Class Description
WCQueue() [WCQueue<Type,FType>]
WCQueue<Type,FType> Class Description
WCSLink Class Description
WCSLink() [WCSLink]
WCStack() [WCStack<Type,FType>]
WCStack<Type,FType> Class Description
WCValConstDListIter() [WCValConstDListIter<Type>]
WCValConstSListIter() [WCValConstSListIter<Type>]
WCValConstSListIter<Type>, WCValConstDListIter<Type> Class Description
WCValDList() [WCValDList<Type>]
WCValDListIter() [WCValDListIter<Type>]
WCValHashDict() [WCValHashDict<Key,Value>]
WCValHashDict<Key,Value> Class Description
WCValHashDictIter() [WCValHashDictIter<Key,Value>]
WCValHashDictIter<Key,Value> Class Description
WCValHashSet() [WCValHashSet<Type>]
WCValHashSetIter() [WCValHashSetIter<Type>]
WCValHashSetIter<Type>, WCValHashTableIter<Type> Class Description
WCValHashTable() [WCValHashTable<Type>]
WCValHashTable<Type>, WCValHashSet<Type> Class Description
WCValHashTableIter() [WCValHashTableIter<Type>]
WCValOrderedVector() [WCValOrderedVector<Type>]
WCValSkipList() [WCValSkipList<Type>]
WCValSkipList<Type>, WCValSkipListSet<Type> Class Description
WCValSkipListDict() [WCValSkipListDict<Key,Value>]
WCValSkipListDict<Key,Value> Class Description
WCValSkipListSet() [WCValSkipListSet<Type>]
WCValSList() [WCValSList<Type>]
WCValSList<Type>, WCValDList<Type> Class Description
WCValSListIter() [WCValSListIter<Type>]
WCValSListIter<Type>, WCValDListIter<Type> Class Description
WCValSortedVector() [WCValSortedVector<Type>]
WCValSortedVector<Type>, WCValOrderedVector<Type> Class Description
WCValVector() [WCValVector<Type>]
WCValVector<Type> Class Description
width() [ios]
write() [ostream]

- X -

xalloc() [ios]

-  -

Complex() [Complex]
filebuf() [filebuf]
fstream() [fstream]
fstreambase() [fstreambase]
ifstream() [ifstream]
ios() [ios]
iostream() [iostream]
istream() [istream]
istrstream() [istrstream]
ofstream() [ofstream]
ostream() [ostream]
ostrstream() [ostrstream]
stdiobuf() [stdiobuf]
streambuf() [streambuf]
String() [String]
strstream() [strstream]
strstreambase() [strstreambase]
strstreambuf() [strstreambuf]
WCDLink() [WCDLink]
WCExcept() [WCExcept]
WCIsvConstDListIter() [WCIsvConstDListIter<Type>]
WCIsvConstSListIter() [WCIsvConstSListIter<Type>]
WCIsvDList() [WCIsvDList<Type>]
WCIsvDListIter() [WCIsvDListIter<Type>]
WCIsvSList() [WCIsvSList<Type>]
WCIsvSListIter() [WCIsvSListIter<Type>]
WCIterExcept() [WCIterExcept]
WCPtrConstDListIter() [WCPtrConstDListIter<Type>]
WCPtrConstSListIter() [WCPtrConstSListIter<Type>]
WCPtrDList() [WCPtrDList<Type>]
WCPtrDListIter() [WCPtrDListIter<Type>]
WCPtrHashDict() [WCPtrHashDict<Key,Value>]
WCPtrHashDictIter() [WCPtrHashDictIter<Key,Value>]
WCPtrHashSet() [WCPtrHashSet<Type>]
WCPtrHashSetIter() [WCPtrHashSetIter<Type>]
WCPtrHashTable() [WCPtrHashTable<Type>]
WCPtrHashTableIter() [WCPtrHashTableIter<Type>]
WCPtrOrderedVector() [WCPtrOrderedVector<Type>]
WCPtrSkipList() [WCPtrSkipList<Type>]
WCPtrSkipListDict() [WCPtrSkipListDict<Key,Value>]
WCPtrSkipListSet() [WCPtrSkipListSet<Type>]
WCPtrSList() [WCPtrSList<Type>]
WCPtrSListIter() [WCPtrSListIter<Type>]
WCPtrSortedVector() [WCPtrSortedVector<Type>]
WCPtrVector() [WCPtrVector<Type>]
WCQueue() [WCQueue<Type,FType>]
WCSLink() [WCSLink]
WCStack() [WCStack<Type,FType>]
WCValConstDListIter() [WCValConstDListIter<Type>]
WCValConstSListIter() [WCValConstSListIter<Type>]
WCValDList() [WCValDList<Type>]
WCValDListIter() [WCValDListIter<Type>]
WCValHashDict() [WCValHashDict<Key,Value>]
WCValHashDictIter() [WCValHashDictIter<Key,Value>]
WCValHashSet() [WCValHashSet<Type>]
WCValHashSetIter() [WCValHashSetIter<Type>]
WCValHashTable() [WCValHashTable<Type>]
WCValHashTableIter() [WCValHashTableIter<Type>]
WCValOrderedVector() [WCValOrderedVector<Type>]
WCValSkipList() [WCValSkipList<Type>]
WCValSkipListDict() [WCValSkipListDict<Key,Value>]
WCValSkipListSet() [WCValSkipListSet<Type>]
WCValSList() [WCValSList<Type>]
WCValSListIter() [WCValSListIter<Type>]
WCValSortedVector() [WCValSortedVector<Type>]
WCValVector() [WCValVector<Type>]

Header Files

algorithm (algorith)

This header file defines the standard algorithm templates.

complex

This header file defines the std::complex class template and related function templates.  This template can be instantiated for the three different floating point types.  It can be used to represent complex numbers and to perform complex arithmetic.

complex.h

This header file defines the legacy Complex class.  This class is used to represent complex numbers and to perform complex arithmetic.  The class defined in this header is not the Standard C++ std::complex class template.

exception/exception.h (exceptio/exceptio.h)

This header file defines components to be used with the exception handling mechanism.  It defines the base class of the standard exception hierarchy.

functional (function)

This header file defines the standard functional templates.  This includes the functors and binders described by Standard C++.

fstream/fstream.h

This header file defines the filebuf, fstreambase, ifstream, ofstream, and fstream classes.  These classes are used to perform C++ file input and output operations.  The various class members are declared and inline member functions for the classes are defined.

generic.h

This header file is part of the macro support required to implement generic containers prior to the introduction of templates in the C++ language.  It is retained for backwards compatibility.

iomanip/iomanip.h

This header file defines the parameterized manipulators.

ios/ios.h

This header file defines the class ios that is used as a base of the other iostream classes.

iosfwd/iosfwd.h

This header file provides forward declarations of the iostream classes.  It should be used in cases where the full class definitions are not needed but where one still wants to declare pointers or references to iostream related objects.  Typically this occurs in a header for another class that wants to provide overloaded inserter or extractor operators.  By including iosfwd instead of iostream (for example), compilation speed can be improved because less material must be processed by the compiler.
Note that including iosfwd is the only appropriate way to forward declare the iostream classes.  Manually writing forward declarations is not recommended.

iostream/iostream.h

This header file (indirectly) defines the ios, istream, ostream, and iostream classes.   These classes form the basis of the C++ formatted input and output support.  The various class members are declared and inline member functions for the classes are defined.  The cin, cout, cerr, and clog predefined objects are declared along with the non-parameterized manipulators.

istream/istream.h

This header file defines class istream and class iostream.  It also defines their associated parameterless manipulators.

iterator

This header file defines several templates to facilitate the handling of iterators.  In particular, it defines the std::iterator_traits template as well as several other supporting iterator related templates.

limits

This header file defines the std::numeric_limits template and provides specializations of that template for each of the built-in types.
Note that this header is not directly related to the header limits.h from the C standard library (or to the C++ form of that header, climits).

list

This header file defines the std::list class template.  It provides a way to make a sequence of objects with efficient insert and erase operations.

map

This header file defines the std::map and std::multimap class templates.  They provide ways to associate keys to values.

memory

This header file defines the default allocator template, std::allocator, as well as several function templates for manipulating raw (uninitialized) memory regions.  In addition this header defines the std::auto_ptr template.
Note that the header memory.h is part of the Open Watcom C library and is unrelated to memory.

new/new.h

This header file provides declarations to be used with the intrinsic operator new and operator delete memory management functions.

numeric

This header file defines several standard algorithm templates pertaining to numerical computation.

ostream/ostream.h

This header file defines class ostream.  It also defines its associated parameterless manipulators.

set

This header file defines the std::set and std::multiset class templates.  They provide ways to make ordered collections of objects with efficient insert, erase, and find operations.

stdiobuf.h

This header file defines the stdiobuf class which provides the support for the C++ input and output operations to standard input, standard output, and standard error streams.

streambuf/streambuf.h (streambu/streambu.h)

This header file defines the streambuf class which provides the support for buffering of input and output operations.   This header file is automatically included by the iostream.h header file.

string

This header file defines the std::basic_string class template.  It also contains the type definitions for std::string and std::wstring.  In addition, this header contains specializations of the std::char_traits template for both characters and wide characters.

string.hpp

This header file defines the legacy String class.  The String class is used to manipulate character strings.  Note that the hpp extension is used to avoid colliding with the Standard C string.h header file.  The class defined in this header is not the Standard C++ std::string class.

strstream.h (strstrea.h)

This header files defines the strstreambuf, strstreambase, istrstream, ostrstream, and strstream classes.  These classes are used to perform C++ in-memory formatting.  The various class members are declared and inline member functions for the classes are defined.

vector

This header contains the std::vector class template.

wcdefs.h

This header file contains definitions used by the Open Watcom legacy container libraries.  If a container class needs any of these definitions, the file is automatically included.
Note that all headers having names that start with "wc" are related to the legacy container libraries.

wclbase.h

This header file defines the base classes which are used by the list containers.

wclcom.h

This header file defines the classes which are common to the list containers.

wclibase.h

This header file defines the base classes which are used by the list iterators.

wclist.h

This header file defines the list container classes.  The available list container classes are single and double linked versions of intrusive, value and pointer lists.

wclistit.h

This header file defines the iterator classes that correspond to the list containers.

wcqueue.h

This header file defines the queue class.  Entries in a queue class are accessed first in, first out.

wcstack.h

This header file defines the stack class.  Entries in a stack class are accessed last in, first out.

Common Types

Predefined Objects

cin

cout

cerr

clog

istream Input

Formatted Input:  Extractors

Unformatted Input

ostream Output

Formatted Output:  Inserters

Unformatted Output

Library Functions and Types

Declared:

This optional subsection specifies which header file contains the declaration for a class.  It is only found in sections describing class declarations.

Derived From:

This optional subsection shows the inheritance for a class.  It is only found in sections describing class declarations.

Derived By:

This optional subsection shows which classes inherit from this class.  It is only found in sections describing class declarations.

Synopsis:

This subsection gives the name of the header file that contains the declaration of the function.  This header file must be included in order to reference the function.
For class member functions, the protection associated with the function is indicated via the presence of one of the private, protected, or public keywords.

The full function prototype is specified.  Virtual class member functions are indicated via the presence of the virtual keyword in the function prototype.

Semantics:

This subsection is a description of the function.

Derived Implementation Protocol:

This optional subsection is present for virtual member functions.  It describes how derived implementations of the virtual member function should behave.

Default Implementation:

This optional subsection is present for virtual member functions.  It describes how the default implementation provided with the base class definition behaves.

Results:

This optional subsection describes the function's return value, if any, and the impact of a member function on its object's state.

See Also:

This optional subsection provides a list of related functions or classes.

Complex Class

Complex Class Description

Declared:

complex.h
The Complex class is used for the storage and manipulation of complex numbers, which are often represented by real and imaginary components (Cartesian coordinates), or by magnitude and angle (polar coordinates).   Each Complex object stores exactly one complex number.  A Complex object may be used in expressions in the same manner as floating-point values.

Public Member Functions

The following constructors and destructors are declared:

Complex();
Complex( Complex const & );
Complex( double, double = 0.0 );
~Complex();

The following arithmetic member functions are declared:

Complex &operator =( Complex const & );
Complex &operator =( double );
Complex &operator +=( Complex const & );
Complex &operator +=( double );
Complex &operator -=( Complex const & );
Complex &operator -=( double );
Complex &operator *=( Complex const & );
Complex &operator *=( double );
Complex &operator /=( Complex const & );
Complex &operator /=( double );
Complex operator +() const;
Complex operator -() const;
double imag() const;
double real() const;

Friend Functions

The following I/O Stream inserter and extractor friend functions are declared:

friend istream &operator >>( istream &, Complex & );
friend ostream &operator <<( ostream &, Complex const & );

Related Operators

The following operators are declared:

Complex operator  +( Complex const &, Complex const & );
Complex operator  +( Complex const &, double );
Complex operator  +( double         , Complex const & );
Complex operator  -( Complex const &, Complex const & );
Complex operator  -( Complex const &, double );
Complex operator  -( double         , Complex const & );
Complex operator  *( Complex const &, Complex const & );
Complex operator  *( Complex const &, double );
Complex operator  *( double         , Complex const & );
Complex operator  /( Complex const &, Complex const & );
Complex operator  /( Complex const &, double );
Complex operator  /( double         , Complex const & );
int     operator ==( Complex const &, Complex const & );
int     operator ==( Complex const &, double );
int     operator ==( double         , Complex const & );
int     operator !=( Complex const &, Complex const & );
int     operator !=( Complex const &, double );
int     operator !=( double         , Complex const & );

Related Functions

The following related functions are declared:

double  abs  ( Complex const & );
Complex acos ( Complex const & );
Complex acosh( Complex const & );
double  arg  ( Complex const & );
Complex asin ( Complex const & );
Complex asinh( Complex const & );
Complex atan ( Complex const & );
Complex atanh( Complex const & );
Complex conj ( Complex const & );
Complex cos  ( Complex const & );
Complex cosh ( Complex const & );
Complex exp  ( Complex const & );
double  imag ( Complex const & );
Complex log  ( Complex const & );
Complex log10( Complex const & );
double  norm ( Complex const & );
Complex polar( double         , double = 0 );
Complex pow  ( Complex const &, Complex const & );
Complex pow  ( Complex const &, double );
Complex pow  ( double         , Complex const & );
Complex pow  ( Complex const &, int );
double  real ( Complex const & );
Complex sin  ( Complex const & );
Complex sinh ( Complex const & );
Complex sqrt ( Complex const & );
Complex tan  ( Complex const & );
Complex tanh ( Complex const & );

Complex abs() [Complex]

Synopsis:

#include <complex.h>
double abs( Complex const &num );

Semantics:

The abs function computes the magnitude of num, which is equivalent to the length (magnitude) of the vector when the num is represented in polar coordinates.

Results:

The abs function returns the magnitude of num.

See Also:

arg, norm, polar

Complex acos() [Complex]

Synopsis:

#include <complex.h>
Complex acos( Complex const &num );

Semantics:

The acos function computes the arccosine of num.

Results:

The acos function returns the arccosine of num.

See Also:

asin, atan, cos

Complex acosh() [Complex]

Synopsis:

#include <complex.h>
Complex acosh( Complex const &num );

Semantics:

The acosh function computes the inverse hyperbolic cosine of num.

Results:

The acosh function returns the inverse hyperbolic cosine of num.

See Also:

asinh, atanh, cosh

Complex arg() [Complex]

Synopsis:

#include <complex.h>
double arg( Complex const &num );

Semantics:

The arg function computes the angle of the vector when the num is represented in polar coordinates.  The angle has the same sign as the real component of the num.  It is positive in the 1st and 2nd quadrants, and negative in the 3rd and 4th quadrants.

Results:

The arg function returns the angle of the vector when the num is represented in polar coordinates.

See Also:

abs, norm, polar

Complex asin() [Complex]

Synopsis:

#include <complex.h>
Complex asin( Complex const &num );

Semantics:

The asin function computes the arcsine of num.

Results:

The asin function returns the arcsine of num.

See Also:

acos, atan, sin

Complex asinh() [Complex]

Synopsis:

#include <complex.h>
Complex asinh( Complex const &num );

Semantics:

The asinh function computes the inverse hyperbolic sine of num.

Results:

The asinh function returns the inverse hyperbolic sine of num.

See Also:

acosh, atanh, sinh

Complex atan() [Complex]

Synopsis:

#include <complex.h>
Complex atan( Complex const &num );

Semantics:

The atan function computes the arctangent of num.

Results:

The atan function returns the arctangent of num.

See Also:

acos, asin, tan

Complex atanh() [Complex]

Synopsis:

#include <complex.h>
Complex atanh( Complex const &num );

Semantics:

The atanh function computes the inverse hyperbolic tangent of num.

Results:

The atanh function returns the inverse hyperbolic tangent of num.

See Also:

acosh, asinh, tanh

Complex() [Complex]

Synopsis:

#include <complex.h>
public:
Complex::Complex();

Semantics:

This form of the public Complex constructor creates a default Complex object with value zero for both the real and imaginary components.

Results:

This form of the public Complex constructor produces a default Complex object.

See Also:

~Complex, real, imag

Synopsis:

#include <complex.h>
public:
Complex::Complex( Complex const &num );

Semantics:

This form of the public Complex constructor creates a Complex object with the same value as num.

Results:

This form of the public Complex constructor produces a Complex object.

See Also:

~Complex, real, imag

Synopsis:

#include <complex.h>
public:
Complex::Complex( double real, double imag = 0.0 );

Semantics:

This form of the public Complex constructor creates a Complex object with the real component set to real and the imaginary component set to imag.  If no imaginary component is specified, imag takes the default value of zero.

Results:

This form of the public Complex constructor produces a Complex object.

See Also:

~Complex, real, imag

~Complex() [Complex]

Synopsis:

#include <complex.h>
public:
Complex::~Complex();

Semantics:

The public ~Complex destructor destroys the Complex object.  The call to the public ~Complex destructor is inserted implicitly by the compiler at the point where the Complex object goes out of scope.

Results:

The Complex object is destroyed.

See Also:

Complex

Complex conj() [Complex]

Synopsis:

#include <complex.h>
Complex conj( Complex const &num );

Semantics:

The conj function computes the conjugate of num.  The conjugate consists of the unchanged real component, and the negative of the imaginary component.

Results:

The conj function returns the conjugate of num.

Complex cos() [Complex]

Synopsis:

#include <complex.h>
Complex cos( Complex const &num );

Semantics:

The cos function computes the cosine of num.

Results:

The cos function returns the cosine of num.

See Also:

acos, sin, tan

Complex cosh() [Complex]

Synopsis:

#include <complex.h>
Complex cosh( Complex const &num );

Semantics:

The cosh function computes the hyperbolic cosine of num.

Results:

The cosh function returns the hyperbolic cosine of num.

See Also:

acosh, sinh, tanh

Complex exp() [Complex]

Synopsis:

#include <complex.h>
Complex exp( Complex const &num );

Semantics:

The exp function computes the value of e raised to the power num.

Results:

The exp function returns the value of e raised to the power num.

See Also:

log, log10, pow, sqrt

imag() [Complex]

Synopsis:

#include <complex.h>
public:
double Complex::imag();

Semantics:

The imag public member function extracts the imaginary component of the Complex object.

Results:

The imag public member function returns the imaginary component of the Complex object.

See Also:

imag, real
Complex::real

Complex imag() [Complex]

Synopsis:

#include <complex.h>
double imag( Complex const &num );

Semantics:

The imag function extracts the imaginary component of num.

Results:

The imag function returns the imaginary component of num.

See Also:

real
Complex::imag, real

Complex log() [Complex]

Synopsis:

#include <complex.h>
Complex log( Complex const &num );

Semantics:

The log function computes the natural, or base e, logarithm of num.

Results:

The log function returns the natural, or base e, logarithm of num.

See Also:

exp, log10, pow, sqrt

Complex log10() [Complex]

Synopsis:

#include <complex.h>
Complex log10( Complex const &num );

Semantics:

The log10 function computes the base 10 logarithm of num.

Results:

The log10 function returns the base 10 logarithm of num.

See Also:

exp, log, pow, sqrt

Complex norm() [Complex]

Synopsis:

#include <complex.h>
double norm( Complex const &num );

Semantics:

The norm function computes the square of the magnitude of num, which is equivalent to the square of the length (magnitude) of the vector when num is represented in polar coordinates.

Results:

The norm function returns the square of the magnitude of num.

See Also:

arg, polar

Complex operator !=() [Complex]

Synopsis:

#include <complex.h>
int operator !=( Complex const &num1, Complex const &num2 );
int operator !=( Complex const &num1, double num2 );
int operator !=( double num1, Complex const &num2 );

Semantics:

The operator != function compares num1 and num2 for inequality.  At least one of the parameters must be a Complex object for this function to be called.
Two Complex objects are not equal if either of their corresponding real or imaginary components are not equal.

If the operator != function is used with a Complex object and an object of any other built-in numeric type, the non- Complex object is converted to a double and the second or third form of the operator != function is used.

Results:

The operator != function returns a non-zero value if num1 is not equal to num2, otherwise zero is returned.

See Also:

operator ==

Complex operator *() [Complex]

Synopsis:

#include <complex.h>
Complex operator *( Complex const &num1, Complex const &num2 );
Complex operator *( Complex const &num1, double num2 );
Complex operator *( double num1, Complex const &num2 );

Semantics:

The operator * function is used to multiply num1 by num2 yielding a Complex object.
The first operator * function multiplies two Complex objects.

The second operator * function multiplies a Complex object and a floating-point value.  In effect, the real and imaginary components of the Complex object are multiplied by the floating-point value.

The third operator * function multiplies a floating-point value and a Complex object.  In effect, the real and imaginary components of the Complex object are multiplied by the floating-point value.

If the operator * function is used with a Complex object and an object of any other built-in numeric type, the non- Complex object is converted to a double and the second or third form of the operator * function is used.

Results:

The operator * function returns a Complex object that is the product of num1 and num2.

See Also:

operator +, operator -, operator /
Complex::operator *=

operator *=() [Complex]

Synopsis:

#include <complex.h>
public:
Complex &Complex::operator *=( Complex const &num );
Complex &Complex::operator *=( double num );

Semantics:

The operator *= public member function is used to multiply the num argument into the Complex object.
The first form of the operator *= public member function multiplies the Complex object by the Complex parameter.

The second form of the operator *= public member function multiplies the real and imaginary components of the Complex object by num.

A call to the operator *= public member function where num is any of the other built-in numeric types, causes num to be promoted to double and the second form of the operator *= public member function to be used.

Results:

The operator *= public member function returns a reference to the target of the assignment.

See Also:

operator *
Complex::operator +=, operator -=, operator /=, operator =

operator +() [Complex]

Synopsis:

#include <complex.h>
public:
Complex Complex::operator +();

Semantics:

The unary operator + public member function is provided for completeness.  It performs no operation on the Complex object.

Results:

The unary operator + public member function returns a Complex object with the same value as the original Complex object.

See Also:

operator +
Complex::operator +=, operator -

Complex operator +() [Complex]

Synopsis:

#include <complex.h>
Complex operator +( Complex const &num1, Complex const &num2 );
Complex operator +( Complex const &num1, double num2 );
Complex operator +( double num1, Complex const &num2 );

Semantics:

The operator + function is used to add num1 to num2 yielding a Complex object.
The first operator + function adds two Complex objects.

The second operator + function adds a Complex object and a floating-point value.  In effect, the floating-point value is added to the real component of the Complex object.

The third operator + function adds a floating-point value and a Complex object.  In effect, the floating-point value is added to the real component of the Complex object.

If the operator + function is used with a Complex object and an object of any other built-in numeric type, the non- Complex object is converted to a double and the second or third form of the operator + function is used.

Results:

The operator + function returns a Complex object that is the sum of num1 and num2.

See Also:

operator *, operator -, operator /
Complex::operator +, operator +=

operator +=() [Complex]

Synopsis:

#include <complex.h>
public:
Complex &Complex::operator +=( Complex const &num );
Complex &Complex::operator +=( double num );

Semantics:

The operator += public member function is used to add num to the value of the Complex object.  The second form of the operator += public member function adds num to the real component of the Complex object.
A call to the operator += public member function where num is any of the other built-in numeric types, causes num to be promoted to double and the second form of the operator += public member function to be used.

Results:

The operator += public member function returns a reference to the target of the assignment.

See Also:

operator +
Complex::operator *=, operator +, operator /=, operator -=, operator =

operator -() [Complex]

Synopsis:

#include <complex.h>
public:
Complex Complex::operator -();

Semantics:

The unary operator - public member function yields a Complex object with the real and imaginary components having the same magnitude as those of the original object, but with opposite sign.

Results:

The unary operator - public member function returns a Complex object with the same magnitude as the original Complex object and with opposite sign.

See Also:

operator -
Complex::operator +, operator -=

Complex operator -() [Complex]

Synopsis:

#include <complex.h>
Complex operator -( Complex const &num1, Complex const &num2 );
Complex operator -( Complex const &num1, double num2 );
Complex operator -( double num1, Complex const &num2 );

Semantics:

The operator - function is used to subtract num2 from num1 yielding a Complex object.
The first operator - function computes the difference between two Complex objects.

The second operator - function computes the difference between a Complex object and a floating-point value.  In effect, the floating-point value is subtracted from the real component of the Complex object.

The third operator - function computes the difference between a floating-point value and a Complex object.  In effect, the real component of the result is num1 minus the real component of num2 :CONT, and the imaginary component of the result is the negative of the imaginary component of num2.

If the operator - function is used with a Complex object and an object of any other built-in numeric type, the non- Complex object is converted to a double and the second or third form of the operator - function is used.

Results:

The operator - function returns a Complex object that is the difference between num1 and num2.

See Also:

operator *, operator +, operator /
Complex::operator -, operator -=

operator -=() [Complex]

Synopsis:

#include <complex.h>
public:
Complex &Complex::operator -=( Complex const &num );
Complex &Complex::operator -=( double num );

Semantics:

The operator -= public member function is used to subtract num from the value of the Complex object.   The second form of the operator -= public member function subtracts num from the real component of the *obj..
A call to the operator -= public member function where num is any of the other built-in numeric types, causes num to be promoted to double and the second form of the operator -= public member function to be used.

Results:

The operator -= public member function returns a reference to the target of the assignment.

See Also:

operator -
Complex::operator *=, operator +=, operator -, operator /=, operator =

Complex operator /() [Complex]

Synopsis:

#include <complex.h>
Complex operator /( Complex const &num1, Complex const &num2 );
Complex operator /( Complex const &num1, double num2 );
Complex operator /( double num1, Complex const &num2 );

Semantics:

The operator / function is used to divide num1 by num2 yielding a Complex object.
The first operator / function divides two Complex objects.

The second operator / function divides a Complex object by a floating-point value.  In effect, the real and imaginary components of the complex number are divided by the floating-point value.

The third operator / function divides a floating-point value by a Complex object.  Conceptually, the floating-point value is converted to a Complex object and then the division is done.

If the operator / function is used with a Complex object and an object of any other built-in numeric type, the non- Complex object is converted to a double and the second or third form of the operator / function is used.

Results:

The operator / function returns a Complex object that is the quotient of num1 divided by num2.

See Also:

operator *, operator +, operator -
Complex::operator /=

operator /=() [Complex]

Synopsis:

#include <complex.h>
public:
Complex &Complex::operator /=( Complex const &num );
Complex &Complex::operator /=( double num );

Semantics:

The operator /= public member function is used to divide the Complex object by num.  The second form of the operator /= public member function divides the real and imaginary components of the Complex object by num.
A call to the operator /= public member function where num is any of the other built-in numeric types, causes num to be promoted to double and the second form of the operator /= public member function to be used.

Results:

The operator /= public member function returns a reference to the target of the assignment.

See Also:

operator /
Complex::operator *=, operator +=, operator -=, operator =

Complex operator <<() [Complex]

Synopsis:

#include <complex.h>
friend ostream &operator <<( ostream &strm, Complex &num );

Semantics:

The operator << function is used to write Complex objects to an I/O stream.  The Complex object is always written in the form:
(real,imag)

The real and imaginary components are written using the normal rules for formatting floating-point numbers.  Any formatting options specified prior to inserting the num apply to both the real and imaginary components.  If the real and imaginary components are to be inserted using different formats, the real and imag member functions should be used to insert each component separately.

Results:

The operator << function returns a reference to the strm object.

See Also:

istream

operator =() [Complex]

Synopsis:

#include <complex.h>
public:
Complex &Complex::operator =( Complex const &num );
Complex &Complex::operator =( double num );

Semantics:

The operator = public member function is used to set the value of the Complex object to num.  The first assignment operator copies the value of num into the Complex object.
The second assignment operator sets the real component of the Complex object to num and the imaginary component to zero.

A call to the operator = public member function where num is any of the other built-in numeric types, causes num to be promoted to double and the second form of the operator = public member function to be used.

Results:

The operator = public member function returns a reference to the target of the assignment.

See Also:

Complex::operator *=, operator +=, operator -=, operator /=

Complex operator ==() [Complex]

Synopsis:

#include <complex.h>
int operator ==( Complex const &num1, Complex const &num2 );
int operator ==( Complex const &num1, double num2 );
int operator ==( double num1, Complex const &num2 );

Semantics:

The operator == function compares num1 and num2 for equality.  At least one of the arguments must be a Complex object for this function to be called.
Two Complex objects are equal if their corresponding real and imaginary components are equal.

If the operator == function is used with a Complex object and an object of any other built-in numeric type, the non- Complex object is converted to a double and the second or third form of the operator == function is used.

Results:

The operator == function returns a non-zero value if num1 is equal to num2, otherwise zero is returned.

See Also:

operator !=

Complex operator >>() [Complex]

Synopsis:

#include <complex.h>
friend istream &operator >>( istream &strm, Complex &num );

Semantics:

The operator >> function is used to read a Complex object from an I/O stream.  A valid complex value is of one of the following forms:
(real,imag)

real,imag
(real)
If the imaginary portion is omitted, zero is assumed.

While reading a Complex object, whitespace is ignored before and between the various components of the number if the ios::skipws bit is set in ios::fmtflags.

Results:

The operator >> function returns a reference to strm.  num contains the value read from strm on success, otherwise it is unchanged.

See Also:

istream

Complex polar() [Complex]

Synopsis:

#include <complex.h>
Complex polar( double mag, double angle = 0.0 );

Semantics:

The polar function converts mag and angle (polar coordinates) into a complex number.  The angle is optional and defaults to zero if it is unspecified.

Results:

The polar function returns a Complex object that is mag and angle interpreted as polar coordinates.

See Also:

abs, arg, norm

Complex pow() [Complex]

Synopsis:

#include <complex.h>
Complex pow( Complex const &num, Complex const &exp );
Complex pow( Complex const &num, double exp );
Complex pow( double num, Complex const &exp );
Complex pow( Complex const &num, int exp );

Semantics:

The pow function computes num raised to the power exp.  The various forms are provided to minimize the amount of floating-point calculation performed.

Results:

The pow function returns a Complex object that is num raised to the power a Complex object that is exp.

See Also:

exp, log, log10, sqrt

real() [Complex]

Synopsis:

#include <complex.h>
public:
double Complex::real();

Semantics:

The real public member function extracts the real component of the Complex object.

Results:

The real public member function returns the real component of the Complex object.

See Also:

imag, real
Complex::imag

Complex real() [Complex]

Synopsis:

#include <complex.h>
double real( Complex const &num );

Semantics:

The real function extracts the real component of num.

Results:

The real function returns the real component of num.

See Also:

imag
Complex::imag, real

Complex sin() [Complex]

Synopsis:

#include <complex.h>
Complex sin( Complex const &num );

Semantics:

The sin function computes the sine of num.

Results:

The sin function returns the sine of num.

See Also:

asin, cos, tan

Complex sinh() [Complex]

Synopsis:

#include <complex.h>
Complex sinh( Complex const &num );

Semantics:

The sinh function computes the hyperbolic sine of num.

Results:

The sinh function returns the hyperbolic sine of num.

See Also:

asinh, cosh, tanh

Complex sqrt() [Complex]

Synopsis:

#include <complex.h>
Complex sqrt( Complex const &num );

Semantics:

The sqrt function computes the square root of num.

Results:

The sqrt function returns the square root of num.

See Also:

exp, log, log10, pow

Complex tan() [Complex]

Synopsis:

#include <complex.h>
Complex tan( Complex const &num );

Semantics:

The tan function computes the tangent of num.

Results:

The tan function returns the tangent of num.

See Also:

atan, cos, sin

Complex tanh() [Complex]

Synopsis:

#include <complex.h>
Complex tanh( Complex const &num );

Semantics:

The tanh function computes the hyperbolic tangent of num.

Results:

The tanh function returns the hyperbolic tangent of num.

See Also:

atanh, cosh, sinh

Container Exception Classes

WCExcept Class Description

Declared:

wcexcept.h
The WCExcept class provides the exception handling for the container classes.  If you have compiled your code with exception handling enabled, the C++ exception processing can be used to catch errors.  Your source file must be compiled with the exception handling compile switch for C++ exception processing to occur.  The container classes will attempt to set the container object into a reasonable state if there is an error and exception handling is not enabled, or if the trap for the specific error has not been enabled by your program.
By default, no exception traps are enabled and no exceptions will be thrown.  Exception traps are enabled by setting the exception state with the exceptions member function.

The wcexcept.h header file is included by the header files for each of the container classes.  There is normally no need to explicitly include the wcexcept.h header file, but no errors will result if it is included.   This class is inherited as a base class for each of the containers.  You do not need to derive from it directly.

The WCListExcept class (formally used by the list container classes) has been replaced by the WCExcept class.  A typedef of the WCListExcept class to the WCExcept class and the wclist_state type to the wc_state type provide backward compatability with previous versions of the list containers.

Public Enumerations

The following enumeration typedefs are declared in the public interface:

typedef int wc_state;

Public Member Functions

The following public member functions are declared:

WCExcept();
virtual ~WCExcept();
wc_state exceptions() const;
wc_state exceptions( wc_state );

WCExcept() [WCExcept]

Synopsis:

#include <wcexcept.h>
public:
WCExcept();

Semantics:

This form of the public WCExcept constructor creates an WCExcept object.
The public WCExcept constructor is used implicitly by the compiler when it generates a constructor for a derived class.  It is automatically used by the list container classes, and should not be required in any user derived classes.

Results:

The public WCExcept constructor produces an initialized WCExcept object with no exception traps enabled.

See Also:

~WCExcept

~WCExcept() [WCExcept]

Synopsis:

#include <wcexcept.h>
public:
virtual ~WCExcept();

Semantics:

The public ~WCExcept destructor does not do anything explicit.  The call to the public ~WCExcept destructor is inserted implicitly by the compiler at the point where the object derived from WCExcept goes out of scope.

Results:

The object derived from WCExcept is destroyed.

See Also:

WCExcept

exceptions() [WCExcept]

Synopsis:

#include <wcexcept.h>
public:
wc_state exceptions() const;
wc_state exceptions( wc_state set_flags );

Semantics:

The exceptions public member function queries and/or sets the bits that control which exceptions are enabled for the list class.  Each bit corresponds to an exception, and is set if the exception is enabled.  The first form of the exceptions public member function returns the current settings of the exception bits.  The second form of the function sets the exception bits to those specified by set_flags.

Results:

The current exception bits are returned.  If a new set of bits are being set, the returned value is the old set of exception bits.

wc_state [WCExcept]

Synopsis:

#include <wcexcept.h>
public:
enum wcstate {
all_fine = 0x0000, // - no errors
check_none = all_fine,// - throw no exceptions
not_empty = 0x0001, // - container not empty
index_range = 0x0002, // - index is out of range
empty_container= 0x0004, // - empty container error
out_of_memory = 0x0008, // - allocation failed
resize_required= 0x0010, // - request needs resize
not_unique = 0x0020, // - adding duplicate
zero_buckets = 0x0040, // - resizing hash to zero
// value to use to check for all errors
check_all = (not_empty|index_range|empty_container
|out_of_memory|resize_required
|not_unique|zero_buckets)
};
typedef int wc_state;

Semantics:

The type WCExcept::wcstate is a set of bits representing the current state of the container object.  The WCExcept::wc_state member typedef represents the same set of bits, but uses an int to represent the values, thereby avoiding problems made possible by the compiler's ability to use smaller types for enumerations.  All uses of these bits should use the WCExcept::wc_state member typedef.
The bit values defined by the WCExcept::wc_state member typedef can be read and set by the exceptions member function, which is also used to control exception handling.

The WCExcept::not_empty bit setting traps the destruction of a container when the container has at one or more entries.  If this error is not trapped, memory may not be properly released back to the system.

The WCExcept::index_range state setting traps an attempt to access a container item by an index value that is either not positive or is larger than the index of the last item in the container.

The WCExcept::empty_container bit setting traps an attempt to perform and invalid operation on a container with no entries.

The WCExcept::out_of_memory bit setting traps any container class allocation failures.  If this exception is not enabled, the operation in which the allocation failed will return a FALSE (zero) value.  Container class copy constructors and assignment operators can also throw this exception, and if not enabled incomplete copies may result.

The WCExcept::resize_required bit setting traps any vector operations which cannot be performed unless the vector is resized to a larger size.  If this exception is not enabled, the vector class will attempt an appropriate resize when necessary for an operation.

The WCExcept::not_unique bit setting traps an attempt to add a duplicate value to a set container, or a duplicate key to a dictionary container.  The duplicate value is not added to the container object regardless of the exception trap state.

The WCExcept::zero_buckets bit setting traps an attempt to resize of hash container to have zero buckets.   No resize is performed whether or not the exception is enabled.

WCIterExcept Class Description

Declared:

wcexcept.h
The WCIterExcept class provides the exception handling for the container iterators.  If you have compiled your code with exception handling enabled, the C++ exception processing can be used to catch errors.  Your source file must be compiled with the exception handling compile switch for C++ exception processing to occur.  The iterators will attempt to set the class into a reasonable state if there is an error and exception handling is not enabled, or if the trap for the specific error has not been enabled by your program.
By default, no exception traps are enabled and no exceptions will be thrown.  Exception traps are enabled by setting the exception state with the exceptions member function.

The wcexcept.h header file is included by the header files for each of the iterator classes.  There is normally no need to explicitly include the wcexcept.h header file, but no errors will result if it is included.   This class is inherited as part of the base construction for each of the iterators.  You do not need to derive from it directly.

Public Enumerations

The following enumeration typedefs are declared in the public interface:

typedef int wciter_state;

Public Member Functions

The following public member functions are declared:

WCIterExcept();
virtual ~WCIterExcept();
wciter_state exceptions() const;
wciter_state exceptions( wciter_state );

WCIterExcept() [WCIterExcept]

Synopsis:

#include <wcexcept.h>
public:
WCIterExcept();

Semantics:

This form of the public WCIterExcept constructor creates an WCIterExcept object.
The public WCIterExcept constructor is used implicitly by the compiler when it generates a constructor for a derived class.

Results:

The public WCIterExcept constructor produces an initialized WCIterExcept object with no exception traps enabled.

See Also:

~WCIterExcept

~WCIterExcept() [WCIterExcept]

Synopsis:

#include <wcexcept.h>
public:
virtual ~WCIterExcept();

Semantics:

The public ~WCIterExcept destructor does not do anything explicit.  The call to the public ~WCIterExcept destructor is inserted implicitly by the compiler at the point where the object derived from WCIterExcept goes out of scope.

Results:

The object derived from WCIterExcept is destroyed.

See Also:

WCIterExcept

exceptions() [WCIterExcept]

Synopsis:

#include <wcexcept.h>
public:
wciter_state exceptions() const;
wciter_state exceptions( wciter_state set_flags );

Semantics:

The exceptions public member function queries and/or sets the bits that control which exceptions are enabled for the iterator class.  Each bit corresponds to an exception, and is set if the exception is enabled.  The first form of the exceptions public member function returns the current settings of the exception bits.  The second form of the function sets the exception bits to those specified by set_flags.

Results:

The current exception bits are returned.  If a new set of bits are being set, the returned value is the old set of exception bits.

wciter_state [WCIterExcept]

Synopsis:

#include <wcexcept.h>
public:
enum wciterstate {
all_fine = 0x0000, // - no errors
check_none = all_fine,// - disable all exceptions
undef_iter = 0x0001, // - position is undefined
undef_item = 0x0002, // - iterator item is undefined
iter_range = 0x0004, // - advance value is bad
// value to use to check for all errors
check_all= (undef_iter|undef_item|iter_range)
};
typedef int wciter_state;

Semantics:

The type WCIterExcept::wciterstate is a set of bits representing the current state of the iterator.  The WCIterExcept::wciter_state member typedef represents the same set of bits, but uses an int to represent the values, thereby avoiding problems made possible by the compiler's ability to use smaller types for enumerations.  All uses of these bits should use the WCIterExcept::wciter_state member typedef.
The bit values defined by the WCIterExcept::wciter_state member typedef can be read and set by the member function exceptions, which is used to control exception handling.

The WCIterExcept::undef_iter bit setting traps the use of the iterator when the position within the container object is undefined.  Trying to operate on an iterator with no associated container object, increment an iterator which is after the last element, or decrement an iterator positioned before the first element is an undefined operation.

The WCIterExcept::undef_item bit setting traps an attempt to obtain the current element of the iterator when the iterator has no associated container object, or is positioned either before or after the container elements.  The undef_item exception can be thrown only by the key and value dictionary iterator member functions, and the current member function for non-dictionary iterators.

The WCIterExcept::iter_range bit setting traps an attempt to use a iteration count value that would place the iterator more than one element past the end or before the beginning of the container elements.  The iter_range exception can be thrown only by the operator += and operator -= operators.

Container Allocators and Deallocators

Hash Containers

WCPtrHashDict<Key,Value> Class Description

Declared:

wchash.h
The WCPtrHashDict<Key,Value> class is a templated class used to store objects in a dictionary.  Dictionaries store values with an associated key, which may be of any type.  One example of a dictionary used in everyday life is the phone book.  The phone numbers are the data values, and the customer name is the key.  An example of a specialized dictionary is a vector, where the key value is the integer index.
As an element is looked up or inserted into the dictionary, the associated key is hashed.  Hashing converts the key into a numeric index value which is used to locate the value.  The storage area referenced by the hash value is usually called a bucket.  If more than one key results in the same hash, the values associated with the keys are placed in a list stored in the bucket.  The equality operator of the key's type is used to locate the key-value pairs.

In the description of each member function, the text Key is used to indicate the template parameter defining the type of the indices pointed to by the pointers stored in the dictionary.  The text Value is used to indicate the template parameter defining the type of the data pointed to by the pointers stored in the dictionary.

The constructor for the WCPtrHashDict<Key,Value> class requires a hashing function, which given a reference to Key, returns an unsigned value.  The returned value modulo the number of buckets determines the bucket into which the key-value pair will be located.  The return values of the hash function can be spread over the entire range of unsigned numbers.  The hash function return value must be the same for values which are equivalent by the equivalence operator for Key.

Note that pointers to the key values are stored in the dictionary.  Destructors are not called on the keys pointed to.  The key values pointed to in the dictionary should not be changed such that the equivalence to the old value is modified.

The WCExcept class is a base class of the WCPtrHashDict<Key,Value> class and provides the exceptions member function.  This member function controls the exceptions which can be thrown by the WCPtrHashDict<Key,Value> object.  No exceptions are enabled unless they are set by the exceptions member function.

Requirements of Key

The WCPtrHashDict<Key,Value> class requires Key to have:
A well defined equivalence operator with constant parameters

( int operator ==( const Key & ) const ).

Public Member Functions

The following member functions are declared in the public interface:

WCPtrHashDict( unsigned (*hash_fn)( const Key & ), unsigned = WC_DEFAULT_HASH_SIZE );
WCPtrHashDict( unsigned (*hash_fn)( const Key & ), unsigned = WC_DEFAULT_HASH_SIZE, void * (*user_alloc)( size_t size ), void (*user_dealloc)( void *old, size_t size ) );
WCPtrHashDict( const WCPtrHashDict & );
virtual ~WCPtrHashDict();
static unsigned bitHash( const void *, size_t );
unsigned buckets() const;
void clear();
void clearAndDestroy();
int contains( const Key * ) const;
unsigned entries() const;
Value * find( const Key * ) const;
Value * findKeyAndValue( const Key *, Key * & ) const;
void forAll( void (*user_fn)( Key *, Value *, void * ) , void * );
int insert( Key *, Value * );
int isEmpty() const;
Value * remove( const Key * );
void resize( unsigned );

Public Member Operators

The following member operators are declared in the public interface:

Value * & operator []( const Key & );
const Value * & operator []( const Key & ) const;
WCPtrHashDict & operator =( const WCPtrHashDict & );
int operator ==( const WCPtrHashDict & ) const;

WCPtrHashDict() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
WCPtrHashDict( unsigned (*hash_fn)( const Key & ),
unsigned = WC_DEFAULT_HASH_SIZE );

Semantics:

The public WCPtrHashDict<Key,Value> constructor creates an WCPtrHashDict<Key,Value> object with no entries and with the number of buckets in the second optional parameter, which defaults to the constant WC_DEFAULT_HASH_SIZE (currently defined as 101).  The number of buckets specified must be greater than zero, and will be forced to at least one.  If the hash dictionary object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If the out_of_memory exception is enabled, then attempting to insert into a hash table with zero buckets with throw an out_of_memory error.
The hash function hash_fn is used to determine which bucket each key-value pair will be assigned.  If no hash function exists, the static member function bitHash is available to help create one.

Results:

The public WCPtrHashDict<Key,Value> constructor creates an initialized WCPtrHashDict<Key,Value> object with the specified number of buckets and hash function.

See Also:

~WCPtrHashDict, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCPtrHashDict( unsigned (*hash_fn)( const Key & ),
unsigned = WC_DEFAULT_HASH_SIZE,
void * (*user_alloc)( size_t ),
void (*user_dealloc)( void *, size_t ) );

Semantics:

Allocator and deallocator functions are specified for use when entries are inserted and removed from the hash dictionary.   The semantics of this constructor are the same as the constructor without the memory management functions.
The allocation function must return a zero if it cannot perform the allocation.  The deallocation function is passed the size as well as the pointer to the data.  Your allocation system may take advantage of the characteristic that the allocation function will always be called with the same size value for any particular instantiation of a hash dictionary.   To determine the size of the objects that the memory management functions will be required to allocate and free, the following macro may be used:

WCPtrHashDictItemSize( Key, Value )

Results:

The public WCPtrHashDict<Key,Value> constructor creates an initialized WCPtrHashDict<Key,Value> object with the specified number of buckets and hash function.

See Also:

~WCPtrHashDict, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCPtrHashDict( const WCPtrHashDict & );

Semantics:

The public WCPtrHashDict<Key,Value> constructor is the copy constructor for the WCPtrHashDict<Key,Value> class.  The new dictionary is created with the same number of buckets, hash function, all values or pointers stored in the dictionary, and the exception trap states.  If the hash dictionary object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If there is not enough memory to copy all of the values in the dictionary, then only some will be copied, and the number of entries will correctly reflect the number copied.  If all of the elements cannot be copied, then the out_of_memory exception is thrown if it is enabled.

Results:

The public WCPtrHashDict<Key,Value> constructor creates an WCPtrHashDict<Key,Value> object which is a copy of the passed dictionary.

See Also:

~WCPtrHashDict, operator =, WCExcept::out_of_memory

~WCPtrHashDict() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
virtual ~WCPtrHashDict();

Semantics:

The public ~WCPtrHashDict<Key,Value> destructor is the destructor for the WCPtrHashDict<Key,Value> class.  If the number of dictionary elements is not zero and the not_empty exception is enabled, the exception is thrown.  Otherwise, the dictionary elements are cleared using the clear member function.  The objects which the dictionary elements point to are not deleted unless the clearAndDestroy member function is explicitly called before the destructor is called.  The call to the public ~WCPtrHashDict<Key,Value> destructor is inserted implicitly by the compiler at the point where the WCPtrHashDict<Key,Value> object goes out of scope.

Results:

The public ~WCPtrHashDict<Key,Value> destructor destroys an WCPtrHashDict<Key,Value> object.

See Also:

clear, clearAndDestroy, WCExcept::not_empty

bitHash() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
static unsigned bitHash( void *, size_t );

Semantics:

The bitHash public member function can be used to implement a hashing function for any type.  A hashing value is generated from the value stored for the number of specified bytes pointed to by the first parameter.

Results:

The bitHash public member function returns an unsigned value which can be used as the basis of a user defined hash function.

See Also:

WCPtrHashDict

buckets() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
unsigned buckets const;

Semantics:

The buckets public member function is used to find the number of buckets contained in the WCPtrHashDict<Key,Value> object.

Results:

The buckets public member function returns the number of buckets in the dictionary.

See Also:

resize

clear() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void clear();

Semantics:

The clear public member function is used to clear the dictionary so that it has no entries.  The number of buckets remain unaffected.  Objects pointed to by the dictionary elements are not deleted.  The dictionary object is not destroyed and re-created by this function, so the object destructor is not invoked.

Results:

The clear public member function clears the dictionary to have no elements.

See Also:

~WCPtrHashDict, clearAndDestroy, operator =

clearAndDestroy() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void clearAndDestroy();

Semantics:

The clearAndDestroy public member function is used to clear the dictionary and delete the objects pointed to by the dictionary elements.  The dictionary object is not destroyed and re-created by this function, so the dictionary object destructor is not invoked.

Results:

The clearAndDestroy public member function clears the dictionary by deleting the objects pointed to by the dictionary elements.

See Also:

clear

contains() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int contains( const Key * ) const;

Semantics:

The contains public member function returns non-zero if an element with the specified key is stored in the dictionary, or zero if there is no equivalent element.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The contains public member function returns a non-zero value if the Key is found in the dictionary.

See Also:

find, findKeyAndValue

entries() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
unsigned entries() const;

Semantics:

The entries public member function is used to return the current number of elements stored in the dictionary.

Results:

The entries public member function returns the number of elements in the dictionary.

See Also:

buckets, isEmpty

find() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
Value * find( const Key * ) const;

Semantics:

The find public member function is used to find an element with an equivalent key in the dictionary.  If an equivalent element is found, a pointer to the element Value is returned.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The element equivalent to the passed key is located in the dictionary.

See Also:

findKeyAndValue

findKeyAndValue() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
Value * findKeyAndValue( const Key *,
Key &, Value & ) const;

Semantics:

The findKeyAndValue public member function is used to find an element in the dictionary with an key equivalent to the first parameter.  If an equivalent element is found, a pointer to the element Value is returned.  The reference to a Key passed as the second parameter is assigned the found element's key.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The element equivalent to the passed key is located in the dictionary.

See Also:

findKeyAndValue

forAll() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void forAll(
void (*user_fn)( Key *, Value *, void * ),
void * );

Semantics:

The forAll public member function causes the user supplied function to be invoked for every key-value pair in the dictionary.  The user function has the prototype
void user_func( Key * key, Value * value, void * data );

As the elements are visited, the user function is invoked with the Key and Value components of the element passed as the first two parameters.  The second parameter of the forAll function is passed as the third parameter to the user function.  This value can be used to pass any appropriate data from the main code to the user function.

Results:

The elements in the dictionary are all visited, with the user function being invoked for each one.

See Also:

find, findKeyAndValue

insert() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int insert( Key *, Value * );

Semantics:

The insert public member function inserts a key and value into the dictionary, using the hash function on the key to determine to which bucket it should be stored.  If allocation of the node to store the key-value pair fails, then the out_of_memory exception is thrown if it is enabled.  If the exception is not enabled, the insert will not be completed.
At some point, the number of buckets initially selected may be too small for the number of elements inserted.  The resize of the dictionary can be controlled by the insertion mechanism by using WCPtrHashDict as a base class, and providing an insert member function to do a resize when appropriate.  This insert could then call WCPtrHashDict::insert to insert the element.  Note that copy constructors and assignment operators are not inherited in your class, but you can provide the following inline definitions (assuming that the class inherited from WCPtrHashDict is named MyHashDict):

inline MyHashDict( const MyHashDict &orig ) : WCPtrHashDict( orig ) {};
inline MyHashDict &operator=( const MyHashDict &orig ) {
    return( WCPtrHashDict::operator=( orig ) );
}

Results:

The insert public member function inserts a key and value into the dictionary.  If the insert is successful, a non-zero will returned.  A zero will be returned if the insert fails.

See Also:

operator =, WCExcept::out_of_memory

isEmpty() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int isEmpty() const;

Semantics:

The isEmpty public member function is used to determine if the dictionary is empty.

Results:

The isEmpty public member function returns zero if it contains at least one entry, non-zero if the dictionary is empty.

See Also:

buckets, entries

operator []() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
Value * & operator[]( const Key & );

Semantics:

operator [] is the dictionary index operator.  A reference to the object stored in the dictionary with the given Key is returned.  If no equivalent element is found, then a new key-value pair is created with the specified Key value, and initialized with the default constructor.  The returned reference can then be assigned to, so that insertions can be made with the operator.  If an allocation error occurs while inserting a new key-value pair, then the out_of_memory exception is thrown if it is enabled.  If the exception is not enabled, then a reference to address zero will be returned.  This will result in a run-time error on systems which trap address zero references.

Results:

The operator [] public member function returns a reference to the element at the given key value.  If the key does not exist, a reference to a created element is returned.  The result of the operator may be assigned to.

See Also:

WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
Value * const & operator[]( const Key * ) const;

Semantics:

operator [] is the dictionary index operator.  A constant reference to the object stored in the dictionary with the given Key is returned.  If no equivalent element is found, then the index_range exception is thrown if it is enabled.  If the exception is not enabled, then a reference to address zero will be returned.  This will result in a run-time error on systems which trap address zero references.

Results:

The operator [] public member function returns a constant reference to the element at the given key value.   The result of the operator may not be assigned to.

See Also:

WCExcept::index_range

operator =() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
WCPtrHashDict & operator =( const WCPtrHashDict & );

Semantics:

The operator = public member function is the assignment operator for the WCPtrHashDict<Key,Value> class.  The left hand side dictionary is first cleared using the clear member function, and then the right hand side dictionary is copied.  The hash function, exception trap states, and all of the dictionary elements are copied.   If an allocation failure occurs when creating the buckets, the table will be created with zero buckets, and the out_of_memory exception is thrown if it is enabled.  If there is not enough memory to copy all of the values or pointers in the dictionary, then only some will be copied, and the out_of_memory exception is thrown if it is enabled.   The number of entries will correctly reflect the number copied.

Results:

The operator = public member function assigns the left hand side dictionary to be a copy of the right hand side.

See Also:

clear, WCExcept::out_of_memory

operator ==() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int operator ==( const WCPtrHashDict & ) const;

Semantics:

The operator == public member function is the equivalence operator for the WCPtrHashDict<Key,Value> class.  Two dictionary objects are equivalent if they are the same object and share the same address.

Results:

A TRUE (non-zero) value is returned if the left hand side and right hand side dictionary are the same object.  A FALSE (zero) value is returned otherwise.

remove() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
Value * remove( const Key * );

Semantics:

The remove public member function is used to remove the specified element from the dictionary.  If an equivalent element is found, the pointer value is returned.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The element is removed from the dictionary if it found.

resize() [WCPtrHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void resize( unsigned );

Semantics:

The resize public member function is used to change the number of buckets contained in the dictionary.  If the new number is larger than the previous dictionary size, then the hash function will be used on all of the stored elements to determine which bucket they should be stored into.  Entries are not destroyed or created in the process of being moved.  If there is not enough memory to resize the dictionary, the out_of_memory exception is thrown if it is enabled, and the dictionary will contain the number of buckets it contained before the resize.  If the new number is zero, then the zero_buckets exception is thrown if it is enabled, and no resize will be performed.  The dictionary is guaranteed to contain the same number of entries after the resize.

Results:

The dictionary is resized to the new number of buckets.

See Also:

WCExcept::out_of_memory, WCExcept::zero_buckets

WCPtrHashTable<Type>, WCPtrHashSet<Type> Class Description

Declared:

wchash.h
WCPtrHashTable<Type> and WCPtrHashSet<Type> classes are templated classes used to store objects in a hash.  A hash saves objects in such a way as to make it efficient to locate and retrieve an element.  As an element is looked up or inserted into the hash, the value of the element is hashed.  Hashing results in a numeric index which is used to locate the value.  The storage area referenced by the hash value is usually called a bucket.   If more than one element results in the same hash, the value associated with the hash is placed in a list stored in the bucket.  A hash table allows more than one copy of an element that is equivalent, while the hash set allows only one copy.  The equality operator of the element's type is used to locate the value.
In the description of each member function, the text Type is used to indicate the template parameter defining the type of the data pointed to by the pointers stored in the hash.

The constructor for the WCPtrHashTable<Type> and WCPtrHashSet<Type> classes requires a hashing function, which given a reference to Type, returns an unsigned value.  The returned value modulo the number of buckets determines the bucket into which the element will be located.  The return values of the hash function can be spread over the entire range of unsigned numbers.  The hash function return value must be the same for values which are equivalent by the equivalence operator for Type.

Note that pointers to the elements are stored in the hash.  Destructors are not called on the elements pointed to.  The data values pointed to in the hash should not be changed such that the equivalence to the old value is modified.

The WCExcept class is a base class of the WCPtrHashTable<Type> and WCPtrHashSet<Type> classes and provides the exceptions member function.  This member function controls the exceptions which can be thrown by the WCPtrHashTable<Type> and WCPtrHashSet<Type> objects.  No exceptions are enabled unless they are set by the exceptions member function.

Requirements of Type

The WCPtrHashTable<Type> and WCPtrHashSet<Type> classes requires Type to have:
A well defined equivalence operator with constant parameters

( int operator ==( const Type & ) const ).

Public Member Functions

The following member functions are declared in the public interface:

WCPtrHashSet( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE );
WCPtrHashSet( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE, void * (*user_alloc)( size_t size ), void (*user_dealloc)( void *old, size_t size ) );
WCPtrHashSet( const WCPtrHashSet & );
virtual ~WCPtrHashSet();
WCPtrHashTable( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE );
WCPtrHashTable( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE, void * (*user_alloc)( size_t size ), void (*user_dealloc)( void *old, size_t size ) );
WCPtrHashTable( const WCPtrHashTable & );
virtual ~WCPtrHashTable();
static unsigned bitHash( const void *, size_t );
unsigned buckets() const;
void clear();
void clearAndDestroy();
int contains( const Type * ) const;
unsigned entries() const;
Type * find( const Type * ) const;
void forAll( void (*user_fn)( Type *, void * ) , void * );
int insert( Type * );
int isEmpty() const;
Type * remove( const Type * );
void resize( unsigned );

The following public member functions are available for the WCPtrHashTable class only:

unsigned occurrencesOf( const Type * ) const;
unsigned removeAll( const Type * );

Public Member Operators

The following member operators are declared in the public interface:

WCPtrHashSet & operator =( const WCPtrHashSet & );
int operator ==( const WCPtrHashSet & ) const;
WCPtrHashTable & operator =( const WCPtrHashTable & );
int operator ==( const WCPtrHashTable & ) const;

WCPtrHashSet() [WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
WCPtrHashSet( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE );

Semantics:

The WCPtrHashSet<Type> constructor creates a WCPtrHashSet object with no entries and with the number of buckets in the second optional parameter, which defaults to the constant WC_DEFAULT_HASH_SIZE (currently defined as 101).  The number of buckets specified must be greater than zero, and will be forced to at least one.  If the hash object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If the out_of_memory exception is enabled, then attempting to insert into a hash table with zero buckets with throw an out_of_memory error.
The hash function hash_fn is used to determine which bucket each value will be assigned to.  If no hash function exists, the static member function bitHash is available to help create one.

Results:

The WCPtrHashSet<Type> constructor creates an initialized WCPtrHashSet object with the specified number of buckets and hash function.

See Also:

~WCPtrHashSet, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCPtrHashSet( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE,
void * (*user_alloc)( size_t ),
void (*user_dealloc)( void *, size_t ) );

Semantics:

Allocator and deallocator functions are specified for use when entries are inserted and removed from the hash.  The semantics of this constructor are the same as the constructor without the memory management functions.
The allocation function must return a zero if it cannot perform the allocation.  The deallocation function is passed the size as well as the pointer to the data.  Your allocation system may take advantage of the characteristic that the allocation function will always be called with the same size value for any particular instantiation of a hash.  To determine the size of the objects that the memory management functions will be required to allocate and free, the following macro may be used:

WCPtrHashSetItemSize( Type )

Results:

The WCPtrHashSet<Type> constructor creates an initialized WCPtrHashSet object with the specified number of buckets and hash function.

See Also:

~WCPtrHashSet, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCPtrHashSet( const WCPtrHashSet & );

Semantics:

The WCPtrHashSet<Type> is the copy constructor for the WCPtrHashSet class.  The new hash is created with the same number of buckets, hash function, all values or pointers stored in the hash, and the exception trap states.   If the hash object can be created, but an allocation failure occurs when creating the buckets, the hash will be created with zero buckets.  If there is not enough memory to copy all of the values, then only some will be copied, and the number of entries will correctly reflect the number copied.  If all of the elements cannot be copied, then the out_of_memory exception is thrown if it is enabled.

Results:

The WCPtrHashSet<Type> constructor creates a WCPtrHashSet object which is a copy of the passed hash.

See Also:

~WCPtrHashSet, operator =, WCExcept::out_of_memory

~WCPtrHashSet() [WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
virtual ~WCPtrHashSet();

Semantics:

The WCPtrHashSet<Type> destructor is the destructor for the WCPtrHashSet class.  If the number of elements is not zero and the not_empty exception is enabled, the exception is thrown.  Otherwise, the hash elements are cleared using the clear member function.  The objects which the hash elements point to are not deleted unless the clearAndDestroy member function is explicitly called before the destructor is called.  The call to the WCPtrHashSet<Type> destructor is inserted implicitly by the compiler at the point where the WCPtrHashSet object goes out of scope.

Results:

The call to the WCPtrHashSet<Type> destructor destroys a WCPtrHashSet object.

See Also:

clear, clearAndDestroy, WCExcept::not_empty

WCPtrHashTable() [WCPtrHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
WCPtrHashTable( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE );

Semantics:

The WCPtrHashTable<Type> constructor creates a WCPtrHashTable object with no entries and with the number of buckets in the second optional parameter, which defaults to the constant WC_DEFAULT_HASH_SIZE (currently defined as 101).  The number of buckets specified must be greater than zero, and will be forced to at least one.  If the hash object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If the out_of_memory exception is enabled, then attempting to insert into a hash table with zero buckets with throw an out_of_memory error.
The hash function hash_fn is used to determine which bucket each value will be assigned to.  If no hash function exists, the static member function bitHash is available to help create one.

Results:

The WCPtrHashTable<Type> constructor creates an initialized WCPtrHashTable object with the specified number of buckets and hash function.

See Also:

~WCPtrHashTable, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCPtrHashTable( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE,
void * (*user_alloc)( size_t ),
void (*user_dealloc)( void *, size_t ) );

Semantics:

Allocator and deallocator functions are specified for use when entries are inserted and removed from the hash.  The semantics of this constructor are the same as the constructor without the memory management functions.
The allocation function must return a zero if it cannot perform the allocation.  The deallocation function is passed the size as well as the pointer to the data.  Your allocation system may take advantage of the characteristic that the allocation function will always be called with the same size value for any particular instantiation of a hash.  To determine the size of the objects that the memory management functions will be required to allocate and free, the following macro may be used:

WCPtrHashTableItemSize( Type )

Results:

The WCPtrHashTable<Type> constructor creates an initialized WCPtrHashTable object with the specified number of buckets and hash function.

See Also:

~WCPtrHashTable, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCPtrHashTable( const WCPtrHashTable & );

Semantics:

The WCPtrHashTable<Type> is the copy constructor for the WCPtrHashTable class.  The new hash is created with the same number of buckets, hash function, all values or pointers stored in the hash, and the exception trap states.  If the hash object can be created, but an allocation failure occurs when creating the buckets, the hash will be created with zero buckets.  If there is not enough memory to copy all of the values, then only some will be copied, and the number of entries will correctly reflect the number copied.  If all of the elements cannot be copied, then the out_of_memory exception is thrown if it is enabled.

Results:

The WCPtrHashTable<Type> constructor creates a WCPtrHashTable object which is a copy of the passed hash.

See Also:

~WCPtrHashTable, operator =, WCExcept::out_of_memory

~WCPtrHashTable() [WCPtrHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
virtual ~WCPtrHashTable();

Semantics:

The WCPtrHashTable<Type> destructor is the destructor for the WCPtrHashTable class.  If the number of elements is not zero and the not_empty exception is enabled, the exception is thrown.  Otherwise, the hash elements are cleared using the clear member function.  The objects which the hash elements point to are not deleted unless the clearAndDestroy member function is explicitly called before the destructor is called.  The call to the WCPtrHashTable<Type> destructor is inserted implicitly by the compiler at the point where the WCPtrHashTable object goes out of scope.

Results:

The call to the WCPtrHashTable<Type> destructor destroys a WCPtrHashTable object.

See Also:

clear, clearAndDestroy, WCExcept::not_empty

bitHash() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
static unsigned bitHash( void *, size_t );

Semantics:

The bitHash public member function can be used to implement a hashing function for any type.  A hashing value is generated from the value stored for the number of specified bytes pointed to by the first parameter.

Results:

The bitHash public member function returns an unsigned value which can be used as the basis of a user defined hash function.

See Also:

WCPtrHashSet, WCPtrHashTable

buckets() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned buckets() const;

Semantics:

The buckets public member function is used to find the number of buckets contained in the hash object.

Results:

The buckets public member function returns the number of buckets in the hash.

See Also:

resize

clear() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void clear();

Semantics:

The clear public member function is used to clear the hash so that it has no entries.  The number of buckets remain unaffected.  Objects pointed to by the hash elements are not deleted.  The hash object is not destroyed and re-created by this function, so the object destructor is not invoked.

Results:

The clear public member function clears the hash to have no elements.

See Also:

~WCPtrHashSet, ~WCPtrHashTable, clearAndDestroy, operator =

clearAndDestroy() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void clearAndDestroy();

Semantics:

The clearAndDestroy public member function is used to clear the hash and delete the objects pointed to by the hash elements.  The hash object is not destroyed and re-created by this function, so the hash object destructor is not invoked.

Results:

The clearAndDestroy public member function clears the hash by deleting the objects pointed to by the hash elements.

See Also:

clear

contains() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int contains( const Type * ) const;

Semantics:

The contains public member function returns non-zero if the element is stored in the hash, or zero if there is no equivalent element.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The contains public member function returns a non-zero value if the element is found in the hash.

See Also:

find

entries() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned entries() const;

Semantics:

The entries public member function is used to return the current number of elements stored in the hash.

Results:

The entries public member function returns the number of elements in the hash.

See Also:

buckets, isEmpty

find() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
Type * find( const Type * ) const;

Semantics:

The find public member function is used to find an element with an equivalent key in the hash.  If an equivalent element is found, a pointer to the element is returned.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The element equivalent to the passed key is located in the hash.

forAll() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void forAll(
void (*user_fn)( Type *, void * ),
void * );

Semantics:

The forAll public member function causes the user supplied function to be invoked for every value in the hash.  The user function has the prototype
void user_func( Type * value, void * data );

As the elements are visited, the user function is invoked with the element passed as the first.  The second parameter of the forAll function is passed as the second parameter to the user function.  This value can be used to pass any appropriate data from the main code to the user function.

Results:

The elements in the hash are all visited, with the user function being invoked for each one.

See Also:

find

insert() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int insert( Type * );

Semantics:

The insert public member function inserts a value into the hash, using the hash function to determine to which bucket it should be stored.  If allocation of the node to store the value fails, then the out_of_memory exception is thrown if it is enabled.  If the exception is not enabled, the insert will not be completed.
With a WCPtrHashSet, there must be only one equivalent element in the set.  If an element equivalent to the inserted element is already in the hash set, the hash set will remain unchanged, and the not_unique exception is thrown if it is enabled.  If the exception is not enabled, the insert will not be completed.

At some point, the number of buckets initially selected may be too small for the number of elements inserted.  The resize of the hash can be controlled by the insertion mechanism by using WCPtrHashSet (or WCPtrHashTable) as a base class, and providing an insert member function to do a resize when appropriate.  This insert could then call WCPtrHashSet::insert (or WCPtrHashTable::insert) to insert the element.  Note that copy constructors and assignment operators are not inherited in your class, but you can provide the following inline definitions (assuming that the class inherited from WCPtrHashTable is named MyHashTable):

inline MyHashTable( const MyHashTable &orig )
     : WCPtrHashTable( orig ) {};
inline MyHashTable &operator=( const MyHashTable &orig ) {
    return( WCPtrHashTable::operator=( orig ) );
}

Results:

The insert public member function inserts a value into the hash.  If the insert is successful, a non-zero will returned.  A zero will be returned if the insert fails.

See Also:

operator =, WCExcept::out_of_memory

isEmpty() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int isEmpty() const;

Semantics:

The isEmpty public member function is used to determine if the hash is empty.

Results:

The isEmpty public member function returns zero if it contains at least one entry, non-zero if the hash is empty.

See Also:

buckets, entries

occurencesOf() [WCPtrHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned occurrencesOf( const Type * ) const;

Semantics:

The occurencesOf public member function is used to return the current number of elements stored in the hash which are equivalent to the passed value.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The occurencesOf public member function returns the number of elements in the hash.

See Also:

buckets, entries, find, isEmpty

operator =() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
WCPtrHashSet & operator =( const WCPtrHashSet & );
WCPtrHashTable & operator =( const WCPtrHashTable & );

Semantics:

The operator = public member function is the assignment operator for the WCPtrHashTable<Type> and WCPtrHashSet<Type> classes.  The left hand side hash is first cleared using the clear member function, and then the right hand side hash is copied.  The hash function, exception trap states, and all of the hash elements are copied.  If an allocation failure occurs when creating the buckets, the table will be created with zero buckets, and the out_of_memory exception is thrown if it is enabled.  If there is not enough memory to copy all of the values or pointers in the hash, then only some will be copied, and the out_of_memory exception is thrown if it is enabled.  The number of entries will correctly reflect the number copied.

Results:

The operator = public member function assigns the left hand side hash to be a copy of the right hand side.

See Also:

clear, WCExcept::out_of_memory

operator ==() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int operator ==( const WCPtrHashSet & ) const;
int operator ==( const WCPtrHashTable & ) const;

Semantics:

The operator == public member function is the equivalence operator for the WCPtrHashTable<Type> and WCPtrHashSet<Type> classes.  Two hash objects are equivalent if they are the same object and share the same address.

Results:

A TRUE (non-zero) value is returned if the left hand side and right hand side hash are the same object.  A FALSE (zero) value is returned otherwise.

remove() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
Type * remove( const Type * );

Semantics:

The remove public member function is used to remove the specified element from the hash.  If an equivalent element is found, the pointer value is returned.  Zero is returned if the element is not found.  If the hash is a table and there is more than one element equivalent to the specified element, then the first equivalent element added to the table is removed.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The element is removed from the hash if it found.

removeAll() [WCPtrHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned removeAll( const Type * );

Semantics:

The removeAll public member function is used to remove all elements equivalent to the specified element from the hash.  Zero is returned if no equivalent elements are found.  Note that equivalence is based on the equivalence operator of the element type.

Results:

All equivalent elements are removed from the hash.

resize() [WCPtrHashTable<Type>,WCPtrHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void resize( unsigned );

Semantics:

The resize public member function is used to change the number of buckets contained in the hash.  If the new number is larger than the previous hash size, then the hash function will be used on all of the stored elements to determine which bucket they should be stored into.  Entries are not destroyed or created in the process of being moved.  If there is not enough memory to resize the hash, the out_of_memory exception is thrown if it is enabled, and the hash will contain the number of buckets it contained before the resize.  If the new number is zero, then the zero_buckets exception is thrown if it is enabled, and no resize will be performed.  The hash is guaranteed to contain the same number of entries after the resize.

Results:

The hash is resized to the new number of buckets.

See Also:

WCExcept::out_of_memory, WCExcept::zero_buckets

WCValHashDict<Key,Value> Class Description

Declared:

wchash.h
The WCValHashDict<Key,Value> class is a templated class used to store objects in a dictionary.  Dictionaries store values with an associated key, which may be of any type.  One example of a dictionary used in everyday life is the phone book.  The phone numbers are the data values, and the customer name is the key.  An example of a specialized dictionary is a vector, where the key value is the integer index.
As an element is looked up or inserted into the dictionary, the associated key is hashed.  Hashing converts the key into a numeric index value which is used to locate the value.  The storage area referenced by the hash value is usually called a bucket.  If more than one key results in the same hash, the values associated with the keys are placed in a list stored in the bucket.  The equality operator of the key's type is used to locate the key-value pairs.

In the description of each member function, the text Key is used to indicate the template parameter defining the type of the indices used to store data in the dictionary.  The text Value is used to indicate the template parameter defining the type of the data stored in the dictionary.

The constructor for the WCValHashDict<Key,Value> class requires a hashing function, which given a reference to Key, returns an unsigned value.  The returned value modulo the number of buckets determines the bucket into which the key-value pair will be located.  The return values of the hash function can be spread over the entire range of unsigned numbers.  The hash function return value must be the same for values which are equivalent by the equivalence operator for Key.

Values are copied into the dictionary, which could be undesirable if the stored objects are complicated and copying is expensive.  Value dictionaries should not be used to store objects of a base class if any derived types of different sizes would be stored in the dictionary, or if the destructor for a derived class must be called.

The WCExcept class is a base class of the WCValHashDict<Key,Value> class and provides the exceptions member function.  This member function controls the exceptions which can be thrown by the WCValHashDict<Key,Value> object.  No exceptions are enabled unless they are set by the exceptions member function.

Requirements of Key and Value

The WCValHashDict<Key,Value> class requires Key to have:
A default constructor ( Key::Key() ).

A well defined copy constructor ( Key::Key( const Key & ) ).

A well defined assignment operator ( Key & operator =( const Key & ) ).

A well defined equivalence operator with constant parameters

( int operator ==( const Key & ) const ).
The WCValHashDict<Key,Value> class requires Value to have:

A default constructor ( Value::Value() ).

A well defined copy constructor ( Value::Value( const Value & ) ).

A well defined assignment operator ( Value & operator =( const Value & ) ).

Public Member Functions

The following member functions are declared in the public interface:

WCValHashDict( unsigned (*hash_fn)( const Key & ), unsigned = WC_DEFAULT_HASH_SIZE );
WCValHashDict( unsigned (*hash_fn)( const Key & ), unsigned = WC_DEFAULT_HASH_SIZE, void * (*user_alloc)( size_t size ), void (*user_dealloc)( void *old, size_t size ) );
WCValHashDict( const WCValHashDict & );
virtual ~WCValHashDict();
static unsigned bitHash( const void *, size_t );
unsigned buckets() const;
void clear();
int contains( const Key & ) const;
unsigned entries() const;
int find( const Key &, Value & ) const;
int findKeyAndValue( const Key &, Key &, Value & ) const;
void forAll( void (*user_fn)( Key, Value, void * ), void * );
int insert( const Key &, const Value & );
int isEmpty() const;
int remove( const Key & );
void resize( unsigned );

Public Member Operators

The following member operators are declared in the public interface:

Value & operator []( const Key & );
const Value & operator []( const Key & ) const;
WCValHashDict & operator =( const WCValHashDict & );
int operator ==( const WCValHashDict & ) const;

WCValHashDict() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
WCValHashDict( unsigned (*hash_fn)( const Key & ),
unsigned = WC_DEFAULT_HASH_SIZE );

Semantics:

The public WCValHashDict<Key,Value> constructor creates an WCValHashDict<Key,Value> object with no entries and with the number of buckets in the second optional parameter, which defaults to the constant WC_DEFAULT_HASH_SIZE (currently defined as 101).  The number of buckets specified must be greater than zero, and will be forced to at least one.  If the hash dictionary object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If the out_of_memory exception is enabled, then attempting to insert into a hash table with zero buckets with throw an out_of_memory error.
The hash function hash_fn is used to determine which bucket each key-value pair will be assigned.  If no hash function exists, the static member function bitHash is available to help create one.

Results:

The public WCValHashDict<Key,Value> constructor creates an initialized WCValHashDict<Key,Value> object with the specified number of buckets and hash function.

See Also:

~WCValHashDict, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCValHashDict( unsigned (*hash_fn)( const Key & ),
unsigned = WC_DEFAULT_HASH_SIZE,
void * (*user_alloc)( size_t ),
void (*user_dealloc)( void *, size_t ) );

Semantics:

Allocator and deallocator functions are specified for use when entries are inserted and removed from the hash dictionary.   The semantics of this constructor are the same as the constructor without the memory management functions.
The allocation function must return a zero if it cannot perform the allocation.  The deallocation function is passed the size as well as the pointer to the data.  Your allocation system may take advantage of the characteristic that the allocation function will always be called with the same size value for any particular instantiation of a hash dictionary.   To determine the size of the objects that the memory management functions will be required to allocate and free, the following macro may be used:

WCValHashDictItemSize( Key, Value )

Results:

The public WCValHashDict<Key,Value> constructor creates an initialized WCValHashDict<Key,Value> object with the specified number of buckets and hash function.

See Also:

~WCValHashDict, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCValHashDict( const WCValHashDict & );

Semantics:

The public WCValHashDict<Key,Value> constructor is the copy constructor for the WCValHashDict<Key,Value> class.  The new dictionary is created with the same number of buckets, hash function, all values or pointers stored in the dictionary, and the exception trap states.  If the hash dictionary object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If there is not enough memory to copy all of the values in the dictionary, then only some will be copied, and the number of entries will correctly reflect the number copied.  If all of the elements cannot be copied, then the out_of_memory exception is thrown if it is enabled.

Results:

The public WCValHashDict<Key,Value> constructor creates an WCValHashDict<Key,Value> object which is a copy of the passed dictionary.

See Also:

~WCValHashDict, operator =, WCExcept::out_of_memory

~WCValHashDict() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
virtual ~WCValHashDict();

Semantics:

The public ~WCValHashDict<Key,Value> destructor is the destructor for the WCValHashDict<Key,Value> class.  If the number of dictionary elements is not zero and the not_empty exception is enabled, the exception is thrown.  Otherwise, the dictionary elements are cleared using the clear member function.  The call to the public ~WCValHashDict<Key,Value> destructor is inserted implicitly by the compiler at the point where the WCValHashDict<Key,Value> object goes out of scope.

Results:

The public ~WCValHashDict<Key,Value> destructor destroys an WCValHashDict<Key,Value> object.

See Also:

clear, WCExcept::not_empty

bitHash() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
static unsigned bitHash( void *, size_t );

Semantics:

The bitHash public member function can be used to implement a hashing function for any type.  A hashing value is generated from the value stored for the number of specified bytes pointed to by the first parameter.  For example:
unsigned my_hash_fn( const int & key ) {
    return( WCValHashDict<int,String>::bitHash( &key, sizeof( int ) );
}
WCValHashDict<int,String> data_object( &my_hash_fn );

Results:

The bitHash public member function returns an unsigned value which can be used as the basis of a user defined hash function.

See Also:

WCValHashDict

buckets() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
unsigned buckets const;

Semantics:

The buckets public member function is used to find the number of buckets contained in the WCValHashDict<Key,Value> object.

Results:

The buckets public member function returns the number of buckets in the dictionary.

See Also:

resize

clear() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void clear();

Semantics:

The clear public member function is used to clear the dictionary so that it has no entries.  The number of buckets remain unaffected.  Elements stored in the dictionary are destroyed using the destructors of Key and of Value.  The dictionary object is not destroyed and re-created by this function, so the object destructor is not invoked.

Results:

The clear public member function clears the dictionary to have no elements.

See Also:

~WCValHashDict, operator =

contains() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int contains( const Key & ) const;

Semantics:

The contains public member function returns non-zero if an element with the specified key is stored in the dictionary, or zero if there is no equivalent element.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The contains public member function returns a non-zero value if the Key is found in the dictionary.

See Also:

find, findKeyAndValue

entries() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
unsigned entries() const;

Semantics:

The entries public member function is used to return the current number of elements stored in the dictionary.

Results:

The entries public member function returns the number of elements in the dictionary.

See Also:

buckets, isEmpty

find() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int find( const Key &, Value & ) const;

Semantics:

The find public member function is used to find an element with an equivalent key in the dictionary.  If an equivalent element is found, a non-zero value is returned.  The reference to a Value passed as the second argument is assigned the found element's Value.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The element equivalent to the passed key is located in the dictionary.

See Also:

findKeyAndValue

findKeyAndValue() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int findKeyAndValue( const Key &, Key &, Value & ) const;

Semantics:

The findKeyAndValue public member function is used to find an element in the dictionary with an key equivalent to the first parameter.  If an equivalent element is found, a non-zero value is returned.  The reference to a Key passed as the second parameter is assigned the found element's key.  The reference to a Value passed as the third argument is assigned the found element's Value.  Zero is returned if the element is not found.   Note that equivalence is based on the equivalence operator of the Key type.

Results:

The element equivalent to the passed key is located in the dictionary.

See Also:

findKeyAndValue

forAll() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void forAll(
void (*user_fn)( Key, Value, void * ),
void * );

Semantics:

The forAll public member function causes the user supplied function to be invoked for every key-value pair in the dictionary.  The user function has the prototype
void user_func( Key key, Value value, void * data );

As the elements are visited, the user function is invoked with the Key and Value components of the element passed as the first two parameters.  The second parameter of the forAll function is passed as the third parameter to the user function.  This value can be used to pass any appropriate data from the main code to the user function.

Results:

The elements in the dictionary are all visited, with the user function being invoked for each one.

See Also:

find, findKeyAndValue

insert() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int insert( const Key &, const Value & );

Semantics:

The insert public member function inserts a key and value into the dictionary, using the hash function on the key to determine to which bucket it should be stored.  If allocation of the node to store the key-value pair fails, then the out_of_memory exception is thrown if it is enabled.  If the exception is not enabled, the insert will not be completed.
At some point, the number of buckets initially selected may be too small for the number of elements inserted.  The resize of the dictionary can be controlled by the insertion mechanism by using WCValHashDict as a base class, and providing an insert member function to do a resize when appropriate.  This insert could then call WCValHashDict::insert to insert the element.  Note that copy constructors and assignment operators are not inherited in your class, but you can provide the following inline definitions (assuming that the class inherited from WCValHashDict is named MyHashDict):

inline MyHashDict( const MyHashDict &orig ) : WCValHashDict( orig ) {};
inline MyHashDict &operator=( const MyHashDict &orig ) {
    return( WCValHashDict::operator=( orig ) );
}

Results:

The insert public member function inserts a key and value into the dictionary.  If the insert is successful, a non-zero will returned.  A zero will be returned if the insert fails.

See Also:

operator =, WCExcept::out_of_memory

isEmpty() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int isEmpty() const;

Semantics:

The isEmpty public member function is used to determine if the dictionary is empty.

Results:

The isEmpty public member function returns zero if it contains at least one entry, non-zero if the dictionary is empty.

See Also:

buckets, entries

operator []() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
Value & operator[]( const Key & );

Semantics:

operator [] is the dictionary index operator.  A reference to the object stored in the dictionary with the given Key is returned.  If no equivalent element is found, then a new key-value pair is created with the specified Key value, and initialized with the default constructor.  The returned reference can then be assigned to, so that insertions can be made with the operator.
WCValHashDict<int,String> data_object( &my_hash_fn );
data_object[ 5 ] = "Hello";

If an allocation error occurs while inserting a new key-value pair, then the out_of_memory exception is thrown if it is enabled.  If the exception is not enabled, then a reference to address zero will be returned.  This will result in a run-time error on systems which trap address zero references.

Results:

The operator [] public member function returns a reference to the element at the given key value.  If the key does not exist, a reference to a created element is returned.  The result of the operator may be assigned to.

See Also:

WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
const Value & operator[]( const Key & ) const;

Semantics:

operator [] is the dictionary index operator.  A constant reference to the object stored in the dictionary with the given Key is returned.  If no equivalent element is found, then the index_range exception is thrown if it is enabled.  If the exception is not enabled, then a reference to address zero will be returned.  This will result in a run-time error on systems which trap address zero references.

Results:

The operator [] public member function returns a constant reference to the element at the given key value.   The result of the operator may not be assigned to.

See Also:

WCExcept::index_range

operator =() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
WCValHashDict & operator =( const WCValHashDict & );

Semantics:

The operator = public member function is the assignment operator for the WCValHashDict<Key,Value> class.  The left hand side dictionary is first cleared using the clear member function, and then the right hand side dictionary is copied.  The hash function, exception trap states, and all of the dictionary elements are copied.   If an allocation failure occurs when creating the buckets, the table will be created with zero buckets, and the out_of_memory exception is thrown if it is enabled.  If there is not enough memory to copy all of the values or pointers in the dictionary, then only some will be copied, and the out_of_memory exception is thrown if it is enabled.   The number of entries will correctly reflect the number copied.

Results:

The operator = public member function assigns the left hand side dictionary to be a copy of the right hand side.

See Also:

clear, WCExcept::out_of_memory

operator ==() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int operator ==( const WCValHashDict & ) const;

Semantics:

The operator == public member function is the equivalence operator for the WCValHashDict<Key,Value> class.  Two dictionary objects are equivalent if they are the same object and share the same address.

Results:

A TRUE (non-zero) value is returned if the left hand side and right hand side dictionary are the same object.  A FALSE (zero) value is returned otherwise.

remove() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
int remove( const Key & );

Semantics:

The remove public member function is used to remove the specified element from the dictionary.  If an equivalent element is found, a non-zero value is returned.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the Key type.

Results:

The element is removed from the dictionary if it found.

resize() [WCValHashDict<Key,Value>]

Synopsis:

#include <wchash.h>
public:
void resize( unsigned );

Semantics:

The resize public member function is used to change the number of buckets contained in the dictionary.  If the new number is larger than the previous dictionary size, then the hash function will be used on all of the stored elements to determine which bucket they should be stored into.  Entries are not destroyed or created in the process of being moved.  If there is not enough memory to resize the dictionary, the out_of_memory exception is thrown if it is enabled, and the dictionary will contain the number of buckets it contained before the resize.  If the new number is zero, then the zero_buckets exception is thrown if it is enabled, and no resize will be performed.  The dictionary is guaranteed to contain the same number of entries after the resize.

Results:

The dictionary is resized to the new number of buckets.

See Also:

WCExcept::out_of_memory, WCExcept::zero_buckets

WCValHashTable<Type>, WCValHashSet<Type> Class Description

Declared:

wchash.h
WCValHashTable<Type> and WCValHashSet<Type> classes are templated classes used to store objects in a hash.  A hash saves objects in such a way as to make it efficient to locate and retrieve an element.  As an element is looked up or inserted into the hash, the value of the element is hashed.  Hashing results in a numeric index which is used to locate the value.  The storage area referenced by the hash value is usually called a bucket.   If more than one element results in the same hash, the value associated with the hash is placed in a list stored in the bucket.  A hash table allows more than one copy of an element that is equivalent, while the hash set allows only one copy.  The equality operator of the element's type is used to locate the value.
In the description of each member function, the text Type is used to indicate the template parameter defining the type of the data to be stored in the hash.

The constructor for the WCValHashTable<Type> and WCValHashSet<Type> classes requires a hashing function, which given a reference to Type, returns an unsigned value.  The returned value modulo the number of buckets determines the bucket into which the element will be located.  The return values of the hash function can be spread over the entire range of unsigned numbers.  The hash function return value must be the same for values which are equivalent by the equivalence operator for Type.

Values are copied into the hash, which could be undesirable if the stored objects are complicated and copying is expensive.   Value hashes should not be used to store objects of a base class if any derived types of different sizes would be stored in the hash, or if the destructor for a derived class must be called.

The WCExcept class is a base class of the WCValHashTable<Type> and WCValHashSet<Type> classes and provides the exceptions member function.  This member function controls the exceptions which can be thrown by the WCValHashTable<Type> and WCValHashSet<Type> objects.  No exceptions are enabled unless they are set by the exceptions member function.

Requirements of Type

The WCValHashTable<Type> and WCValHashSet<Type> classes requires Type to have:
A default constructor ( Type::Type() ).

A well defined copy constructor ( Type::Type( const Type & ) ).

A well defined assignment operator ( Type & operator =( const Type & ) ).

A well defined equivalence operator with constant parameters

( int operator ==( const Type & ) const ).

Public Member Functions

The following member functions are declared in the public interface:

WCValHashSet( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE );
WCValHashSet( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE, void * (*user_alloc)( size_t size ), void (*user_dealloc)( void *old, size_t size ) );
WCValHashSet( const WCValHashSet & );
virtual ~WCValHashSet();
WCValHashTable( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE );
WCValHashTable( unsigned (*hash_fn)( const Type & ), unsigned = WC_DEFAULT_HASH_SIZE, void * (*user_alloc)( size_t size ), void (*user_dealloc)( void *old, size_t size ) );
WCValHashTable( const WCValHashTable & );
virtual ~WCValHashTable();
static unsigned bitHash( const void *, size_t );
unsigned buckets() const;
void clear();
int contains( const Type & ) const;
unsigned entries() const;
int find( const Type &, Type & ) const;
void forAll( void (*user_fn)( Type, void * ), void * );
int insert( const Type & );
int isEmpty() const;
int remove( const Type & );
void resize( unsigned );

The following public member functions are available for the WCValHashTable class only:

unsigned occurrencesOf( const Type & ) const;
unsigned removeAll( const Type & );

Public Member Operators

The following member operators are declared in the public interface:

WCValHashSet & operator =( const WCValHashSet & );
int operator ==( const WCValHashSet & ) const;
WCValHashTable & operator =( const WCValHashTable & );
int operator ==( const WCValHashTable & ) const;

WCValHashSet() [WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
WCValHashSet( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE );

Semantics:

The WCValHashSet<Type> constructor creates a WCValHashSet object with no entries and with the number of buckets in the second optional parameter, which defaults to the constant WC_DEFAULT_HASH_SIZE (currently defined as 101).  The number of buckets specified must be greater than zero, and will be forced to at least one.  If the hash object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If the out_of_memory exception is enabled, then attempting to insert into a hash table with zero buckets with throw an out_of_memory error.
The hash function hash_fn is used to determine which bucket each value will be assigned to.  If no hash function exists, the static member function bitHash is available to help create one.

Results:

The WCValHashSet<Type> constructor creates an initialized WCValHashSet object with the specified number of buckets and hash function.

See Also:

~WCValHashSet, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCValHashSet( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE,
void * (*user_alloc)( size_t ),
void (*user_dealloc)( void *, size_t ) );

Semantics:

Allocator and deallocator functions are specified for use when entries are inserted and removed from the hash.  The semantics of this constructor are the same as the constructor without the memory management functions.
The allocation function must return a zero if it cannot perform the allocation.  The deallocation function is passed the size as well as the pointer to the data.  Your allocation system may take advantage of the characteristic that the allocation function will always be called with the same size value for any particular instantiation of a hash.  To determine the size of the objects that the memory management functions will be required to allocate and free, the following macro may be used:

WCValHashSetItemSize( Type )

Results:

The WCValHashSet<Type> constructor creates an initialized WCValHashSet object with the specified number of buckets and hash function.

See Also:

~WCValHashSet, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCValHashSet( const WCValHashSet & );

Semantics:

The WCValHashSet<Type> is the copy constructor for the WCValHashSet class.  The new hash is created with the same number of buckets, hash function, all values or pointers stored in the hash, and the exception trap states.   If the hash object can be created, but an allocation failure occurs when creating the buckets, the hash will be created with zero buckets.  If there is not enough memory to copy all of the values, then only some will be copied, and the number of entries will correctly reflect the number copied.  If all of the elements cannot be copied, then the out_of_memory exception is thrown if it is enabled.

Results:

The WCValHashSet<Type> constructor creates a WCValHashSet object which is a copy of the passed hash.

See Also:

~WCValHashSet, operator =, WCExcept::out_of_memory

~WCValHashSet() [WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
virtual ~WCValHashSet();

Semantics:

The WCValHashSet<Type> destructor is the destructor for the WCValHashSet class.  If the number of elements is not zero and the not_empty exception is enabled, the exception is thrown.  Otherwise, the hash elements are cleared using the clear member function.  The call to the WCValHashSet<Type> destructor is inserted implicitly by the compiler at the point where the WCValHashSet object goes out of scope.

Results:

The call to the WCValHashSet<Type> destructor destroys a WCValHashSet object.

See Also:

clear, WCExcept::not_empty

WCValHashTable() [WCValHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
WCValHashTable( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE );

Semantics:

The WCValHashTable<Type> constructor creates a WCValHashTable object with no entries and with the number of buckets in the second optional parameter, which defaults to the constant WC_DEFAULT_HASH_SIZE (currently defined as 101).  The number of buckets specified must be greater than zero, and will be forced to at least one.  If the hash object can be created, but an allocation failure occurs when creating the buckets, the table will be created with zero buckets.  If the out_of_memory exception is enabled, then attempting to insert into a hash table with zero buckets with throw an out_of_memory error.
The hash function hash_fn is used to determine which bucket each value will be assigned to.  If no hash function exists, the static member function bitHash is available to help create one.

Results:

The WCValHashTable<Type> constructor creates an initialized WCValHashTable object with the specified number of buckets and hash function.

See Also:

~WCValHashTable, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCValHashTable( unsigned (*hash_fn)( const Type & ),
unsigned = WC_DEFAULT_HASH_SIZE,
void * (*user_alloc)( size_t ),
void (*user_dealloc)( void *, size_t ) );

Semantics:

Allocator and deallocator functions are specified for use when entries are inserted and removed from the hash.  The semantics of this constructor are the same as the constructor without the memory management functions.
The allocation function must return a zero if it cannot perform the allocation.  The deallocation function is passed the size as well as the pointer to the data.  Your allocation system may take advantage of the characteristic that the allocation function will always be called with the same size value for any particular instantiation of a hash.  To determine the size of the objects that the memory management functions will be required to allocate and free, the following macro may be used:

WCValHashTableItemSize( Type )

Results:

The WCValHashTable<Type> constructor creates an initialized WCValHashTable object with the specified number of buckets and hash function.

See Also:

~WCValHashTable, bitHash, WCExcept::out_of_memory

Synopsis:

#include <wchash.h>
public:
WCValHashTable( const WCValHashTable & );

Semantics:

The WCValHashTable<Type> is the copy constructor for the WCValHashTable class.  The new hash is created with the same number of buckets, hash function, all values or pointers stored in the hash, and the exception trap states.  If the hash object can be created, but an allocation failure occurs when creating the buckets, the hash will be created with zero buckets.  If there is not enough memory to copy all of the values, then only some will be copied, and the number of entries will correctly reflect the number copied.  If all of the elements cannot be copied, then the out_of_memory exception is thrown if it is enabled.

Results:

The WCValHashTable<Type> constructor creates a WCValHashTable object which is a copy of the passed hash.

See Also:

~WCValHashTable, operator =, WCExcept::out_of_memory

~WCValHashTable() [WCValHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
virtual ~WCValHashTable();

Semantics:

The WCValHashTable<Type> destructor is the destructor for the WCValHashTable class.  If the number of elements is not zero and the not_empty exception is enabled, the exception is thrown.  Otherwise, the hash elements are cleared using the clear member function.  The call to the WCValHashTable<Type> destructor is inserted implicitly by the compiler at the point where the WCValHashTable object goes out of scope.

Results:

The call to the WCValHashTable<Type> destructor destroys a WCValHashTable object.

See Also:

clear, WCExcept::not_empty

bitHash() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
static unsigned bitHash( void *, size_t );

Semantics:

The bitHash public member function can be used to implement a hashing function for any type.  A hashing value is generated from the value stored for the number of specified bytes pointed to by the first parameter.  For example:
unsigned my_hash_fn( const int & elem ) {
    return( WCValHashSet<int,String>::bitHash(&elem, sizeof(int));
}
WCValHashSet<int> data_object( &my_hash_fn );

Results:

The bitHash public member function returns an unsigned value which can be used as the basis of a user defined hash function.

See Also:

WCValHashSet, WCValHashTable

buckets() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned buckets() const;

Semantics:

The buckets public member function is used to find the number of buckets contained in the hash object.

Results:

The buckets public member function returns the number of buckets in the hash.

See Also:

resize

clear() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void clear();

Semantics:

The clear public member function is used to clear the hash so that it has no entries.  The number of buckets remain unaffected.  Elements stored in the hash are destroyed using the destructors of Type.  The hash object is not destroyed and re-created by this function, so the object destructor is not invoked.

Results:

The clear public member function clears the hash to have no elements.

See Also:

~WCValHashSet, ~WCValHashTable, operator =

contains() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int contains( const Type & ) const;

Semantics:

The contains public member function returns non-zero if the element is stored in the hash, or zero if there is no equivalent element.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The contains public member function returns a non-zero value if the element is found in the hash.

See Also:

find

entries() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned entries() const;

Semantics:

The entries public member function is used to return the current number of elements stored in the hash.

Results:

The entries public member function returns the number of elements in the hash.

See Also:

buckets, isEmpty

find() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int find( const Type &, Type & ) const;

Semantics:

The find public member function is used to find an element with an equivalent key in the hash.  If an equivalent element is found, a non-zero value is returned.  The reference to the element passed as the second argument is assigned the found element's value.  Zero is returned if the element is not found.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The element equivalent to the passed key is located in the hash.

forAll() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void forAll(
void (*user_fn)( Type, void * ),
void * );

Semantics:

The forAll public member function causes the user supplied function to be invoked for every value in the hash.  The user function has the prototype
void user_func( Type & value, void * data );

As the elements are visited, the user function is invoked with the element passed as the first.  The second parameter of the forAll function is passed as the second parameter to the user function.  This value can be used to pass any appropriate data from the main code to the user function.

Results:

The elements in the hash are all visited, with the user function being invoked for each one.

See Also:

find

insert() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int insert( const Type & );

Semantics:

The insert public member function inserts a value into the hash, using the hash function to determine to which bucket it should be stored.  If allocation of the node to store the value fails, then the out_of_memory exception is thrown if it is enabled.  If the exception is not enabled, the insert will not be completed.
With a WCValHashSet, there must be only one equivalent element in the set.  If an element equivalent to the inserted element is already in the hash set, the hash set will remain unchanged, and the not_unique exception is thrown if it is enabled.  If the exception is not enabled, the insert will not be completed.

At some point, the number of buckets initially selected may be too small for the number of elements inserted.  The resize of the hash can be controlled by the insertion mechanism by using WCValHashSet (or WCValHashTable) as a base class, and providing an insert member function to do a resize when appropriate.  This insert could then call WCValHashSet::insert (or WCValHashTable::insert) to insert the element.  Note that copy constructors and assignment operators are not inherited in your class, but you can provide the following inline definitions (assuming that the class inherited from WCValHashTable is named MyHashTable):

inline MyHashTable( const MyHashTable &orig )
     : WCValHashTable( orig ) {};
inline MyHashTable &operator=( const MyHashTable &orig ) {
    return( WCValHashTable::operator=( orig ) );
}

Results:

The insert public member function inserts a value into the hash.  If the insert is successful, a non-zero will returned.  A zero will be returned if the insert fails.

See Also:

operator =, WCExcept::out_of_memory

isEmpty() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int isEmpty() const;

Semantics:

The isEmpty public member function is used to determine if the hash is empty.

Results:

The isEmpty public member function returns zero if it contains at least one entry, non-zero if the hash is empty.

See Also:

buckets, entries

occurencesOf() [WCValHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned occurrencesOf( const Type & ) const;

Semantics:

The occurencesOf public member function is used to return the current number of elements stored in the hash which are equivalent to the passed value.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The occurencesOf public member function returns the number of elements in the hash.

See Also:

buckets, entries, find, isEmpty

operator =() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
WCValHashSet & operator =( const WCValHashSet & );
WCValHashTable & operator =( const WCValHashTable & );

Semantics:

The operator = public member function is the assignment operator for the WCValHashTable<Type> and WCValHashSet<Type> classes.  The left hand side hash is first cleared using the clear member function, and then the right hand side hash is copied.  The hash function, exception trap states, and all of the hash elements are copied.  If an allocation failure occurs when creating the buckets, the table will be created with zero buckets, and the out_of_memory exception is thrown if it is enabled.  If there is not enough memory to copy all of the values or pointers in the hash, then only some will be copied, and the out_of_memory exception is thrown if it is enabled.  The number of entries will correctly reflect the number copied.

Results:

The operator = public member function assigns the left hand side hash to be a copy of the right hand side.

See Also:

clear, WCExcept::out_of_memory

operator ==() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int operator ==( const WCValHashSet & ) const;
int operator ==( const WCValHashTable & ) const;

Semantics:

The operator == public member function is the equivalence operator for the WCValHashTable<Type> and WCValHashSet<Type> classes.  Two hash objects are equivalent if they are the same object and share the same address.

Results:

A TRUE (non-zero) value is returned if the left hand side and right hand side hash are the same object.  A FALSE (zero) value is returned otherwise.

remove() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
int remove( const Type & );

Semantics:

The remove public member function is used to remove the specified element from the hash.  If an equivalent element is found, a non-zero value is returned.  Zero is returned if the element is not found.  If the hash is a table and there is more than one element equivalent to the specified element, then the first equivalent element added to the table is removed.  Note that equivalence is based on the equivalence operator of the element type.

Results:

The element is removed from the hash if it found.

removeAll() [WCValHashTable<Type>]

Synopsis:

#include <wchash.h>
public:
unsigned removeAll( const Type & );

Semantics:

The removeAll public member function is used to remove all elements equivalent to the specified element from the hash.  Zero is returned if no equivalent elements are found.  Note that equivalence is based on the equivalence operator of the element type.

Results:

All equivalent elements are removed from the hash.

resize() [WCValHashTable<Type>,WCValHashSet<Type>]

Synopsis:

#include <wchash.h>
public:
void resize( unsigned );

Semantics:

The resize public member function is used to change the number of buckets contained in the hash.  If the new number is larger than the previous hash size, then the hash function will be used on all of the stored elements to determine which bucket they should be stored into.  Entries are not destroyed or created in the process of being moved.  If there is not enough memory to resize the hash, the out_of_memory exception is thrown if it is enabled, and the hash will contain the number of buckets it contained before the resize.  If the new number is zero, then the zero_buckets exception is thrown if it is enabled, and no resize will be performed.  The hash is guaranteed to contain the same number of entries after the resize.

Results:

The hash is resized to the new number of buckets.

See Also:

WCExcept::out_of_memory, WCExcept::zero_buckets

Hash Iterators

WCPtrHashDictIter<Key,Value> Class Description

Declared:

wchiter.h
The WCPtrHashDictIter<Key,Value> class is the templated class used to create iterator objects for WCPtrHashDict<Key,Value> objects.  In the description of each member function, the text Key is used to indicate the template parameter defining the type of the indices pointed to by the pointers stored in the dictionary.  The text Value is used to indicate the template parameter defining the type of the data pointed to by the pointers stored in the dictionary.  The WCIterExcept class is a base class of the WCPtrHashDictIter<Key,Value> class and provides the exceptions member function.  This member function controls the exceptions which can be thrown by the WCPtrHashDictIter<Key,Value> object.  No exceptions are enabled unless they are set by the exceptions member function.

Public Member Functions

The following member functions are declared in the public interface:

WCPtrHashDictIter();
WCPtrHashDictIter( const WCPtrHashDict<Key,Value> & );
~WCPtrHashDictIter();
const WCPtrHashDict<Key,Value> *container() const;
Key *key();
void reset();
void reset( WCPtrHashDict<Key,Value> & );
Value * value();

Public Member Operators

The following member operators are declared in the public interface:

int operator ()();
int operator ++();

WCPtrHashDictIter() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
WCPtrHashDictIter();

Semantics:

The public WCPtrHashDictIter<Key,Value> constructor is the default constructor for the class and initializes the iterator with no hash to operate on.  The reset member function must be called to provide the iterator with a hash to iterate over.

Results:

The public WCPtrHashDictIter<Key,Value> constructor creates an initialized WCPtrHashDictIter hash iterator object.

See Also:

~WCPtrHashDictIter, reset

Synopsis:

#include <wchiter.h>
public:
WCPtrHashDictIter( WCPtrHashDict<Key,Value> & );

Semantics:

The public WCPtrHashDictIter<Key,Value> constructor is a constructor for the class.  The value passed as a parameter is a WCPtrHashDict hash object.  The iterator will be initialized for that hash object and positioned before the first hash element.  To position the iterator to a valid element within the hash, increment it using one of the operator ++ or operator () operators.

Results:

The public WCPtrHashDictIter<Key,Value> constructor creates an initialized WCPtrHashDictIter hash iterator object positioned before the first element in the hash.

See Also:

~WCPtrHashDictIter, operator (), operator ++, reset

~WCPtrHashDictIter() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
~WCPtrHashDictIter();

Semantics:

The public ~WCPtrHashDictIter<Key,Value> destructor is the destructor for the class.  The call to the destructor is inserted implicitly by the compiler at the point where the WCPtrHashDictIter hash iterator object goes out of scope.

Results:

The WCPtrHashDictIter hash iterator object is destroyed.

See Also:

WCPtrHashDictIter

container() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
WCPtrHashDict<Key,Value> *container() const;

Semantics:

The container public member function returns a pointer to the hash container object.  If the iterator has not been initialized with a hash object, and the undef_iter exception is enabled, the exception is thrown.

Results:

A pointer to the hash object associated with the iterator is returned, or NULL(0) if the iterator has not been initialized with a hash.

See Also:

WCPtrHashDictIter, reset, WCIterExcept::undef_iter

key() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
Key *key();

Semantics:

The key public member function returns a pointer to the Key value of the hash item at the current iterator position.
If the iterator is not associated with a hash, or the iterator position is either before the first element or past the last element in the hash, the current iterator position is undefined.  In this case the undef_item exception is thrown, if enabled.

Results:

A pointer to Key at the current iterator element is returned.  If the current element is undefined, an undefined pointer is returned.

See Also:

operator (), operator ++, reset, WCIterExcept::undef_item

operator ()() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
int operator ()();

Semantics:

The operator () public member function is the call operator for the class.  The hash element which follows the current item is set to be the new current item.  If the previous current item was the last element in the hash, the iterator is positioned after the end of the hash.
The operator () public member function has the same semantics as the pre-increment operator, operator ++.

If the iterator was positioned before the first hash element, the current item will be set to the first element.  If the hash is empty, the iterator will be positioned after the end of the hash.

If the iterator is not associated with a hash or the iterator position before the increment was past the last element the hash, the undef_iter exception is thrown, if enabled.

Results:

The operator () public member function returns a non-zero value if the iterator is positioned on a hash item.  Zero(0) is returned when the iterator is incremented past the end of the hash.

See Also:

operator ++, reset, WCIterExcept::undef_iter

operator ++() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
int operator ++();

Semantics:

The operator ++ public member function is the pre-increment operator for the class.  The hash element which follows the current item is set to be the new current item.  If the previous current item was the last element in the hash, the iterator is positioned after the end of the hash.
The operator ++ public member function has the same semantics as the call operator, operator ().

The current item will be set to the first hash element if the iterator was positioned before the first element in the hash.  If the hash is empty, the iterator will be positioned after the end of the hash.

If the iterator is not associated with a hash or the iterator position before the increment was past the last element the hash, the undef_iter exception is thrown, if enabled.

Results:

The operator ++ public member function returns a non-zero value if the iterator is positioned on a hash item.  Zero(0) is returned when the iterator is incremented past the end of the hash.

See Also:

operator (), reset, WCIterExcept::undef_iter

reset() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
void reset();

Semantics:

The reset public member function resets the iterator to the initial state, positioning the iterator before the first element in the associated hash.

Results:

The iterator is positioned before the first hash element.

See Also:

WCPtrHashDictIter, container

Synopsis:

#include <wchiter.h>
public:
void reset( WCPtrHashDict<Key,Value> & );

Semantics:

The reset public member function resets the iterator to operate on the specified hash.  The iterator is positioned before the first element in the hash.

Results:

The iterator is positioned before the first element of the specified hash.

See Also:

WCPtrHashDictIter, container

value() [WCPtrHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
Value *value();

Semantics:

The value public member function returns a pointer to the Value the current iterator position.
If the iterator is not associated with a hash, or the iterator position is either before the first element or past the last element in the hash, the current iterator position is undefined.  In this case the undef_item exception is thrown, if enabled.

Results:

A pointer to the Value at the current iterator element is returned.  If the current element is undefined, an undefined pointer is returned.

See Also:

operator (), operator ++, reset, WCIterExcept::undef_item

WCValHashDictIter<Key,Value> Class Description

Declared:

wchiter.h
The WCValHashDictIter<Key,Value> class is the templated class used to create iterator objects for WCValHashDict<Key,Value> objects.  In the description of each member function, the text Key is used to indicate the template parameter defining the type of the indices used to store data in the dictionary.  The text Value is used to indicate the template parameter defining the type of the data stored in the dictionary.  The WCIterExcept class is a base class of the WCValHashDictIter<Key,Value> class and provides the exceptions member function.   This member function controls the exceptions which can be thrown by the WCValHashDictIter<Key,Value> object.  No exceptions are enabled unless they are set by the exceptions member function.

Public Member Functions

The following member functions are declared in the public interface:

WCValHashDictIter();
WCValHashDictIter( const WCValHashDict<Key,Value> & );
~WCValHashDictIter();
const WCValHashDict<Key,Value> *container() const;
Key key();
void reset();
void reset( WCValHashDict<Key,Value> & );
Value value();

Public Member Operators

The following member operators are declared in the public interface:

int operator ()();
int operator ++();

WCValHashDictIter() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
WCValHashDictIter();

Semantics:

The public WCValHashDictIter<Key,Value> constructor is the default constructor for the class and initializes the iterator with no hash to operate on.  The reset member function must be called to provide the iterator with a hash to iterate over.

Results:

The public WCValHashDictIter<Key,Value> constructor creates an initialized WCValHashDictIter hash iterator object.

See Also:

~WCValHashDictIter, reset

Synopsis:

#include <wchiter.h>
public:
WCValHashDictIter( WCValHashDict<Key,Value> & );

Semantics:

The public WCValHashDictIter<Key,Value> constructor is a constructor for the class.  The value passed as a parameter is a WCValHashDict hash object.  The iterator will be initialized for that hash object and positioned before the first hash element.  To position the iterator to a valid element within the hash, increment it using one of the operator ++ or operator () operators.

Results:

The public WCValHashDictIter<Key,Value> constructor creates an initialized WCValHashDictIter hash iterator object positioned before the first element in the hash.

See Also:

~WCValHashDictIter, operator (), operator ++, reset

~WCValHashDictIter() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
~WCValHashDictIter();

Semantics:

The public ~WCValHashDictIter<Key,Value> destructor is the destructor for the class.  The call to the destructor is inserted implicitly by the compiler at the point where the WCValHashDictIter hash iterator object goes out of scope.

Results:

The WCValHashDictIter hash iterator object is destroyed.

See Also:

WCValHashDictIter

container() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
WCValHashDict<Key,Value> *container() const;

Semantics:

The container public member function returns a pointer to the hash container object.  If the iterator has not been initialized with a hash object, and the undef_iter exception is enabled, the exception is thrown.

Results:

A pointer to the hash object associated with the iterator is returned, or NULL(0) if the iterator has not been initialized with a hash.

See Also:

WCValHashDictIter, reset, WCIterExcept::undef_iter

key() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
Key key();

Semantics:

The key public member function returns the value of Key at the current iterator position.
If the iterator is not associated with a hash, or the iterator position is either before the first element or past the last element in the hash, the current iterator position is undefined.  In this case the undef_item exception is thrown, if enabled.

Results:

The value of Key at the current iterator element is returned.  If the current element is undefined, a default initialized object is returned.

See Also:

operator (), operator ++, reset, WCIterExcept::undef_item

operator ()() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
int operator ()();

Semantics:

The operator () public member function is the call operator for the class.  The hash element which follows the current item is set to be the new current item.  If the previous current item was the last element in the hash, the iterator is positioned after the end of the hash.
The operator () public member function has the same semantics as the pre-increment operator, operator ++.

If the iterator was positioned before the first hash element, the current item will be set to the first element.  If the hash is empty, the iterator will be positioned after the end of the hash.

If the iterator is not associated with a hash or the iterator position before the increment was past the last element the hash, the undef_iter exception is thrown, if enabled.

Results:

The operator () public member function returns a non-zero value if the iterator is positioned on a hash item.  Zero(0) is returned when the iterator is incremented past the end of the hash.

See Also:

operator ++, reset, WCIterExcept::undef_iter

operator ++() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
int operator ++();

Semantics:

The operator ++ public member function is the pre-increment operator for the class.  The hash element which follows the current item is set to be the new current item.  If the previous current item was the last element in the hash, the iterator is positioned after the end of the hash.
The operator ++ public member function has the same semantics as the call operator, operator ().

The current item will be set to the first hash element if the iterator was positioned before the first element in the hash.  If the hash is empty, the iterator will be positioned after the end of the hash.

If the iterator is not associated with a hash or the iterator position before the increment was past the last element the hash, the undef_iter exception is thrown, if enabled.

Results:

The operator ++ public member function returns a non-zero value if the iterator is positioned on a hash item.  Zero(0) is returned when the iterator is incremented past the end of the hash.

See Also:

operator (), reset, WCIterExcept::undef_iter

reset() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
void reset();

Semantics:

The reset public member function resets the iterator to the initial state, positioning the iterator before the first element in the associated hash.

Results:

The iterator is positioned before the first hash element.

See Also:

WCValHashDictIter, container

Synopsis:

#include <wchiter.h>
public:
void reset( WCValHashDict<Key,Value> & );

Semantics:

The reset public member function resets the iterator to operate on the specified hash.  The iterator is positioned before the first element in the hash.

Results:

The iterator is positioned before the first element of the specified hash.

See Also:

WCValHashDictIter, container

value() [WCValHashDictIter<Key,Value>]

Synopsis:

#include <wchiter.h>
public:
Value value();

Semantics:

The value public member function returns the value of Value at the current iterator position.
If the iterator is not associated with a hash, or the iterator position is either before the first element or past the last element in the hash, the current iterator position is undefined.  In this case the undef_item exception is thrown, if enabled.

Results:

The value of the Value at the current iterator element is returned.  If the current element is undefined, a default initialized object is returned.

See Also:

operator (), operator ++, reset, WCIterExcept::undef_item

WCPtrHashSetIter<Type>, WCPtrHashTableIter<Type> Class Description

Declared:

wchiter.h
The WCPtrHashSetIter<Type> and WCPtrHashTableIter<Type> classes are the templated classes used to create iterator objects for WCPtrHashTable<Type> and WCPtrHashSet<Type> objects.  In the description of each member function, the text Type is used to indicate the hash element type specified as the template parameter.  The WCIterExcept class is a base class of the WCPtrHashSetIter<Type> and WCPtrHashTableIter<Type> classes and provides the exceptions member function.  This member function controls the exceptions which can be thrown by the WCPtrHashSetIter<Type> and WCPtrHashTableIter<Type> objects.  No exceptions are enabled unless they are set by the exceptions member function.

Public Member Functions

The following member functions are declared in the public interface:

WCPtrHashSetIter();
WCPtrHashSetIter( const WCPtrHashSet<Type> & );
~WCPtrHashSetIter();
WCPtrHashTableIter();
WCPtrHashTableIter( const WCPtrHashTable<Type> & );
~WCPtrHashTableIter();
const WCPtrHashTable<Type> *container() const;
const WCPtrHashSet<Type> *container() const;
Type *current() const;
void reset();
void WCPtrHashSetIter<Type>::reset( WCPtrHashSet<Type> & );
void WCPtrHashTableIter<Type>::reset( WCPtrHashTable<Type> & );

Public Member Operators

The following member operators are declared in the public interface:

int operator ()();
int operator ++();

WCPtrHashSetIter() [WCPtrHashSetIter<Type>]

Synopsis:

#include <wchiter.h>
public:
WCPtrHashSetIter();

Semantics:

The public WCPtrHashSetIter<Type> constructor is the default constructor for the class and initializes the iterator with no hash to operate on.  The reset member function must be called to provide the iterator with a hash to iterate over.

Results:

The public WCPtrHashSetIter<Type> constructor creates an initialized WCPtrHashSetIter hash iterator object.

See Also:

~WCPtrHashSetIter, WCPtrHashTableIter, reset

Synopsis:

#include <wchiter.h>
public:
WCPtrHashSetIter( WCPtrHashSet<Type> & );

Semantics:

The public WCPtrHashSetIter<Type> constructor is a constructor for the class.  The value passed as a parameter is a WCPtrHashSet hash object.  The iterator will be initialized for that hash object and positioned before the first hash element.  To position the iterator to a valid element within the hash, increment it using one of the operator ++ or operator () operators.

Results:

The public WCPtrHashSetIter<Type> constructor creates an initialized WCPtrHashSetIter hash iterator object positioned before the first element in the hash.

See Also:

~WCPtrHashSetIter, operator (), operator ++, reset

~WCPtrHashSetIter() [WCPtrHashSetIter<Type>]

Synopsis:

#include <wchiter.h>
public:
~WCPtrHashSetIter();

Semantics:

The public ~WCPtrHashSetIter<Type> destructor is the destructor for the class.  The call to the destructor is inserted implicitly by the compiler at the point where the WCPtrHashSetIter hash iterator object goes out of scope.

Results:

The WCPtrHashSetIter hash iterator object is destroyed.

See Also:

WCPtrHashSetIter, WCPtrHashTableIter

WCPtrHashTableIter() [WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
WCPtrHashTableIter();

Semantics:

The public WCPtrHashTableIter<Type> constructor is the default constructor for the class and initializes the iterator with no hash to operate on.  The reset member function must be called to provide the iterator with a hash to iterate over.

Results:

The public WCPtrHashTableIter<Type> constructor creates an initialized WCPtrHashTableIter hash iterator object.

See Also:

~WCPtrHashTableIter, WCPtrHashSetIter, reset

Synopsis:

#include <wchiter.h>
public:
WCPtrHashTableIter( WCPtrHashTable<Type> & );

Semantics:

The public WCPtrHashTableIter<Type> constructor is a constructor for the class.  The value passed as a parameter is a WCPtrHashTable hash object.  The iterator will be initialized for that hash object and positioned before the first hash element.  To position the iterator to a valid element within the hash, increment it using one of the operator ++ or operator () operators.

Results:

The public WCPtrHashTableIter<Type> constructor creates an initialized WCPtrHashTableIter hash iterator object positioned before the first element in the hash.

See Also:

~WCPtrHashTableIter, operator (), operator ++, reset

~WCPtrHashTableIter() [WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
~WCPtrHashTableIter();

Semantics:

The WCPtrHashTableIter<Type> destructor is the destructor for the class.  The call to the destructor is inserted implicitly by the compiler at the point where the WCPtrHashTableIter hash iterator object goes out of scope.

Results:

The WCPtrHashTableIter hash iterator object is destroyed.

See Also:

WCPtrHashSetIter, WCPtrHashTableIter

container() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
WCPtrHashTable<Type> *WCPtrHashTableIter<Type>::container() const;
WCPtrHashSet<Type> *WCPtrHashSetIter<Type>::container() const;

Semantics:

The container public member function returns a pointer to the hash container object.  If the iterator has not been initialized with a hash object, and the undef_iter exception is enabled, the exception is thrown.

Results:

A pointer to the hash object associated with the iterator is returned, or NULL(0) if the iterator has not been initialized with a hash.

See Also:

WCPtrHashSetIter, WCPtrHashTableIter, reset, WCIterExcept::undef_iter

current() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
Type *current();

Semantics:

The current public member function returns a pointer to the hash item at the current iterator position.
If the iterator is not associated with a hash, or the iterator position is either before the first element or past the last element in the hash, the current iterator position is undefined.  In this case the undef_item exception is thrown, if enabled.

Results:

A pointer to the current iterator element is returned.  If the current element is undefined, NULL(0) is returned.

See Also:

operator (), operator ++, reset, WCIterExcept::undef_item

operator ()() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
int operator ()();

Semantics:

The operator () public member function is the call operator for the class.  The hash element which follows the current item is set to be the new current item.  If the previous current item was the last element in the hash, the iterator is positioned after the end of the hash.
The operator () public member function has the same semantics as the pre-increment operator, operator ++.

If the iterator was positioned before the first hash element, the current item will be set to the first element.  If the hash is empty, the iterator will be positioned after the end of the hash.

If the iterator is not associated with a hash or the iterator position before the increment was past the last element the hash, the undef_iter exception is thrown, if enabled.

Results:

The operator () public member function returns a non-zero value if the iterator is positioned on a hash item.  Zero(0) is returned when the iterator is incremented past the end of the hash.

See Also:

operator ++, reset, WCIterExcept::undef_iter

operator ++() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
int operator ++();

Semantics:

The operator ++ public member function is the pre-increment operator for the class.  The hash element which follows the current item is set to be the new current item.  If the previous current item was the last element in the hash, the iterator is positioned after the end of the hash.
The operator ++ public member function has the same semantics as the call operator, operator ().

The current item will be set to the first hash element if the iterator was positioned before the first element in the hash.  If the hash is empty, the iterator will be positioned after the end of the hash.

If the iterator is not associated with a hash or the iterator position before the increment was past the last element the hash, the undef_iter exception is thrown, if enabled.

Results:

The operator ++ public member function returns a non-zero value if the iterator is positioned on a hash item.  Zero(0) is returned when the iterator is incremented past the end of the hash.

See Also:

current, operator (), reset, WCIterExcept::undef_iter

reset() [WCPtrHashSetIter<Type>,WCPtrHashTableIter<Type>]

Synopsis:

#include <wchiter.h>
public:
void reset();

Semantics:

The reset public member function resets the iterator to the initial state, positioning the iterator before the first element in the associated hash.

Results:

The iterator is positioned before the first hash element.

See Also:

WCPtrHashSetIter, WCPtrHashTableIter, container

Synopsis:

#include <wchiter.h>
public:
void WCPtrHashSetIter<Type>::reset( WCPtrHashSet<Type> & );
void WCPtrHashTableIter<Type>::reset( WCPtrHashTable<Type> & );

Semantics:

The reset public member function resets the iterator to operate on the specified hash.  The iterator is positioned before the first element in the hash.

Results:

The iterator is positioned before the first element of the specified hash.

See Also:

WCPtrHashSetIter, WCPtrHashTableIter, container