URL
https://opencores.org/ocsvn/scarts/scarts/trunk
Subversion Repositories scarts
[/] [scarts/] [trunk/] [toolchain/] [scarts-gcc/] [gcc-4.1.1/] [libstdc++-v3/] [docs/] [html/] [ext/] [pb_assoc/] [basic_tree_assoc_cntnr_rev.html] - Rev 20
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>basic_tree_assoc_cntnr Interface
</title>
</head>
<body>
<h1>
<tt>basic_tree_assoc_cntnr
</tt>
Interface
</h1>
<p>A basic tree-based associative container specialized for underlying data-structure which do not support reverse iteration.
</p>
<ol>
<li>
<a href = "../../../../include/ext/pb_assoc/assoc_cntnr.hpp"><tt>assoc_cntnr.hpp</tt>
</a>
</li>
<li>
<a href = "#link1">Template parameters.
</a>
</li>
<li>
<a href = "#link2">Base classes.
</a>
</li>
<li>
Public Types and Constants:
<ol>
<li>
<a href = "#link3">General container definitions.
</a>
</li>
<li>
<a href = "#link4">Key-type definitions.
</a>
</li>
<li>
<a href = "#link5">Policy definitions.
</a>
</li>
<li>
<a href = "#link6">Iterator definitions.
</a>
</li>
</ol>
</li>
<li>
Public Methods:
<ol>
<li>
<a href = "#link7">Constructors, destructor, and related.
</a>
</li>
<li>
<a href = "#link8">Policy access methods.
</a>
</li>
<li>
<a href = "#link9">Erase methods.
</a>
</li>
<li>
<a href = "#link10">Node-Iteration methods.
</a>
</li>
<li>
<a href = "#link11">Split and join methods.
</a>
</li>
</ol>
</li>
</ol>
<h2>
<a name = "link1">Template parameters.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "Key3735928856">Key</a></pre>
</td>
<td>
<p>Key type.</p>
</td>
<td>
-
</td>
</tr>
<tr>
<td>
<pre><a name = "Data3735928937">Data</a></pre>
</td>
<td>
<p>Data type.</p>
</td>
<td>
-
</td>
</tr>
<tr>
<td>
<pre><a name = "Cmp_Fn3735929122">Cmp_Fn</a></pre>
</td>
<td>
<p>Comparison functor.</p>
</td>
<td>
-
</td>
</tr>
<tr>
<td>
<pre><a name = "Node_Updator3735929779">Node_Updator</a></pre>
</td>
<td>
<p>Node updator type.</p>
<p><a href = "concepts.html#concepts_node_invariants">Node Invariants</a> explains this concept.</p>
</td>
<td>
-
</td>
</tr>
<tr>
<td>
<pre><a name = "Allocator3735929488">Allocator</a></pre>
</td>
<td>
<p>Allocator type.</p>
</td>
<td>
-
</td>
</tr>
</table>
<h2>
<a name = "link2">Base classes.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "#Node_Updator3735929779">Node_Updator</a></pre>
</td>
<td>
<p>public</p>
</td>
</tr>
</table>
<h2>
<a name = "link3">General container definitions.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "size_type3735929547">size_type</a></pre>
</td>
<td>
<pre><b>typename</b> <a href = "#Allocator3735929488">Allocator</a>::size_type</pre>
</td>
<td>
<p>Size type.</p>
</td>
</tr>
</table>
<h2>
<a name = "link4">Key-type definitions.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "const_key_reference3735929552">const_key_reference</a></pre>
</td>
<td>
<pre><b>typename</b> <a href = "#Allocator3735929488">Allocator</a>::<b>template</b> rebind<
<a href = "#Key3735928856">Key</a>>::other::const_reference</pre>
</td>
<td>
<p>Const key reference type.</p>
</td>
</tr>
</table>
<h2>
<a name = "link5">Policy definitions.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "cmp_fn3735929186">cmp_fn</a></pre>
</td>
<td>
<pre><a href = "#Cmp_Fn3735929122">Cmp_Fn</a></pre>
</td>
<td>
<p>Comparison functor type.</p>
</td>
</tr>
<tr>
<td>
<pre><a name = "node_updator3735929843">node_updator</a></pre>
</td>
<td>
<pre><a href = "#Node_Updator3735929779">Node_Updator</a></pre>
</td>
<td>
<p>Node updator type.</p>
</td>
</tr>
</table>
<h2>
<a name = "link6">Iterator definitions.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "const_iterator3735930079">const_iterator</a></pre>
</td>
<td>
<pre>Underlying data-structure's const range-type iterator.</pre>
</td>
<td>
<p>Const range-type iterator.</p>
</td>
</tr>
<tr>
<td>
<pre><a name = "iterator3735929433">iterator</a></pre>
</td>
<td>
<pre>Underlying data-structure's range-type iterator.</pre>
</td>
<td>
<p>Range-type iterator.</p>
</td>
</tr>
<tr>
<td>
<pre><a name = "const_node_iterator3735929535">const_node_iterator</a></pre>
</td>
<td>
<pre><a href = "basic_tree_assoc_cntnr_const_node_iterator.html"><tt><font color = "olive">basic_tree_assoc_cntnr</font>::const_node_iterator</tt></a></pre>
</td>
<td>
<p>Const node iterator.</p>
</td>
</tr>
<tr>
<td>
<pre><a name = "node_iterator3735929950">node_iterator</a></pre>
</td>
<td>
<pre><a href = "basic_tree_assoc_cntnr_node_iterator.html"><tt><font color = "olive">basic_tree_assoc_cntnr</font>::node_iterator</tt></a></pre>
</td>
<td>
<p>Node iterator.</p>
</td>
</tr>
</table>
<h2>
<a name = "link7">Constructors, destructor, and related.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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_tree_assoc_cntnr
()</pre>
</td>
<td>
<p>Destructor.</p>
</td>
</tr>
</table>
<h2>
<a name = "link8">Policy access methods.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<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 = "#cmp_fn3735929186">cmp_fn</a> &
get_cmp_fn
()</pre>
</td>
<td>
<p>Access to the <a href = "#cmp_fn3735929186"><tt>cmp_fn</tt></a> object.</p>
</td>
</tr>
<tr>
<td>
<pre><b>const</b> <a href = "#cmp_fn3735929186">cmp_fn</a> &
get_cmp_fn
() <b>const</b></pre>
</td>
<td>
<p>Const access to the <a href = "#cmp_fn3735929186"><tt>cmp_fn</tt></a> object.</p>
</td>
</tr>
<tr>
<td>
<pre><a href = "#node_updator3735929843">node_updator</a> &
get_node_updator
()</pre>
</td>
<td>
<p>Access to the <a href = "#node_updator3735929843"><tt>node_updator</tt></a> object.</p>
</td>
</tr>
<tr>
<td>
<pre><b>const</b> <a href = "#node_updator3735929843">node_updator</a> &
get_node_updator
() <b>const</b></pre>
</td>
<td>
<p>Const access to the <a href = "#node_updator3735929843"><tt>node_updator</tt></a> object.</p>
</td>
</tr>
</table>
<h2>
<a name = "link9">Erase methods.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
<tr>
<td>
<pre><b>inline</b> <a href = "#size_type3735929547">size_type</a>
erase
(<a href = "#const_key_reference3735929552">const_key_reference</a> r_key)</pre>
</td>
<td>
<p>Erases the value_type associated with <font color = "#666666"><tt>r_key</tt></font>; returns the number of value_types erased (0 or 1).</p>
</td>
</tr>
<tr>
<td>
<pre><b>inline</b> <a href = "#iterator3735929433">iterator</a>
erase
(<a href = "#iterator3735929433">iterator</a> it)</pre>
</td>
<td>
<p>Erases the value_type corresponding to the <a href = "#iterator3735929433"><tt>iterator</tt></a> <font color = "#666666"><tt>it</tt></font>. Returns the <a href = "#iterator3735929433"><tt>iterator</tt></a> corresponding to the next value_type.</p>
</td>
</tr>
</table>
<h2>
<a name = "link10">Node-Iteration methods.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
<tr>
<td>
<pre><b>inline</b> <a href = "#node_iterator3735929950">node_iterator</a>
node_begin
()</pre>
</td>
<td>
<p>Returns a <a href = "#node_iterator3735929950"><tt>node_iterator</tt></a> corresponding to the value_type at the root of the tree.</p>
</td>
</tr>
<tr>
<td>
<pre><b>inline</b> <a href = "#const_node_iterator3735929535">const_node_iterator</a>
node_begin
() <b>const</b></pre>
</td>
<td>
<p>Returns a <a href = "#const_node_iterator3735929535"><tt>const_node_iterator</tt></a> corresponding to the value_type at the root of the tree.</p>
</td>
</tr>
<tr>
<td>
<pre><b>inline</b> <a href = "#node_iterator3735929950">node_iterator</a>
node_end
()</pre>
</td>
<td>
<p>Returns a <a href = "#node_iterator3735929950"><tt>node_iterator</tt></a> corresponding to a value_type just after a leaf of the tree.</p>
</td>
</tr>
<tr>
<td>
<pre><b>inline</b> <a href = "#const_node_iterator3735929535">const_node_iterator</a>
node_end
() <b>const</b></pre>
</td>
<td>
<p>Returns a <a href = "#const_node_iterator3735929535"><tt>const_node_iterator</tt></a> corresponding to a value_type just after a leaf of the tree.</p>
</td>
</tr>
</table>
<h2>
<a name = "link11">Split and join methods.
</a>
</h2>
<table WIDTH = "100%" BORDER = "1">
<TR><TD Width = "45%" ALIGN = "left"><b>Method</b></TD><TD Width = "55%" ALIGN = "left"><b>Description</b></TD></TR>
<tr>
<td>
<pre><b>void</b>
join
(<font color = "olive">basic_tree_assoc_cntnr</font> &r_other)</pre>
</td>
<td>
<p>Joins two trees. When this function returns, <font color = "#666666"><tt>r_other</tt></font> will be empty.</p>
</td>
</tr>
<tr>
<td>
<pre><b>inline</b> <b>void</b>
split
(<a href = "#const_key_reference3735929552">const_key_reference</a> r_key,
<font color = "olive">basic_tree_assoc_cntnr</font> &r_other)</pre>
</td>
<td>
<p>Joins two trees. When this function returns, <font color = "#666666"><tt>r_other</tt></font> will be empty.</p>
</td>
</tr>
</table>
</body>
</html>