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
|
// Copyright (C) 2005 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_STATIC_SET_KERNEl_ABSTRACT_
#ifdef DLIB_STATIC_SET_KERNEl_ABSTRACT_
#include "../interfaces/enumerable.h"
#include "../interfaces/remover.h"
#include "../serialize.h"
#include <functional>
namespace dlib
{
template <
typename T,
typename compare = std::less<T>
>
class static_set : public enumerable<const T>
{
/*!
REQUIREMENTS ON T
T must be comparable by compare where compare is a functor compatible with std::less and
T is swappable by a global swap() and
T must have a default constructor
POINTERS AND REFERENCES TO INTERNAL DATA
Only the destructor will invalidate pointers or references
to internal data.
INITIAL VALUE
size() == 0
ENUMERATION ORDER
The enumerator will iterate over the elements in the set in
ascending order according to the compare functor.
(i.e. the elements are enumerated in sorted order)
WHAT THIS OBJECT REPRESENTS
static_set contains items of type T
This object represents an unaddressed collection of items.
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 T type;
typedef compare compare_type;
static_set (
);
/*!
ensures
- #*this is properly initialized
throws
- std::bad_alloc or any exception thrown by T's constructor.
!*/
virtual ~static_set(
);
/*!
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 T's constructor.
If this exception is thrown then #*this is unusable
until clear() is called and succeeds.
!*/
void load (
remover<T>& source
);
/*!
ensures
- #size() == source.size()
- #source.size() == 0
- all the elements in source are removed and placed into #*this
- #at_start() == true
throws
- std::bad_alloc or any exception thrown by T's constructor.
If this exception is thrown then the call to load() will have
no effect on #*this.
!*/
bool is_member (
const T& item
) const;
/*!
ensures
- if (there is an item in *this equivalent to item) then
- returns true
- else
- returns false
!*/
void swap (
static_set& item
);
/*!
ensures
- swaps *this and item
!*/
private:
// restricted functions
static_set(static_set&); // copy constructor
static_set& operator=(static_set&); // assignment operator
};
template <
typename T,
typename compare
>
inline void swap (
static_set<T,compare>& a,
static_set<T,compare>& b
) { a.swap(b); }
/*!
provides a global swap function
!*/
template <
typename T,
typename compare
>
void deserialize (
static_set<T,compare>& item,
std::istream& in
);
/*!
provides deserialization support
!*/
}
#endif // DLIB_STATIC_SET_KERNEl_ABSTRACT_
|
