Google Git
Sign in
llvm / llvm-archive / b74e25f9042d5657e8f400dd820eba426827f1dd / . / llvm-gcc-4.2 / libstdc++-v3 / docs / html / ext / pb_ds / basic_hash_table.html
blob: a6c569c2bb14ac8ee7e1e3c2fc3e5a9d8f7e5eb9 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 12 April 2005), see www.w3.org" />
<title>basic_hash_table Interface</title>
<meta http-equiv="Content-Type" content=
"text/html; charset=us-ascii" />
</head>
<body>
<div id="page">
<h1><tt>basic_hash_table</tt> Interface</h1>
<p>An abstract basic hash-based associative container.</p>
<p>Defined in: <a href=
"../../../../include/ext/pb_ds/assoc_container.hpp"><tt>assoc_container.hpp</tt></a></p>
<h2><a name="link1" id="link1">Template Parameters</a></h2>
<table class="c1" width="100%" border="1" summary=
"Template Parameters">
<tr>
<td width="20%" align="left"><b>Parameter</b></td>
<td width="50%" align="left"><b>Description</b></td>
<td width="30%" align="left"><b>Default Value</b></td>
</tr>
<tr>
<td>
<pre>
<a name="Key2501" id="Key2501"><b>typename</b> Key</a>
</pre>
</td>
<td>
<p>Key type.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Mapped318655" id="Mapped318655"><b>typename</b> Mapped</a>
</pre>
</td>
<td>
<p>Mapped type.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Hash_Fn1515835" id=
"Hash_Fn1515835"><b>class</b> Hash_Fn</a>
</pre>
</td>
<td>
<p>Hash functor.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Eq_Fn60085" id="Eq_Fn60085"><b>class</b> Eq_Fn</a>
</pre>
</td>
<td>
<p>Equivalence functor.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Resize_Policy566860465" id=
"Resize_Policy566860465"><b>class</b> Resize_Policy</a>
</pre>
</td>
<td>
<p>Resize policy.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Store_Hash218262104" id=
"Store_Hash218262104"><b>bool</b> Store_Hash</a>
</pre>
</td>
<td>
<p>Indicates whether the hash value will be stored along
with each key.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Tag278938" id="Tag278938"><b>class</b> Tag</a>
</pre>
</td>
<td>
<p>Mapped-structure tag.</p>
</td>
<td>-</td>
</tr>
<tr>
<td>
<pre>
<a name="Allocator35940069" id=
"Allocator35940069"><b>class</b> Allocator</a>
</pre>
</td>
<td>
<p>Allocator type.</p>
</td>
<td>-</td>
</tr>
</table>
<h2><a name="link2" id="link2">Base Classes</a></h2>
<table class="c1" width="100%" border="1" summary="Bases">
<tr>
<td width="80%" align="left"><b>Class</b></td>
<td width="20%" align="left"><b>Derivation Type</b></td>
</tr>
<tr>
<td>
<pre>
<a href="#Resize_Policy566860465"><tt>Resize_Policy</tt></a>
</pre>
</td>
<td>
<p>public</p>
</td>
</tr>
<tr>
<td>
<pre>
<a href="container_base.html"><span class=
"c2"><tt>container_base</tt></span></a>
</pre>
</td>
<td>
<p>public</p>
</td>
</tr>
</table>
<h2><a name="link3" id="link3">Public Types and
Constants</a></h2>
<h3><a name="link4" id="link4">Policy Definitions</a></h3>
<table class="c1" width="100%" border="1" summary="Types">
<tr>
<td width="30%" align="left"><b>Type</b></td>
<td width="55%" align="left"><b>Definition</b></td>
<td width="15%" align="left"><b>Description</b></td>
</tr>
<tr>
<td>
<pre>
<a name="hash_fn2015995" id="hash_fn2015995">hash_fn</a>
</pre>
</td>
<td>
<pre>
<a href="#Hash_Fn1515835"><tt>Hash_Fn</tt></a>
</pre>
</td>
<td>
<p>Hash functor type.</p>
</td>
</tr>
<tr>
<td>
<pre>
<a name="eq_fn80245" id="eq_fn80245">eq_fn</a>
</pre>
</td>
<td>
<pre>
<a href="#Eq_Fn60085"><tt>Eq_Fn</tt></a>
</pre>
</td>
<td>
<p>Equivalence functor type.</p>
</td>
</tr>
<tr>
<td>
<pre>
<a name="resize_policy4084493169" id=
"resize_policy4084493169">resize_policy</a>
</pre>
</td>
<td>
<pre>
<a href="#Resize_Policy566860465"><tt>Resize_Policy</tt></a>
</pre>
</td>
<td>
<p>Resize policy type.</p>
</td>
</tr>
<tr>
<td>
<pre>
<a name="store_hash280766104" id=
"store_hash280766104">store_hash</a>
</pre>
</td>
<td>
<pre>
<a href="#Store_Hash218262104"><tt>Store_Hash</tt></a>
</pre>
</td>
<td>
<p>Indicates whether a hash value is stored with each
entry.</p>
</td>
</tr>
</table>
<h2><a name="link5" id="link5">Public Methods</a></h2>
<h3><a name="link6" id="link6">Constructors, Destructor, and
Related</a></h3>
<table class="c1" width="100%" border="1" summary="Methods">
<tr>
<td width="45%" align="left"><b>Method</b></td>
<td width="55%" align="left"><b>Description</b></td>
</tr>
<tr>
<td>
<pre>
<b>virtual</b>
~basic_hash_table
()
</pre>
</td>
<td>
<p>Destructor.</p>
</td>
</tr>
</table>
<h3><a name="link7" id="link7">Policy Access Methods</a></h3>
<table class="c1" width="100%" border="1" summary="Methods">
<tr>
<td width="45%" align="left"><b>Method</b></td>
<td width="55%" align="left"><b>Description</b></td>
</tr>
<tr>
<td>
<pre>
<a href="#hash_fn2015995"><tt>hash_fn</tt></a> &amp;
get_hash_fn
()
</pre>
</td>
<td>
<p>Access to the <a href=
"#hash_fn2015995"><tt>hash_fn</tt></a> object.</p>
</td>
</tr>
<tr>
<td>
<pre>
<b>const</b> <a href="#hash_fn2015995"><tt>hash_fn</tt></a> &amp;
get_hash_fn
() <b>const</b>
</pre>
</td>
<td>
<p>Const access to the <a href=
"#hash_fn2015995"><tt>hash_fn</tt></a> object.</p>
</td>
</tr>
<tr>
<td>
<pre>
<a href="#eq_fn80245"><tt>eq_fn</tt></a> &amp;
get_eq_fn
()
</pre>
</td>
<td>
<p>Access to the <a href="#eq_fn80245"><tt>eq_fn</tt></a>
object.</p>
</td>
</tr>
<tr>
<td>
<pre>
<b>const</b> <a href="#eq_fn80245"><tt>eq_fn</tt></a> &amp;
get_eq_fn
() <b>const</b>
</pre>
</td>
<td>
<p>Const access to the <a href=
"#eq_fn80245"><tt>eq_fn</tt></a> object.</p>
</td>
</tr>
<tr>
<td>
<pre>
<a href="#resize_policy4084493169"><tt>resize_policy</tt></a> &amp;
get_resize_policy
()
</pre>
</td>
<td>
<p>Access to the <a href=
"#resize_policy4084493169"><tt>resize_policy</tt></a>
object.</p>
</td>
</tr>
<tr>
<td>
<pre>
<b>const</b> <a href=
"#resize_policy4084493169"><tt>resize_policy</tt></a> &amp;
get_resize_policy
() <b>const</b>
</pre>
</td>
<td>
<p>Const access to the <a href=
"#resize_policy4084493169"><tt>resize_policy</tt></a>
object.</p>
</td>
</tr>
</table>
<h2><a name="link8" id="link8">Private Methods</a></h2>
<h3><a name="link9" id="link9">Resize Methods</a></h3>
<table class="c1" width="100%" border="1" summary="Methods">
<tr>
<td width="45%" align="left"><b>Method</b></td>
<td width="55%" align="left"><b>Description</b></td>
</tr>
<tr>
<td>
<pre>
<b>virtual</b> <b>void</b>
do_resize
(size_type new_size)
</pre>
</td>
<td>
<p>Resizes the container object to <span class=
"c1"><tt>new_size</tt></span>.</p>
</td>
</tr>
</table>
</div>
</body>
</html>