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/] [order_by_key.html] - Rev 20
Compare with Previous | Blame | View Log
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>order_by_key Interface
</title>
</head>
<body>
<h1>
<tt>order_by_key
</tt>
Interface
</h1>
<p>Finds an order corresponding to an entry within the sequence.
</p>
<ol>
<li>
<a href = "../../../../include/ext/pb_assoc/order_statistics_key.hpp"><tt>order_statistics_key.hpp</tt>
</a>
</li>
<li>
<a href = "#link1">Template parameters.
</a>
</li>
<li>
Public Types and Constants:
<ol>
<li>
<a href = "#link2">Key-type definitions.
</a>
</li>
<li>
<a href = "#link3">Container definitions.
</a>
</li>
</ol>
</li>
<li>
Public Methods:
<ol>
<li>
<a href = "#link4">Operators.
</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 = "Cntnr3735929076">Cntnr</a></pre>
</td>
<td>
<p>Container type.</p>
</td>
<td>
-
</td>
</tr>
</table>
<h2>
<a name = "link2">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 = "order_statistics_key_type3735929828">order_statistics_key_type</a></pre>
</td>
<td>
<pre><b>typename</b> <a href = "#Cntnr3735929076">Cntnr</a>::key_type</pre>
</td>
<td>
<p>Order-statistics key type.</p>
</td>
</tr>
<tr>
<td>
<pre><a name = "underlying_key_type3735929533">underlying_key_type</a></pre>
</td>
<td>
<pre><b>typename</b> <a href = "#order_statistics_key_type3735929828">order_statistics_key_type</a>::key_type</pre>
</td>
<td>
<p>Underlying key type.</p>
</td>
</tr>
</table>
<h2>
<a name = "link3">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 = "cntnr3735929108">cntnr</a></pre>
</td>
<td>
<pre><a href = "#Cntnr3735929076">Cntnr</a></pre>
</td>
<td>
<p>Container type.</p>
</td>
</tr>
<tr>
<td>
<pre><a name = "size_type3735929547">size_type</a></pre>
</td>
<td>
<pre><b>typename</b> <a href = "#cntnr3735929108">cntnr</a>::size_type</pre>
</td>
<td>
<p>Container's size type.</p>
</td>
</tr>
</table>
<h2>
<a name = "link4">Operators.
</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>
<b>operator</b>()
(<b>const</b> <a href = "#Cntnr3735929076">Cntnr</a> &r_c,
<b>const</b> <a href = "#underlying_key_type3735929533">underlying_key_type</a> &r_key) <b>const</b></pre>
</td>
<td>
<p>Returns the order of a key within a sequence. For exapmle, if <font color = "#666666"><tt>r_key</tt></font> is the smallest key in <font color = "#666666"><tt>r_c</tt></font>, this method will return 0; if <font color = "#666666"><tt>r_key</tt></font> is a key between the smallest and next key in <font color = "#666666"><tt>r_c</tt></font>, this method will return 1; if <font color = "#666666"><tt>r_key</tt></font> is a key larger than the largest key in <font color = "#666666"><tt>r_c</tt></font>, this method will return the size of <font color = "#666666"><tt>r_c</tt></font>.</p>
</td>
</tr>
</table>
</body>
</html>