<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>STX B+ Tree Template Classes: stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacestx.html">stx</a>::<a class="el" href="classstx_1_1btree.html">btree</a>::<a class="el" href="classstx_1_1btree_1_1value__compare.html">value_compare</a>
</div>
</div>
<div class="contents">
<h1>stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare Class Reference</h1><!-- doxytag: class="stx::btree::value_compare" -->Function class to compare value_type objects. Required by the STL.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="btree_8h-source.html">btree.h</a>></code>
<p>
<p>
<a href="classstx_1_1btree_1_1value__compare-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classstx_1_1btree_1_1value__compare.html#f906f0ee524009f13ea9b2a15bbb7a20">operator()</a> (const <a class="el" href="classstx_1_1btree.html#84c95e7319c922fe297b4acdf2e0910c">value_type</a> &x, const <a class="el" href="classstx_1_1btree.html#84c95e7319c922fe297b4acdf2e0910c">value_type</a> &y) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function call "less"-operator resulting in true if x < y. <a href="#f906f0ee524009f13ea9b2a15bbb7a20"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstx_1_1btree_1_1value__compare.html#31e23ca961b202b9704199aba23598b6">value_compare</a> (<a class="el" href="classstx_1_1btree.html#8f75664f479fc4ca3f54a3a5757d98a7">key_compare</a> kc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor called from <a class="el" href="classstx_1_1btree.html#94273af1fe4b9e2e0c0b6daeaa5f5950" title="Constant access to a constructed value_type comparison object.">btree::value_comp()</a>. <a href="#31e23ca961b202b9704199aba23598b6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstx_1_1btree.html#8f75664f479fc4ca3f54a3a5757d98a7">key_compare</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstx_1_1btree_1_1value__compare.html#05f376ec84125db57b3042d3e0d187e8">key_comp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Key comparison function from the template parameter. <a href="#05f376ec84125db57b3042d3e0d187e8"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classstx_1_1btree_1_1value__compare.html#88a92ebc50ded4cd953211ac83751e12">btree< key_type, data_type, value_type, key_compare, traits, allow_duplicates ></a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Friendly to the <a class="el" href="classstx_1_1btree.html" title="Basic class implementing a base B+ tree data structure in memory.">btree</a> class so it may call the constructor. <a href="#88a92ebc50ded4cd953211ac83751e12"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false><br>
class stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare</h3>
Function class to compare value_type objects. Required by the STL.
<p>Definition at line <a class="el" href="btree_8h-source.html#l01295">1295</a> of file <a class="el" href="btree_8h-source.html">btree.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="31e23ca961b202b9704199aba23598b6"></a><!-- doxytag: member="stx::btree::value_compare::value_compare" ref="31e23ca961b202b9704199aba23598b6" args="(key_compare kc)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare::value_compare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstx_1_1btree.html#8f75664f479fc4ca3f54a3a5757d98a7">key_compare</a> </td>
<td class="paramname"> <em>kc</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor called from <a class="el" href="classstx_1_1btree.html#94273af1fe4b9e2e0c0b6daeaa5f5950" title="Constant access to a constructed value_type comparison object.">btree::value_comp()</a>.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01302">1302</a> of file <a class="el" href="btree_8h-source.html">btree.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f906f0ee524009f13ea9b2a15bbb7a20"></a><!-- doxytag: member="stx::btree::value_compare::operator()" ref="f906f0ee524009f13ea9b2a15bbb7a20" args="(const value_type &x, const value_type &y) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare::operator() </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstx_1_1btree.html#84c95e7319c922fe297b4acdf2e0910c">value_type</a> & </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstx_1_1btree.html#84c95e7319c922fe297b4acdf2e0910c">value_type</a> & </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function call "less"-operator resulting in true if x < y.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01311">1311</a> of file <a class="el" href="btree_8h-source.html">btree.h</a>.</p>
<p>References <a class="el" href="btree_8h-source.html#l01299">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare::key_comp</a>.</p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="88a92ebc50ded4cd953211ac83751e12"></a><!-- doxytag: member="stx::btree::value_compare::btree< key_type, data_type, value_type, key_compare, traits, allow_duplicates >" ref="88a92ebc50ded4cd953211ac83751e12" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false> </div>
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classstx_1_1btree.html">btree</a>< <a class="el" href="classstx_1_1btree.html#2054714c400894aa8822f0f52bc120cf">key_type</a>, <a class="el" href="classstx_1_1btree.html#ca29ad902418d86eeb9b9379a38e5fcd">data_type</a>, <a class="el" href="classstx_1_1btree.html#84c95e7319c922fe297b4acdf2e0910c">value_type</a>, <a class="el" href="classstx_1_1btree.html#8f75664f479fc4ca3f54a3a5757d98a7">key_compare</a>, <a class="el" href="classstx_1_1btree.html#a84bef0ec11542ba1f9c49566d653629">traits</a>, <a class="el" href="classstx_1_1btree.html#35378979c13861883affefda9ad95df7">allow_duplicates</a> ><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Friendly to the <a class="el" href="classstx_1_1btree.html" title="Basic class implementing a base B+ tree data structure in memory.">btree</a> class so it may call the constructor.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01307">1307</a> of file <a class="el" href="btree_8h-source.html">btree.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="05f376ec84125db57b3042d3e0d187e8"></a><!-- doxytag: member="stx::btree::value_compare::key_comp" ref="05f376ec84125db57b3042d3e0d187e8" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _Key, typename _Data, typename _Value = std::pair<_Key, _Data>, typename _Compare = std::less<_Key>, typename _Traits = btree_default_map_traits<_Key, _Data>, bool _Duplicates = false> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstx_1_1btree.html#8f75664f479fc4ca3f54a3a5757d98a7">key_compare</a> <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::<a class="el" href="classstx_1_1btree_1_1value__compare.html#05f376ec84125db57b3042d3e0d187e8">value_compare::key_comp</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Key comparison function from the template parameter.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01299">1299</a> of file <a class="el" href="btree_8h-source.html">btree.h</a>.</p>
<p>Referenced by <a class="el" href="btree_8h-source.html#l01311">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::value_compare::operator()()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>stx/<a class="el" href="btree_8h-source.html">btree.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Sep 7 17:32:39 2008 for STX B+ Tree Template Classes by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
