stl-manual 3.30-13.1 / usr / share / doc / stl-manual / html / pair.html

This file is indexed.

/usr/share/doc/stl-manual/html/pair.html is in stl-manual 3.30-13.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<HTML>
<!--
  -- Copyright (c) 1996-1999
  -- Silicon Graphics Computer Systems, Inc.
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  Silicon Graphics makes no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  --
  -- Copyright (c) 1994
  -- Hewlett-Packard Company
  --
  -- Permission to use, copy, modify, distribute and sell this software
  -- and its documentation for any purpose is hereby granted without fee,
  -- provided that the above copyright notice appears in all copies and
  -- that both that copyright notice and this permission notice appear
  -- in supporting documentation.  Hewlett-Packard Company makes no
  -- representations about the suitability of this software for any
  -- purpose.  It is provided "as is" without express or implied warranty.
  --
  -->
<Head>
<Title>pair&lt;T1, T2&gt;</Title>
<!-- Generated by htmldoc -->
</HEAD>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
	ALINK="#ff0000"> 
<IMG SRC="CorpID.gif" 
     ALT="SGI" HEIGHT="43" WIDTH="151"> 
<!--end header-->
<BR Clear>
<H1>pair&lt;T1, T2&gt;</H1>

<Table CellPadding=0 CellSpacing=0 width=100%>
<TR>
<TD Align=left><Img src = "utilities.gif" Alt=""   WIDTH = "194"  HEIGHT = "38" ></TD>
<TD Align=right><Img src = "type.gif" Alt=""   WIDTH = "194"  HEIGHT = "39" ></TD>
</TR>
<TR>
<TD Align=left VAlign=top><b>Category</b>: utilities</TD>
<TD Align=right VAlign=top><b>Component type</b>: type</TD>
</TR>
</Table>

<h3>Description</h3>
<tt>Pair&lt;T1,T2&gt;</tt> is a heterogeneous pair: it holds one object of type 
<tt>T1</tt> and one of type <tt>T2</tt>.  A pair is much like a <A href="Container.html">Container</A>,
in that it &quot;owns&quot; its elements.  It is not actually a model of
<A href="Container.html">Container</A>, though, because it does not support the standard
methods (such as <A href="Iterators.html">iterators</A>) for accessing the elements of a
<A href="Container.html">Container</A>.
<P>
Functions that need to return two values often return a <tt>pair</tt>.
<h3>Example</h3>
<pre>
pair&lt;bool, double&gt; result = do_a_calculation();
if (result.first)
  do_something_more(result.second);
else
  report_error();
