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

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