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_assoc_cntnr_no_data.html] - Rev 20
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>basic_assoc_cntnr Interface </title> </head> <body> <h1> <tt>basic_assoc_cntnr </tt> Interface </h1> <p>A basic associative container specialized for the "set" case. </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> Public Types and Constants: <ol> <li> <a href = "#link2">General container definitions. </a> </li> <li> <a href = "#link3">Categories. </a> </li> <li> <a href = "#link4">Policy definitions. </a> </li> <li> <a href = "#link5">Key-type definitions. </a> </li> <li> <a href = "#link6">Value-type definitions. </a> </li> <li> <a href = "#link7">Iterator definitions. </a> </li> </ol> </li> <li> Public Methods: <ol> <li> <a href = "#link8">Constructors, destructor, and related. </a> </li> <li> <a href = "#link9">Information methods. </a> </li> <li> <a href = "#link10">Insert methods. </a> </li> <li> <a href = "#link11">Find methods. </a> </li> <li> <a href = "#link12">Erase methods. </a> </li> <li> <a href = "#link13">Iteration 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 = "DS_Tag3735929089">DS_Tag</a></pre> </td> <td> <p>Data structure tag.</p> </td> <td> - </td> </tr> <tr> <td> <pre><a name = "Policy_Tl3735929470">Policy_Tl</a></pre> </td> <td> <p>Policy typelist.</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">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> <tr> <td> <pre><a name = "difference_type3735930139">difference_type</a></pre> </td> <td> <pre><b>typename</b> <a href = "#Allocator3735929488">Allocator</a>::difference_type</pre> </td> <td> <p>Difference type.</p> </td> </tr> </table> <h2> <a name = "link3">Categories. </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 = "ds_category3735929731">ds_category</a></pre> </td> <td> <pre><a href = "#DS_Tag3735929089">DS_Tag</a></pre> </td> <td> <p>The underlying data-structure tag of the container. comment = </p> </td> </tr> <tr> <td> <pre><a name = "ms_category3735929740">ms_category</a></pre> </td> <td> <pre><a href = "basic_ms_tag.html"><tt>basic_ms_tag</tt></a></pre> </td> <td> <p>The mapping-semantics category of the container.</p> </td> </tr> </table> <h2> <a name = "link4">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 = "allocator3735929520">allocator</a></pre> </td> <td> <pre><a href = "#Allocator3735929488">Allocator</a></pre> </td> <td> <p>Allocator type.</p> </td> </tr> </table> <h2> <a name = "link5">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 = "key_type3735929433">key_type</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::<b>template</b> rebind< <a href = "#Key3735928856">Key</a>>::other::value_type</pre> </td> <td> <p>Key type.</p> </td> </tr> <tr> <td> <pre><a name = "key_reference3735929926">key_reference</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::<b>template</b> rebind< <a href = "#Key3735928856">Key</a>>::other::reference</pre> </td> <td> <p>Key reference type.</p> </td> </tr> <tr> <td> <pre><a name = "const_key_reference3735929552">const_key_reference</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">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> <tr> <td> <pre><a name = "key_pointer3735929752">key_pointer</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::<b>template</b> rebind< <a href = "#Key3735928856">Key</a>>::other::pointer</pre> </td> <td> <p>Key pointer type.</p> </td> </tr> <tr> <td> <pre><a name = "const_key_pointer3735929445">const_key_pointer</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::<b>template</b> rebind< <a href = "#Key3735928856">Key</a>>::other::const_pointer</pre> </td> <td> <p>Const key pointer type.</p> </td> </tr> </table> <h2> <a name = "link6">Value-type definitions. </a> </h2> <p><p>Types pertaining to the <b>domain</b> of the relationships of the table.</p> <p>This is explained in <a href = "concepts.html#concepts_types">Data Types, Value Types, Mapped Data Types, and Mapped Value Types</a> and <a href = "non_unique_mapping.html#types">Mapped Data Types and Mapped Value Types</a>.</p></p> <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 = "value_type3735929645">value_type</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::rebind< <a href = "#key_type3735929433">key_type</a>>::other::value_type</pre> </td> <td> <p>Data type.</p> </td> </tr> <tr> <td> <pre><a name = "reference3735929502">reference</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::rebind< <a href = "#key_type3735929433">key_type</a>>::other::const_reference</pre> </td> <td> <p>Value reference type.</p> </td> </tr> <tr> <td> <pre><a name = "const_reference3735930148">const_reference</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::rebind< <a href = "#key_type3735929433">key_type</a>>::other::const_reference</pre> </td> <td> <p>Const value reference type.</p> </td> </tr> <tr> <td> <pre><a name = "pointer3735929328">pointer</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::rebind< <a href = "#key_type3735929433">key_type</a>> >::other::const_pointer</pre> </td> <td> <p>Value pointer type.</p> </td> </tr> <tr> <td> <pre><a name = "const_pointer3735929974">const_pointer</a></pre> </td> <td> <pre><b>typename</b> <a href = "#allocator3735929520">allocator</a>::rebind< <a href = "#key_type3735929433">key_type</a>> >::other::const_pointer</pre> </td> <td> <p>Const Value pointer type.</p> </td> </tr> </table> <h2> <a name = "link7">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_find_iterator3735929537">const_find_iterator</a></pre> </td> <td> <pre>Underlying data-structure's const find-type iterator.</pre> </td> <td> <p>Const find-type iterator.</p> </td> </tr> <tr> <td> <pre><a name = "find_iterator3735929945">find_iterator</a></pre> </td> <td> <pre>Underlying data-structure's find-type iterator.</pre> </td> <td> <p>Find-type iterator.</p> </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> </table> <h2> <a name = "link8">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_assoc_cntnr ()</pre> </td> <td> <p>Destructor.</p> </td> </tr> </table> <h2> <a name = "link9">Information 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> size () <b>const</b></pre> </td> <td> <p>Returns the number of distinct <a href = "#value_type3735929645"><tt>value_type</tt></a> objects the container object is storing.</p> </td> </tr> <tr> <td> <pre><b>inline</b> <a href = "#size_type3735929547">size_type</a> max_size () <b>const</b></pre> </td> <td> <p>Returns an upper bound on the number of distinct <a href = "#value_type3735929645"><tt>value_type</tt></a> objects this container can store.</p> </td> </tr> <tr> <td> <pre><b>inline</b> <b>bool</b> empty () <b>const</b></pre> </td> <td> <p>Returns whether the container object is not storing any <a href = "#value_type3735929645"><tt>value_type</tt></a> objects.</p> </td> </tr> <tr> <td> <pre><b>inline</b> static <a href = "#const_key_reference3735929552">const_key_reference</a> extract_key (<a href = "#const_reference3735930148">const_reference</a> r_val)</pre> </td> <td> <p>Extracts a key from a <a href = "#value_type3735929645"><tt>value_type</tt></a>.</p> </td> </tr> </table> <h2> <a name = "link10">Insert 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> std::pair<<a href = "#find_iterator3735929945">find_iterator</a>, <b>bool</b>> insert (<a href = "#const_reference3735930148">const_reference</a> r_val)</pre> </td> <td> <p>Inserts a <a href = "#value_type3735929645"><tt>value_type</tt></a> object. If no <a href = "#value_type3735929645"><tt>value_type</tt></a> with <font color = "#666666"><tt>r_val</tt></font>'s key was in the container object, inserts and returns (<a href = "#find_iterator3735929945"><tt>find_iterator</tt></a> object associated with <font color = "#666666"><tt>r_val</tt></font>, <tt><b>true</b></tt>); otherwise just returns (<a href = "#find_iterator3735929945"><tt>find_iterator</tt></a> object associated with <font color = "#666666"><tt>r_val</tt></font>'s key, <tt><b>false</b></tt>).</p> </td> </tr> </table> <h2> <a name = "link11">Find 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 = "#find_iterator3735929945">find_iterator</a> find (<a href = "#const_key_reference3735929552">const_key_reference</a> r_key)</pre> </td> <td> <p>Returns the <a href = "#find_iterator3735929945"><tt>find_iterator</tt></a> corresponding to the <a href = "#value_type3735929645"><tt>value_type</tt></a> with <font color = "#666666"><tt>r_key</tt></font> as its key, or the <a href = "#find_iterator3735929945"><tt>find_iterator</tt></a> corresponding to the just-after-last entry if no such <a href = "#value_type3735929645"><tt>value_type</tt></a>.</p> </td> </tr> <tr> <td> <pre><b>inline</b> <a href = "#const_find_iterator3735929537">const_find_iterator</a> find (<a href = "#const_key_reference3735929552">const_key_reference</a> r_key) <b>const</b></pre> </td> <td> <p>Returns the <a href = "#const_find_iterator3735929537"><tt>const_find_iterator</tt></a> corresponding to the <a href = "#value_type3735929645"><tt>value_type</tt></a> with <font color = "#666666"><tt>r_key</tt></font> as its key, or the <a href = "#const_find_iterator3735929537"><tt>const_find_iterator</tt></a> corresponding to the just-after-last entry if no such <a href = "#value_type3735929645"><tt>value_type</tt></a>.</p> </td> </tr> </table> <h2> <a name = "link12">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 <a href = "#value_type3735929645"><tt>value_type</tt></a> associated with <font color = "#666666"><tt>r_key</tt></font>; returns the number of <a href = "#value_type3735929645"><tt>value_type</tt></a>s erased (0 or 1).</p> </td> </tr> <tr> <td> <pre><b>template</b>< <b>class</b> Pred> <b>inline</b> <a href = "#size_type3735929547">size_type</a> erase_if (Pred prd)</pre> </td> <td> <p>Erases any <a href = "#value_type3735929645"><tt>value_type</tt></a> satisfying the predicate <font color = "#666666"><tt>prd</tt></font> (this is transactional, either all matching <a href = "#value_type3735929645"><tt>value_type</tt></a>s are erased, or, if an exception is thrown (for types whose erase can throw an exception) none); returns the number of <a href = "#value_type3735929645"><tt>value_type</tt></a>s erased.</p> </td> </tr> <tr> <td> <pre><b>void</b> clear ()</pre> </td> <td> <p>Clears the container object.</p> </td> </tr> </table> <h2> <a name = "link13">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 = "#iterator3735929433">iterator</a> begin ()</pre> </td> <td> <p>Returns an <a href = "#iterator3735929433"><tt>iterator</tt></a> corresponding to the first <a href = "#value_type3735929645"><tt>value_type</tt></a> in the container.</p> </td> </tr> <tr> <td> <pre><b>inline</b> <a href = "#const_iterator3735930079">const_iterator</a> begin () <b>const</b></pre> </td> <td> <p>Returns a <a href = "#const_iterator3735930079"><tt>const_iterator</tt></a> corresponding to the first <a href = "#value_type3735929645"><tt>value_type</tt></a> in the container.</p> </td> </tr> <tr> <td> <pre><b>inline</b> <a href = "#iterator3735929433">iterator</a> end ()</pre> </td> <td> <p>Returns an <a href = "#iterator3735929433"><tt>iterator</tt></a> corresponding to the just-after_last <a href = "#value_type3735929645"><tt>value_type</tt></a> in the container.</p> </td> </tr> <tr> <td> <pre><b>inline</b> <a href = "#const_iterator3735930079">const_iterator</a> end () <b>const</b></pre> </td> <td> <p>Returns a <a href = "#const_iterator3735930079"><tt>const_iterator</tt></a> corresponding to the just-after_last <a href = "#value_type3735929645"><tt>value_type</tt></a> in the container.</p> </td> </tr> </table> </body> </html>