1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* Copyright 2002 Adrian Thurston <thurston@colm.net>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef _AAPL_BSTMAP_H
#define _AAPL_BSTMAP_H
#include "compare.h"
#include "vector.h"
#ifdef AAPL_NAMESPACE
namespace Aapl {
#endif
/**
* \brief Element for BstMap.
*
* Stores the key and value pair.
*/
template <class Key, class Value> struct BstMapEl
{
BstMapEl() {}
BstMapEl(const Key &key) : key(key) {}
BstMapEl(const Key &key, const Value &val) : key(key), value(val) {}
/** \brief The key */
Key key;
/** \brief The value. */
Value value;
};
#ifdef AAPL_NAMESPACE
}
#endif
/**
* \addtogroup bst
* @{
*/
/**
* \class BstMap
* \brief Binary search table for key and value pairs.
*
* BstMap stores key and value pairs in each element. The key and value can be
* any type. A compare class for the key must be supplied.
*/
/*@}*/
#define BST_TEMPL_DECLARE class Key, class Value, \
class Compare = CmpOrd<Key>, class Resize = ResizeExpn
#define BST_TEMPL_DEF class Key, class Value, class Compare, class Resize
#define BST_TEMPL_USE Key, Value, Compare, Resize
#define GET_KEY(el) ((el).key)
#define BstTable BstMap
#define Element BstMapEl<Key, Value>
#define BSTMAP
#include "bstcommon.h"
#undef BST_TEMPL_DECLARE
#undef BST_TEMPL_DEF
#undef BST_TEMPL_USE
#undef GET_KEY
#undef BstTable
#undef Element
#undef BSTMAP
/**
* \fn BstMap::insert(const Key &key, BstMapEl<Key, Value> **lastFound)
* \brief Insert the given key.
*
* If the given key does not already exist in the table then a new element
* having key is inserted. They key copy constructor and value default
* constructor are used to place the pair in the table. If lastFound is given,
* it is set to the new entry created. If the insert fails then lastFound is
* set to the existing pair of the same key.
*
* \returns The new element created upon success, null upon failure.
*/
/**
* \fn BstMap::insertMulti(const Key &key)
* \brief Insert the given key even if it exists already.
*
* If the key exists already then the new element having key is placed next
* to some other pair of the same key. InsertMulti cannot fail. The key copy
* constructor and the value default constructor are used to place the pair in
* the table.
*
* \returns The new element created.
*/
#endif /* _AAPL_BSTMAP_H */
|
