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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
// Copyright (C) 2005 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_STATIC_MAP_KERNEl_ABSTRACT_
#ifdef DLIB_STATIC_MAP_KERNEl_ABSTRACT_
#include "../interfaces/map_pair.h"
#include "../interfaces/enumerable.h"
#include "../interfaces/remover.h"
#include "../serialize.h"
#include <functional>
namespace dlib
{
template <
typename domain,
typename range,
typename compare = std::less<domain>
>
class static_map : public enumerable<map_pair<domain,range> >
{
/*!
REQUIREMENTS ON domain
domain must be comparable by compare where compare is a functor compatible with std::less and
domain is swappable by a global swap() and
domain must have a default constructor
REQUIREMENTS ON range
range is swappable by a global swap() and
range must have a default constructor
POINTERS AND REFERENCES TO INTERNAL DATA
Only the destructor and load_from() will invalidate pointers or
references to internal data.
INITIAL VALUE
size() == 0
ENUMERATION ORDER
The enumerator will iterate over the domain (and each associated
range element) elements in ascending order according to the compare functor.
(i.e. the elements are enumerated in sorted order)
WHAT THIS OBJECT REPRESENTS
static_map contains items of type domain and range
This object is similar an array. It maps items of type domain on to
items of type range.
Also note that unless specified otherwise, no member functions
of this object throw exceptions.
NOTE
definition of equivalent:
a is equivalent to b if
a < b == false and
b < a == false
!*/
public:
typedef domain domain_type;
typedef range range_type;
typedef compare compare_type;
static_map (
);
/*!
ensures
- #*this is properly initialized
throws
- std::bad_alloc or any exception thrown by domain's or range's
constructor.
!*/
virtual ~static_map(
);
/*!
ensures
- all memory associated with *this has been released
!*/
void clear(
);
/*!
ensures
- #*this has its initial value
throws
- std::bad_alloc or any exception thrown by domain's or range's
constructor.
If this exception is thrown then #*this is unusable
until clear() is called and succeeds.
!*/
void load (
pair_remover<domain,range>& source
);
/*!
ensures
- #size() == source.size()
- #source.size() == 0
- all the pairs in source are removed and placed into #*this
- #at_start() == true
throws
- std::bad_alloc or any exception thrown by domain's or range's
constructor.
If this exception is thrown then the call to load() will have
no effect on #*this.
!*/
const range* operator[] (
const domain& d
) const;
/*!
ensures
- if (there is an element in the domain equivalent to d) then
- returns a pointer to an element in the range of *this that
is associated with an element in the domain of *this
equivalent to d.
- else
- returns 0
!*/
range* operator[] (
const domain& d
);
/*!
ensures
- if (there is an element in the domain equivalent to d) then
- returns a pointer to an element in the range of *this that
is associated with an element in the domain of *this
equivalent to d.
- else
- returns 0
!*/
void swap (
static_map& item
);
/*!
ensures
- swaps *this and item
!*/
private:
// restricted functions
static_map(static_map&); // copy constructor
static_map& operator=(static_map&); // assignment operator
};
template <
typename domain,
typename range,
typename compare
>
inline void swap (
static_map<domain,range,compare>& a,
static_map<domain,range,compare>& b
) { a.swap(b); }
/*!
provides a global swap function
!*/
template <
typename domain,
typename range,
typename compare
>
void deserialize (
static_map<domain,range,compare>& item,
std::istream& in
);
/*!
provides deserialization support
!*/
}
#endif // DLIB_STATIC_MAP_KERNEl_ABSTRACT_
|
