gcc/libstdc++-v3/docs/html/ext/pb_assoc/interface.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
    <TITLE>Interface</TITLE>
    <META NAME="Generator" content="Microsoft Visual Studio .NET 7.1">
</HEAD>
<BODY>

<H1>Interface</H1>
<p>
    Following is the library's interface:
</p>
<ol>
	<li> <a href = "tutorial.html">Short Tutorial</a> is a short tutorial. </li>
	<li> <a href="#containers">Containers</a>  describes the containers of
the library.
    </li>
    <li>
    <a href="#ds_pol">Data-Type Policies</a> describes data-type policies.
    </li>
    <li>
    <a href="#ds_tag">Data-Structure Tags and Traits</a> describes
    tags and traits identifying the underlying data-structure and its behaviour.
    </li>
    <li>
    <a href="#ms_tag">Mapping-Semantics Tags and Traits</a> describes
    tags and traits identifying the mapping-semantics.
    </li>
    <li>
    <a href = "#ds_policy_classes">Data-Structure Policy Classes</a> describes
    policies for configuring underlying data-structures.
    </li>
    <li>
    <a href="#exceptions">Exceptions</a> Subsection desribes exception classes.
    </li>
</ol>


<hr>


<h2><a name = "containers">Containers</a></h2>

<p>
<a href = "overview.html">Overview</a> and
<a href = "ds_gen.html">Data-Structure Genericity</a> discuss relevant design
points.
</p>

<h6 align = "center">
<a name = "cd">
<img src = "cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
class hierarchy.
</h6>

<ol>
	<li>
		Basic Associative-Containers:
		<ol>
			<li><a href = "basic_assoc_cntnr.html"><tt>basic_assoc_cntnr</tt></a> - basic associative-container for the &quot;map&quot; case</li>
			<li><a href = "basic_assoc_cntnr_no_data.html"><tt>basic_assoc_cntnr</tt></a> - basic associative-container for the &quot;set&quot; case</li>
			<li><a href = "basic_assoc_cntnr_compound_data.html"><tt>basic_assoc_cntnr</tt></a> - basic associative-container for the &quot;multimap&quot; case</li>
		</ol>
	</li>
	<li>
		Hash-Based Associative-Containers:
		<ol>
		<li><a href = "basic_hash_assoc_cntnr.html"><tt>basic_hash_assoc_cntnr</tt></a> - basic hash-based associative-container </li>
		<li><a href = "cc_hash_assoc_cntnr.html"><tt>cc_hash_assoc_cntnr</tt></a> - collision-chaining hash-based associative-container </li>
		<li><a href = "gp_hash_assoc_cntnr.html"><tt>gp_hash_assoc_cntnr</tt></a> - (general) probing hash-based associative-container </li>
		</ol>
	</li>
	<li>
		Tree-Based Associative-Containers:
		<ol>
		<li><a href = "basic_tree_assoc_cntnr.html"><tt>basic_tree_assoc_cntnr</tt></a> - basic tree-based associative-container </li>
		<li><a href = "basic_tree_assoc_cntnr_rev.html"><tt>basic_tree_assoc_cntnr</tt></a> - basic tree-based associative-container with reverse iteration </li>
		<li><a href = "tree_assoc_cntnr.html"><tt>tree_assoc_cntnr</tt></a> - tree-based associative-container </li>
		</ol>
	</li>
	<li>
		List-Based Associative-Contaiers:
	<ol>
		<li><a href = "lu_assoc_cntnr.html"><tt>lu_assoc_cntnr</tt></a> - list-based update-policy associative container</li>
	</ol>
	</li>
</ol>


<hr>


<h2><a name = "ds_pol">Data-Type Policies</a></h2>

<p>
<a href = "overview.html">Overview</a> and
<a href = "ms_gen.html">Mapping-Semantic Genericity</a> discuss relevant design
points.
</p>

<ol>
	<li><a href = "null_data_type.html"><tt>null_data_type</tt></a>
	</li>
	<li><a href = "compound_data_type.html"><tt>compound_data_type</tt></a>
	</li>
</ol>

<hr>


<h2><a name = "ds_tag">Data-Structure Tags and Traits</a></h2>

<p>

</p>

<h3>Data-Structure Tags</h3>