</pre>
<h3>Definition</h3>
Defined in the standard header <A href="utility">utility</A>, and in the nonstandard
backward-compatibility header <A href="pair.h">pair.h</A>.
<h3>Template parameters</h3>
<Table border>
<TR>
<TH>
Parameter
</TH>
<TH>
Description
</TH>
<TH>
Default
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>T1</tt>
</TD>
<TD VAlign=top>
The type of the first element stored in the <tt>pair</tt>
</TD>
<TD VAlign=top>
&nbsp;
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>T2</tt>
</TD>
<TD VAlign=top>
The type of the second element stored in the <tt>pair</tt>
</TD>
<TD VAlign=top>
&nbsp;
</TD>
</tr>
</table>
<h3>Model of</h3>
<A href="Assignable.html">Assignable</A>
<h3>Type requirements</h3>
<tt>T1</tt> and <tt>T2</tt> must both be models of <A href="Assignable.html">Assignable</A>.  Additional operations
have additional requirements.  <tt>Pair</tt>'s default constructor may only
be used if both <tt>T1</tt> and <tt>T2</tt> are <A href="DefaultConstructible.html">DefaultConstructible</A>, 
<tt>operator==</tt> may only be used if both <tt>T1</tt> and <tt>T2</tt> are
<A href="EqualityComparable.html">EqualityComparable</A>, and <tt>operator&lt;</tt> may only be used if both
<tt>T1</tt> and <tt>T2</tt> are <A href="LessThanComparable.html">LessThanComparable</A>.
<h3>Public base classes</h3>
None.
<h3>Members</h3>
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Where defined
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>first_type</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>second_type</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>pair</b>()</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
The default constructor.  See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>pair</b>(const first_type&amp;, const second_type&amp;)</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
The pair constructor.  See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>pair</b>(const pair&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="Assignable.html">Assignable</A>
</TD>
<TD VAlign=top>
The copy constructor
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>pair&amp; <b>operator=</b>(const pair&amp;)</tt>
</TD>
<TD VAlign=top>
 <A href="Assignable.html">Assignable</A>
</TD>
<TD VAlign=top>
The assignment operator
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>first</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>second</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>bool <b>operator==</b>(const pair&amp;, const pair&amp;)</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>bool <b>operator&lt;</b>(const pair&amp;, const pair&amp;)</tt>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template &lt;class T1, class T2&gt;
pair&lt;T1,T2&gt; <b>make_pair</b>(const T1&amp;, const T2&amp;)
</pre>
</TD>
<TD VAlign=top>
<tt>pair</tt>
</TD>
<TD VAlign=top>
See below.
</TD>
</tr>
</table>
<h3>New members</h3>
These members are not defined 
in the <A href="Assignable.html">Assignable</A> requirements,
but are specific to <tt>pair</tt>.
<Table border>
<TR>
<TH>
Member
</TH>
<TH>
Description
</TH>
</TR>
<TR>
<TD VAlign=top>
<tt>first_type</tt>
</TD>
<TD VAlign=top>
The type of the pair's first component.  This is a <tt>typedef</tt> for
   the template parameter <tt>T1</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>second_type</tt>
</TD>
<TD VAlign=top>
The type of the pair's second component.  This is a <tt>typedef</tt> for
   the template parameter <tt>T2</tt>
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>pair</b>()</tt>
</TD>
<TD VAlign=top>
The default constructor.  It uses constructs objects of types
   <tt>T1</tt> and <tt>T2</tt> using their default constructors.  This constructor
   may only be used if both <tt>T1</tt> and <tt>T2</tt> are <A href="DefaultConstructible.html">DefaultConstructible</A>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<b><tt>pair</b>(const first_type&amp; x, const second_type&amp; y)</tt>
</TD>
<TD VAlign=top>
The pair constructor.  Constructs a pair such that <tt>first</tt> is constructed
   from <tt>x</tt> and <tt>second</tt> is constructed from <tt>y</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>first</tt>
</TD>
<TD VAlign=top>
Public member variable of type <tt>first_type</tt>: the first object stored in the <tt>pair</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<tt>second</tt>
</TD>
<TD VAlign=top>
Public member variable of type <tt>second_type</tt>: The second object stored in the <tt>pair</tt>.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template &lt;class T1, class T2&gt;
bool <b>operator==</b>(const pair&lt;T1,T2&gt;&amp; x, 
                const pair&lt;T1,T2&gt;&amp; y);
</pre>
</TD>
<TD VAlign=top>
The equality operator.  The return value is <tt>true</tt> if and only 
the first elements of <tt>x</tt> and <tt>y</tt> are equal, and the second
elements of <tt>x</tt> and <tt>y</tt> are equal.  This operator may only
be used if both <tt>T1</tt> and <tt>T2</tt> are <A href="EqualityComparable.html">EqualityComparable</A>.
This is a global function, not a member function.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template &lt;class T1, class T2&gt;
bool <b>operator&lt;</b>(const pair&lt;T1,T2&gt;&amp; x, 
               const pair&lt;T1,T2&gt;&amp; y);
</pre>
</TD>
<TD VAlign=top>
The comparison operator.  It uses lexicographic comparison:
the return value is <tt>true</tt> if the
first element of <tt>x</tt> is less than the first element of <tt>y</tt>,
and <tt>false</tt> if the first element of <tt>y</tt> is less than the first
element of <tt>x</tt>.  If neither of these is the case, then
<tt>operator&lt;</tt> returns the result of comparing the second elements
of <tt>x</tt> and <tt>y</tt>.  This operator may only
be used if both <tt>T1</tt> and <tt>T2</tt> are <A href="LessThanComparable.html">LessThanComparable</A>.
This is a global function, not a member function.
</TD>
</TR>
<TR>
<TD VAlign=top>
<pre>
template &lt;class T1, class T2&gt;
pair&lt;T1,T2&gt; <b>make_pair</b>(const T1&amp; x, const T2&amp; x)
</pre>
</TD>
<TD VAlign=top>
Equivalent to <tt>pair&lt;T1, T2&gt;(x, y)</tt>.
This is a global function, not a member function.
It exists only for the sake of convenience.
</TD>
</tr>
</table>
<h3>Notes</h3>
<h3>See also</h3>
<A href="Assignable.html">Assignable</A>, <A href="DefaultConstructible.html">Default Constructible</A>, <A href="LessThanComparable.html">LessThan Comparable</A>

<!--start footer--> 
<HR SIZE="6">
<A href="http://www.sgi.com/"><IMG SRC="surf.gif" HEIGHT="54" WIDTH="54" 
        ALT="[Silicon Surf]"></A>
<A HREF="index.html"><IMG SRC="stl_home.gif" 
        HEIGHT="54" WIDTH="54" ALT="[STL Home]"></A>
<BR>
<FONT SIZE="-2">
<A href="http://www.sgi.com/Misc/sgi_info.html" TARGET="_top">Copyright &copy; 
1999 Silicon Graphics, Inc.</A> All Rights Reserved.</FONT>
<FONT SIZE="-3"><a href="http://www.sgi.com/Misc/external.list.html" TARGET="_top">TrademarkInformation</A>
</FONT>
<P>
</BODY>
</HTML>

APT Browse - Built by Thomas Orozco.