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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Computational Engine *
* *
* Copyright (c) 1999-2008, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public *
* License along with this program; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
* *
**************************************************************************/
/* end stub */
/*! \file memutils.h
* \brief Provides object creation and deletion functions for use with
* the Standard Template Library.
*/
#ifndef __MEMUTILS_H
#ifndef __DOXYGEN
#define __MEMUTILS_H
#endif
namespace regina {
/**
* \weakgroup utilities
* @{
*/
/**
* An adaptable generator used to create objects using default constructors.
* This class is for use with the Standard Template Library.
*
* Note that the template argument need not be a pointer class. If the
* template argument is <tt>T</tt>, this generator will return a
* \e pointer to a newly created object of type <tt>T</tt>.
*
* \ifacespython Not present.
*/
template <class T>
struct FuncNew {
typedef T* result_type;
/**< The return type for this generator. */
/**
* Creates a new object using the default constructor.
*
* @return the newly created object.
*/
T* operator() () const {
return new T;
}
};
/**
* An adaptable unary function used to create objects using copy constructors.
* This class is for use with the Standard Template Library.
*
* Note that the template argument need not be a pointer class. If the
* template argument is <tt>T</tt>, this unary function will accept
* a \e pointer to <tt>T</tt>, dereference this pointer and pass it to the
* copy constructor to return a pointer to a newly created object of
* type <tt>T</tt>.
*
* \ifacespython Not present.
*/
template <class T>
struct FuncNewCopyPtr {
typedef const T* argument_type;
/**< The argument type for this unary function. */
typedef T* result_type;
/**< The return type for this unary function. */
/**
* Creates a new object using the copy constructor.
*
* @param ptr the pointer whose data should (after dereferencing) be
* passed to the copy constructor.
* @return the newly created object.
*/
T* operator() (const T* ptr) const {
return new T(*ptr);
}
};
/**
* An adaptable unary function used to create objects using copy constructors.
* This class is for use with the Standard Template Library.
*
* Note that the template argument need not be a pointer class. If the
* template argument is <tt>T</tt>, this unary function will accept
* a \e reference to <tt>T</tt> and pass it directly to the
* copy constructor to return a pointer to a newly created object of
* type <tt>T</tt>.
*
* \ifacespython Not present.
*/
template <class T>
struct FuncNewCopyRef {
typedef const T& argument_type;
/**< The argument type for this unary function. */
typedef T* result_type;
/**< The return type for this unary function. */
/**
* Creates a new object using the copy constructor.
*
* @param obj the object whose data should be passed to the copy
* constructor.
* @return the newly created object.
*/
T* operator() (const T& obj) const {
return new T(obj);
}
};
/**
* An adaptable unary function used to create objects using the
* <tt>clone()</tt> method.
* This class is for use with the Standard Template Library.
*
* Note that the template argument need not be a pointer class. If the
* template argument is <tt>T</tt>, this unary function will accept
* a \e pointer to <tt>T</tt> and call <tt>clone()</tt> upon the
* corresponding object, returning a pointer to the newly created clone
* of type <tt>T</tt>.
*
* \pre Type <tt>T</tt> has method <tt>T* clone() const</tt>. The
* declared return type may be different, but the result \e must
* be castable to <tt>T*</tt>.
*
* \ifacespython Not present.
*/
template <class T>
struct FuncNewClonePtr {
typedef const T* argument_type;
/**< The argument type for this unary function. */
typedef T* result_type;
/**< The return type for this unary function. */
/**
* Creates a new object using the <tt>clone()</tt> method.
*
* @param ptr the pointer whose corresponding object should be cloned.
* @return the newly created clone.
*/
T* operator() (const T* ptr) const {
return dynamic_cast<T*>(ptr->clone());
}
};
/**
* An adaptable unary function used to deallocate objects.
* This class is for use with the Standard Template Library.
*
* Note that the template argument need not be a pointer class. If the
* template argument is <tt>T</tt>, this unary function will accept (and
* call \c delete upon) \e pointers to <tt>T</tt>.
*
* \ifacespython Not present.
*/
template <class T>
struct FuncDelete {
typedef T* argument_type;
/**< The argument type for this unary function. */
typedef void result_type;
/**< The return type for this unary function. */
/**
* Calls \c delete upon the given pointer.
*
* @param ptr the pointer whose data should be deleted.
*/
void operator() (T* ptr) const {
delete ptr;
}
};
/*@}*/
} // namespace regina
#endif
|