<h6 align = "center">
<a name = "cd">
<img src = "ds_tag_cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
Data-Structure Tag class hierarchy.
</h6>

<ol>
	<li> <a href = "basic_ds_tag.html"><tt>basic_ds_tag</tt></a></li>
	<li> <a href = "basic_hash_ds_tag.html"><tt>basic_hash_ds_tag</tt></a></li>
	<li> <a href = "cc_hash_ds_tag.html"><tt>cc_hash_ds_tag</tt></a></li>
	<li> <a href = "gp_hash_ds_tag.html"><tt>gp_hash_ds_tag</tt></a></li>
	<li> <a href = "basic_tree_ds_tag.html"><tt>basic_tree_ds_tag</tt></a></li>
	<li> <a href = "rb_tree_ds_tag.html"><tt>rb_tree_ds_tag</tt></a></li>
	<li> <a href = "splay_tree_ds_tag.html"><tt>splay_tree_ds_tag</tt></a></li>
	<li> <a href = "ov_tree_ds_tag.html"><tt>ov_tree_ds_tag</tt></a></li>
	<li> <a href = "lu_ds_tag.html"><tt>lu_ds_tag</tt></a></li>
	<li> <a href = "compound_ds_tag.html"><tt>compound_ds_tag</tt></a></li>
</ol>


<h3>Invalidation-Guarantee Tags</h3>

<h6 align = "center">
<a name = "cd">
<img src = "invalidation_guarantee_cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
Invalidation guarantees class hierarchy.
</h6>

<ol>
	<li> <a href = "basic_invalidation_guarantee.html"><tt>basic_invalidation_guarantee</tt></a></li>
	<li> <a href = "find_invalidation_guarantee.html"><tt>find_invalidation_guarantee</tt></a></li>
	<li> <a href = "range_invalidation_guarantee.html"><tt>range_invalidation_guarantee</tt></a></li>
</ol>

<h3>Data-Structure Traits</h3>

<ol>
	<li> <a href = "ds_traits.html"><tt>ds_traits</tt></a></li>
</ol>


<hr>


<h2><a name = "ms_tag">Mapping-Semantics Tags and Traits</a></h2>

<p>

</p>

<h3>Mapping-Semantics Tags</h3>

<h6 align = "center">
<a name = "cd">
<img src = "ms_tag_cd.jpg" width = "70%" alt = "no image">
</h6>
</a>
<h6 align = "center">
Mapping-Semantics Tag class hierarchy.
</h6>

<ol>
	<li> <a href = "basic_ms_tag.html"><tt>basic_ms_tag</tt></a></li>
	<li> <a href = "data_enabled_ms_tag.html"><tt>data_enabled_ms_tag</tt></a></li>
	<li> <a href = "compound_data_enabled_ms_tag.html"><tt>compound_data_enabled_ms_tag</tt></a></li>
</ol>


<h3>Mapping-Semantics Traits</h3>

<ol>
	<li> <a href = "ms_traits.html"><tt>ms_traits</tt></a></li>
</ol>


<hr>


<h2><a name="ds_policy_classes">Data-Structure Policy Classes</a></h2>


<h3>Hash-Related Policies</h3>

<p>
</p><a href = "hash_based_containers.html">Hash-Based Containers</a> describes
relevant design points.
</p>

<h4>Hash and Probe Policies</h4>
<ol>
    <li> Hash Functions:
        <ol>
            <li> <a href="null_hash_fn.html"><tt>null_hash_fn</tt></a></li>
        </ol>
    </li>
    <li> Range-Hashing Functions:
    <ol>
        <li><a href="sample_range_hashing.html">Interface of a Range-Hashing Function</a></li>
        <li> <a href="direct_mask_range_hashing.html"><tt>direct_mask_range_hashing</tt></a></li>
        <li> <a href="direct_mod_range_hashing.html"><tt>direct_mod_range_hashing</tt></a></li>
    </ol>
    </li>
    <li> Probe Functions:
    <ol>
        <li> <a href="sample_probe_fn.html">Interface of a Probe Function</a></li>
        <li> <a href="linear_probe_fn.html"><tt>linear_probe_fn</tt></a></li>
        <li> <a href="quadratic_probe_fn.html"><tt>quadratic_probe_fn</tt></a></li>
        <li> <a href="null_probe_fn.html"><tt>null_probe_fn</tt></a></li>
    </ol>
    </li>
    <li> Ranged-Hash Functions:
        <ol>
            <li><a href="ranged_hash_fn.html">Interface of a Ranged-Hash Function</a></li>
        </ol>
    </li>
    <li> Ranged-Probe Functions:
        <ol>
            <li> <a href="ranged_probe_fn.html">Interface of a Ranged-Probe function</a></li>
        </ol>
    </li>
