doc/html/boost/hash_value_idp777566880.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function template hash_value</title>
   6 <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../variant/reference.html#header.boost.variant.variant_hpp" title="Header &lt;boost/variant/variant.hpp&gt;">
  10 <link rel="prev" href="operator_idp777552576.html" title="Function template operator&lt;&lt;">
  11 <link rel="next" href="make_variant_over.html" title="Class template make_variant_over">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
  16 <td align="center"><a href="../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="operator_idp777552576.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.variant_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_variant_over.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.hash_value_idp777566880"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template hash_value</span></h2>
  30 <p>boost::hash_value &#8212; Provides hashing for <code class="computeroutput">variant</code> types so
  31       that <code class="computeroutput">boost::hash</code> may compute hash.</p>
  32 </div>
  33 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  34 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../variant/reference.html#header.boost.variant.variant_hpp" title="Header &lt;boost/variant/variant.hpp&gt;">boost/variant/variant.hpp</a>&gt;
  35
  36 </span>
  37 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">&gt;</span>
  38   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">hash_value</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="variant.html" title="Class template variant">variant</a><span class="special">&lt;</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">TN</span><span class="special">&gt;</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre></div>
  39 <div class="refsect1">
  40 <a name="idp614813952"></a><h2>Description</h2>
  41 <div class="variablelist"><table border="0" class="variablelist compact">
  42 <colgroup>
  43 <col align="left" valign="top">
  44 <col>
  45 </colgroup>
  46 <tbody>
  47 <tr>
  48 <td><p><span class="term">Requires:</span></p></td>
  49 <td>Every bounded type of the <code class="computeroutput">variant</code> must
  50           fulfill the requirements of the
  51           <a class="link" href="../variant/reference.html#variant.concepts.hashable" title="Hashable"><span class="emphasis"><em>Hashable</em></span></a>
  52           concept.</td>
  53 </tr>
  54 <tr>
  55 <td><p><span class="term">Effects:</span></p></td>
  56 <td>Calls <code class="computeroutput">boost::hash&lt;T&gt;()(x)</code>, where <code class="computeroutput">x</code> is
  57           the content of <code class="computeroutput">rhs</code> and <code class="computeroutput">T</code> is its type.</td>
  58 </tr>
  59 <tr>
  60 <td><p><span class="term">Notes:</span></p></td>
  61 <td>Actually, this function is defined in
  62           <code class="computeroutput">&lt;boost/variant/detail/hash_variant.hpp&gt;</code>
  63           header.</td>
  64 </tr>
  65 </tbody>
  66 </table></div>
  67 </div>
  68 </div>
  69 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  70 <td align="left"></td>
  71 <td align="right"><div class="copyright-footer">Copyright &#169; 2002, 2003 Eric Friedman, Itay Maman<p>Distributed under the Boost Software License, Version 1.0.
  72     (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  73     <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  74     </p>
  75 </div></td>
  76 </tr></table>
  77 <hr>
  78 <div class="spirit-nav">
  79 <a accesskey="p" href="operator_idp777552576.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.variant_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_variant_over.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
  80 </div>
  81 </body>
  82 </html>