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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="AUTHOR" CONTENT="pme@sources.redhat.com (Phil Edwards)">
<META NAME="KEYWORDS" CONTENT="HOWTO, libstdc++, GCC, g++, libg++, STL">
<META NAME="DESCRIPTION" CONTENT="HOWTO for the libstdc++ chapter 20.">
<META NAME="GENERATOR" CONTENT="vi and eight fingers">
<TITLE>libstdc++-v3 HOWTO: Chapter 20</TITLE>
<LINK REL=StyleSheet HREF="../lib3styles.css">
<!-- $Id: howto.html,v 1.4 2000/12/03 23:47:47 jsm28 Exp $ -->
</HEAD>
<BODY>
<H1 CLASS="centered"><A NAME="top">Chapter 20: General Utilities</A></H1>
<P>Chapter 20 deals with utility classes and functions, such as
the oft-debated <TT>auto_ptr<></TT>.
</P>
<!-- ####################################################### -->
<HR>
<H1>Contents</H1>
<UL>
<LI><A HREF="#1"><TT>auto_ptr</TT> is not omnipotent</A>
<LI><A HREF="#2">Automatically-generated operators</A>
<LI><A HREF="#3">Functors</A>
<LI><A HREF="#4">Pairs</A>
</UL>
<HR>
<!-- ####################################################### -->
<H2><A NAME="1"><TT>auto_ptr</TT> is not omnipotent</A></H2>
<P>I'm not going to try and explain all of the fun and delicious
things that can happen with misuse of the auto_ptr class template
(called AP here), nor am I going to try and teach you how to use
AP safely in the presence of copying. The AP class is a really
nifty idea for a smart pointer, but it is one of the dumbest of
all the smart pointers -- and that's fine.
</P>
<P>AP is not meant to be a supersmart solution to all resource
leaks everywhere. Neither is it meant to be an effective form
of garbage collection (although it can help, a little bit).
And it can <EM>not</EM> be used for arrays!
</P>
<P>AP <EM>is</EM> meant to prevent nasty leaks in the presence of
exceptions. That's <EM>all</EM>. This code is AP-friendly:
<PRE>
// not a recommend naming scheme, but good for web-based FAQs
typedef std::auto_ptr<MyClass> APMC;
extern function_taking_MyClass_pointer (MyClass*);
extern some_throwable_function ();
void func (int data)
{
APMC ap (new MyClass(data));
some_throwable_function(); // this will throw an exception
function_taking_MyClass_pointer (ap.get());
}
</PRE>When an exception gets thrown, the instance of MyClass that's
been created on the heap will be <TT>delete</TT>'d as the stack is
unwound past <TT>func()</TT>.
</P>
<P>Changing that code as follows is <EM>not</EM> AP-friendly:
<PRE>
APMC ap (new MyClass[22]);
</PRE>You will get the same problems as you would without the use
of AP:
<PRE>
char* array = new char[10]; // array new...
...
delete array; // ...but single-object delete
</PRE>
</P>
<P>AP cannot tell whether the pointer you've passed at creation points
to one or many things. If it points to many things, you are about
to die. AP is trivial to write, however, so you could write your
own <TT>auto_array_ptr</TT> for that situation (in fact, this has
been done many times; check the newsgroups, Usenet, Boost, etc).
</P>
<P>Return <A HREF="#top">to top of page</A> or
<A HREF="../faq/index.html">to the FAQ</A>.
</P>
<HR>
<H2><A NAME="2">Automatically-generated operators</A></H2>
<P>Many programs (for that matter, many of the Standard algorithms
and containers) require that you write comparison operators for
your classes, like <TT>operator>=</TT>. As any mathmatician
will tell you, once you have defined equality and ordering, all
of the other comparisons are easily defined in terms of those two.
</P>
<P>The Committee agrees. So, once you have written
<TT>operator==</TT> and <TT>operator<</TT> for your class
(whether they are global or member functions is up to you), you
can have the compiler do the grunt-work of generating the rest:
<PRE>
#include <header_with_my_op==_and_op<_defined>
#include <utility>
using std::rel_ops; // note the nested namespace!
...
if ((obj1 != obj2) || (obj3 >= obj4)) foo();
</PRE>
</P>
<P>Return <A HREF="#top">to top of page</A> or
<A HREF="../faq/index.html">to the FAQ</A>.
</P>
<HR>
<H2><A NAME="3">Functors</A></H2>
<P>If you don't know what functors are, you're not alone. Many people
get slightly the wrong idea. In the interest of not reinventing
the wheel, we will refer you to the introduction to the functor
concept written by SGI as part of their STL, in
<A HREF="http://www.sgi.com/Technology/STL/functors.html">their
http://www.sgi.com/Technology/STL/functors.html</A>.
</P>
<P>Return <A HREF="#top">to top of page</A> or
<A HREF="../faq/index.html">to the FAQ</A>.
</P>
<HR>
<H2><A NAME="4">Pairs</A></H2>
<P>The <TT>pair<T1,T2></TT> is a simple and handy way to
carry around a pair of objects. One is of type T1, and another of
type T2; they may be the same type, but you don't get anything
extra if they are. The two members can be accessed directly, as
<TT>.first</TT> and <TT>.second</TT>.
</P>
<P>Construction is simple. The default ctor initializes each member
with its respective default ctor. The other simple ctor,
<PRE>
pair (const T1& x, const T2& y);
</PRE>does what you think it does, <TT>first</TT> getting <TT>x</TT>
and <TT>second</TT> getting <TT>y</TT>.
</P>
<P>There is a copy constructor, but it requires that your compiler
handle member function templates:
<PRE>
template <class U, class V> pain (const pair<U,V>& p);
</PRE>The compiler will convert as necessary from U to T1 and from
V to T2 in order to perform the respective initializations.
</P>
<P>The comparison operators are done for you. Equality
of two <TT>pair<T1,T2></TT>s is defined as both <TT>first</TT>
members comparing equal and both <TT>second</TT> members comparing
equal; this simply delegates responsibility to the respective
<TT>operator==</TT> functions (for types like MyClass) or builtin
comparisons (for types like int, char, etc).
</P>
<P>The less-than operator is a bit odd the first time you see it. It
is defined as evaluating to:
<PRE>
x.first < y.first ||
( !(y.first < x.first) && x.second < y.second )
</PRE>
The other operators are not defined using the <TT>rel_ops</TT>
functions above, but their semantics are the same.
</P>
<P>Finally, there is a template function called <TT>make_pair</TT>
that takes two references-to-const objects and returns an
instance of a pair instantiated on their respective types:
<PRE>
pair<int,MyClass> p = make_pair(4,myobject);
</PRE>
</P>
<P>Return <A HREF="#top">to top of page</A> or
<A HREF="../faq/index.html">to the FAQ</A>.
</P>
<!-- ####################################################### -->
<HR>
<P CLASS="fineprint"><EM>
Comments and suggestions are welcome, and may be sent to
<A HREF="mailto:pme@sources.redhat.com">Phil Edwards</A> or
<A HREF="mailto:gdr@gcc.gnu.org">Gabriel Dos Reis</A>.
<BR> $Id: howto.html,v 1.4 2000/12/03 23:47:47 jsm28 Exp $
</EM></P>
</BODY>
</HTML>
|