</ol>


<h4>Resize Policies</h4>

<h6 align = "center">
<a name = "resize_policy_cd">
<img src = "resize_policy_cd.jpg" width = "70%" alt = "no image">
</a>
</h6>
<h6 align = "center">
Resize policy class diagram.
</h6>

<ol>
    <li> Resize Policies:
        <ol>
            <li> <a href="sample_resize_policy.html">Interface of a Resize Policy</a>
            <li> <a href="ht_standard_resize_policy.html"><tt>ht_standard_resize_policy</tt></a></li>
        </ol>
    </li>
    <li> Size Policies:
    <ol>
        <li> <a href="sample_size_policy.html">Interface of a Size Policy</a></li>
        <li> <a href="ht_exponential_size_policy.html"><tt>ht_exponential_size_policy</tt></a></li>
        <li> <a href="ht_prime_size_policy.html"><tt>ht_prime_size_policy</tt></a></li>
    </ol>
    </li>
    <li> Trigger Policies:
    <ol>
        <li><a href="sample_resize_trigger.html">Interface of a Trigger Policy</a></li>
        <li> <a href="ht_load_check_resize_trigger.html"><tt>ht_load_check_resize_trigger</tt></a></li>
        <li> <a href="ht_max_collision_check_grow_resize_trigger.html"><tt>ht_max_collision_check_grow_resize_trigger</tt></a></li>
    </ol>
    </li>
</ol>


<h3>Tree Node-Update Policies</h3>
<ol>
    <li> <a href = "node_invariants.html">Design of Node Update Policies</a></li>
    <li> <a href="sample_node_updator.html">Interface of a Node Updator Policy</a></li>
    <li> Order-Statistics (Finding Entries by Key Order):
        <ol>
            <li> <a href="order_statistics_key.html"><tt>order_statistics_key</tt></a></li>
            <li> <a href="order_statistics_key_cmp.html"><tt>order_statistics_key_cmp</tt></a></li>
            <li> <a href="order_statistics_node_updator.html"><tt>order_statistics_node_updator</tt></a></li>
            <li> <a href="find_by_order.html"><tt>find_by_order</tt></a></li>
            <li> <a href="order_by_key.html"><tt>order_by_key</tt></a></li>
        </ol>
    </li>
    <li> <a href="null_node_updator.html"><tt>null_node_updator</tt></a></li>
</ol>


<h3>List Update Policies</h3>
<ol>
    <li> <a href = "list_updates.html">Design of List Update Policies</a> </li>
    <li> <a href = "sample_update_policy.html">Interface of a List Update Policy</a> </li>
    <li> Move-to-Front:
        <ol>
            <li> <a href="move_to_front_update_metadata.html"><tt>move_to_front_update_metadata</tt></a></li>
            <li> <a href="move_to_front_update_policy.html"><tt>move_to_front_update_policy</tt></a></li>
        </ol>
    </li>
    <li> Counter:
        <ol>
            <li> <a href="counter_update_metadata.html"><tt>counter_update_metadata</tt></a></li>
            <li> <a href="counter_update_policy.html"><tt>counter_update_policy</tt></a></li>
        </ol>
    </li>
</ol>


<hr>


<h2><a name="exceptions">Exceptions</a></h2>
<ol>
	<li> <a href="pb_assoc_ex.html"><tt>pb_assoc_ex</tt></a></li>
    <li> <a href="cannot_insert.html"><tt>cannot_insert</tt></a></li>
    <li> <a href="cannot_join.html"><tt>cannot_join</tt></a></li>
    <li> <a href="cannot_resize.html"><tt>cannot_resize</tt></a></li>
</ol>


</BODY>
</HTML>