libstdc++-v3/doc/html/manual/bk01pt04ch10.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 10. Pairs</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0" /><meta name="keywords" content="&#10;      ISO C++&#10;    , &#10;      library&#10;    " /><link rel="home" href="../spine.html" title="The GNU C++ Library Documentation" /><link rel="up" href="utilities.html" title="Part IV. Utilities" /><link rel="prev" href="bk01pt04ch09.html" title="Chapter 9. Functors" /><link rel="next" href="bk01pt04ch11.html" title="Chapter 11. Memory" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 10. Pairs</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="bk01pt04ch09.html">Prev</a> </td><th width="60%" align="center">Part IV. Utilities</th><td width="20%" align="right"> <a accesskey="n" href="bk01pt04ch11.html">Next</a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="manual.util.pairs"></a>Chapter 10. Pairs</h2></div></div></div><p>The <code class="code">pair&lt;T1,T2&gt;</code> is a simple and handy way to
   4       carry around a pair of objects.  One is of type T1, and another of
   5       type T2; they may be the same type, but you don't get anything
   6       extra if they are.  The two members can be accessed directly, as
   7       <code class="code">.first</code> and <code class="code">.second</code>.
   8    </p><p>Construction is simple.  The default ctor initializes each member
   9       with its respective default ctor.  The other simple ctor,
  10    </p><pre class="programlisting">
  11     pair (const T1&amp; x, const T2&amp; y);
  12    </pre><p>does what you think it does, <code class="code">first</code> getting <code class="code">x</code>
  13       and <code class="code">second</code> getting <code class="code">y</code>.
  14    </p><p>There is a copy constructor, but it requires that your compiler
  15       handle member function templates:
  16    </p><pre class="programlisting">
  17     template &lt;class U, class V&gt; pair (const pair&lt;U,V&gt;&amp; p);
  18    </pre><p>The compiler will convert as necessary from U to T1 and from
  19       V to T2 in order to perform the respective initializations.
  20    </p><p>The comparison operators are done for you.  Equality
  21       of two <code class="code">pair&lt;T1,T2&gt;</code>s is defined as both <code class="code">first</code>
  22       members comparing equal and both <code class="code">second</code> members comparing
  23       equal; this simply delegates responsibility to the respective
  24       <code class="code">operator==</code> functions (for types like MyClass) or builtin
  25       comparisons (for types like int, char, etc).
  26    </p><p>
  27       The less-than operator is a bit odd the first time you see it.  It
  28       is defined as evaluating to:
  29    </p><pre class="programlisting">
  30     x.first  &lt;  y.first  ||
  31         ( !(y.first  &lt;  x.first)  &amp;&amp;  x.second  &lt;  y.second )
  32    </pre><p>The other operators are not defined using the <code class="code">rel_ops</code>
  33       functions above, but their semantics are the same.
  34    </p><p>Finally, there is a template function called <code class="function">make_pair</code>
  35       that takes two references-to-const objects and returns an
  36       instance of a pair instantiated on their respective types:
  37    </p><pre class="programlisting">
  38     pair&lt;int,MyClass&gt; p = make_pair(4,myobject);
  39    </pre></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="bk01pt04ch09.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="utilities.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bk01pt04ch11.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 9. Functors </td><td width="20%" align="center"><a accesskey="h" href="../spine.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 11. Memory</td></tr></table></div></body></html>