<!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 >::tree_stats Struct 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="structstx_1_1btree_1_1tree__stats.html">tree_stats</a>
</div>
</div>
<div class="contents">
<h1>stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats Struct Reference</h1><!-- doxytag: class="stx::btree::tree_stats" -->A small struct containing basic statistics about the B+ tree.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="btree_8h-source.html">btree.h</a>></code>
<p>
<p>
<a href="structstx_1_1btree_1_1tree__stats-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#bc29398f753b55b9d0fed98e2386ad7e">tree_stats</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Zero initialized. <a href="#bc29398f753b55b9d0fed98e2386ad7e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstx_1_1btree.html#973470864b67129983ea4e1aa2132ac5">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#9935c861736aee34259104bd52c5cf69">nodes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of nodes. <a href="#9935c861736aee34259104bd52c5cf69"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#f442a770bb4acf9c716139b4f29201dc">avgfill_leaves</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the average fill of leaves. <a href="#f442a770bb4acf9c716139b4f29201dc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstx_1_1btree.html#973470864b67129983ea4e1aa2132ac5">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#8822d400b91499816b6c985e781e9018">itemcount</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of items in the B+ tree. <a href="#8822d400b91499816b6c985e781e9018"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstx_1_1btree.html#973470864b67129983ea4e1aa2132ac5">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#9e4f92e0aa1d90cbf823a3b072495be6">leaves</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of leaves in the B+ tree. <a href="#9e4f92e0aa1d90cbf823a3b072495be6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstx_1_1btree.html#973470864b67129983ea4e1aa2132ac5">size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#2899f2f8e09b4f8e9be8effb3492deed">innernodes</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of inner nodes in the B+ tree. <a href="#2899f2f8e09b4f8e9be8effb3492deed"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#b32f0e23ddeb36d9880a5a132529d916">leafslots</a> = <a class="el" href="classstx_1_1btree.html#12a39ca671e962924f4acf879a44eafc">btree_self::leafslotmax</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base B+ tree parameter: The number of key/data slots in each leaf. <a href="#b32f0e23ddeb36d9880a5a132529d916"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="structstx_1_1btree_1_1tree__stats.html#0b90769f6b8be18b1d97b0c50b6f041b">innerslots</a> = <a class="el" href="classstx_1_1btree.html#83a18c2fb7f4e9cfd47ce7545d004324">btree_self::innerslotmax</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base B+ tree parameter: The number of key slots in each inner <a class="el" href="structstx_1_1btree_1_1node.html" title="The header structure of each node in-memory.">node</a>. <a href="#0b90769f6b8be18b1d97b0c50b6f041b"></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>
struct stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats</h3>
A small struct containing basic statistics about the B+ tree.
<p>
It can be fetched using <a class="el" href="classstx_1_1btree.html#8748bb3788c1e1d65dbfe9500d33a134" title="Return a const reference to the current statistics.">get_stats()</a>.
<p>Definition at line <a class="el" href="btree_8h-source.html#l01183">1183</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="bc29398f753b55b9d0fed98e2386ad7e"></a><!-- doxytag: member="stx::btree::tree_stats::tree_stats" ref="bc29398f753b55b9d0fed98e2386ad7e" 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">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::tree_stats </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Zero initialized.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01201">1201</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="9935c861736aee34259104bd52c5cf69"></a><!-- doxytag: member="stx::btree::tree_stats::nodes" ref="9935c861736aee34259104bd52c5cf69" args="() 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"><a class="el" href="classstx_1_1btree.html#973470864b67129983ea4e1aa2132ac5">size_type</a> <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::nodes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the total number of nodes.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01208">1208</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#l01192">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::innernodes</a>, and <a class="el" href="btree_8h-source.html#l01189">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::leaves</a>.</p>
</div>
</div><p>
<a class="anchor" name="f442a770bb4acf9c716139b4f29201dc"></a><!-- doxytag: member="stx::btree::tree_stats::avgfill_leaves" ref="f442a770bb4acf9c716139b4f29201dc" args="() 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">double <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::avgfill_leaves </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the average fill of leaves.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01214">1214</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#l01186">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::itemcount</a>, <a class="el" href="btree_8h-source.html#l01195">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::leafslots</a>, and <a class="el" href="btree_8h-source.html#l01189">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::leaves</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="8822d400b91499816b6c985e781e9018"></a><!-- doxytag: member="stx::btree::tree_stats::itemcount" ref="8822d400b91499816b6c985e781e9018" 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#973470864b67129983ea4e1aa2132ac5">size_type</a> <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::<a class="el" href="structstx_1_1btree_1_1tree__stats.html#8822d400b91499816b6c985e781e9018">tree_stats::itemcount</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of items in the B+ tree.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01186">1186</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#l01214">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::avgfill_leaves()</a>, <a class="el" href="btree_8h-source.html#l01397">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::clear()</a>, <a class="el" href="btree_8h-source.html#l02335">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::erase_one()</a>, <a class="el" href="btree_8h-source.html#l02400">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::erase_one_descend()</a>, <a class="el" href="btree_8h-source.html#l02008">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::insert_start()</a>, <a class="el" href="btree_8h-source.html#l03287">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::restore()</a>, <a class="el" href="btree_8h-source.html#l01598">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::size()</a>, and <a class="el" href="btree_8h-source.html#l03053">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::verify()</a>.</p>
</div>
</div><p>
<a class="anchor" name="9e4f92e0aa1d90cbf823a3b072495be6"></a><!-- doxytag: member="stx::btree::tree_stats::leaves" ref="9e4f92e0aa1d90cbf823a3b072495be6" 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#973470864b67129983ea4e1aa2132ac5">size_type</a> <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::<a class="el" href="structstx_1_1btree_1_1tree__stats.html#9e4f92e0aa1d90cbf823a3b072495be6">tree_stats::leaves</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of leaves in the B+ tree.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01189">1189</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#l01362">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::allocate_leaf()</a>, <a class="el" href="btree_8h-source.html#l01214">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::avgfill_leaves()</a>, <a class="el" href="btree_8h-source.html#l01888">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::btree()</a>, <a class="el" href="btree_8h-source.html#l02400">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::erase_one_descend()</a>, <a class="el" href="btree_8h-source.html#l01381">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::free_node()</a>, <a class="el" href="btree_8h-source.html#l01208">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::nodes()</a>, <a class="el" href="btree_8h-source.html#l01865">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::operator=()</a>, and <a class="el" href="btree_8h-source.html#l03053">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::verify()</a>.</p>
</div>
</div><p>
<a class="anchor" name="2899f2f8e09b4f8e9be8effb3492deed"></a><!-- doxytag: member="stx::btree::tree_stats::innernodes" ref="2899f2f8e09b4f8e9be8effb3492deed" 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#973470864b67129983ea4e1aa2132ac5">size_type</a> <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::<a class="el" href="structstx_1_1btree_1_1tree__stats.html#2899f2f8e09b4f8e9be8effb3492deed">tree_stats::innernodes</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of inner nodes in the B+ tree.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01192">1192</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#l01371">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::allocate_inner()</a>, <a class="el" href="btree_8h-source.html#l01888">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::btree()</a>, <a class="el" href="btree_8h-source.html#l02400">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::erase_one_descend()</a>, <a class="el" href="btree_8h-source.html#l01381">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::free_node()</a>, <a class="el" href="btree_8h-source.html#l01208">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::nodes()</a>, <a class="el" href="btree_8h-source.html#l01865">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::operator=()</a>, and <a class="el" href="btree_8h-source.html#l03053">stx::btree< _Key, _Data, std::pair< key_type, data_type >, _Compare, _Traits, true >::verify()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b32f0e23ddeb36d9880a5a132529d916"></a><!-- doxytag: member="stx::btree::tree_stats::leafslots" ref="b32f0e23ddeb36d9880a5a132529d916" 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">const unsigned short <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::<a class="el" href="structstx_1_1btree_1_1tree__stats.html#b32f0e23ddeb36d9880a5a132529d916">tree_stats::leafslots</a> = <a class="el" href="classstx_1_1btree.html#12a39ca671e962924f4acf879a44eafc">btree_self::leafslotmax</a><code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Base B+ tree parameter: The number of key/data slots in each leaf.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01195">1195</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#l01214">stx::btree< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::tree_stats::avgfill_leaves()</a>.</p>
</div>
</div><p>
<a class="anchor" name="0b90769f6b8be18b1d97b0c50b6f041b"></a><!-- doxytag: member="stx::btree::tree_stats::innerslots" ref="0b90769f6b8be18b1d97b0c50b6f041b" 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">const unsigned short <a class="el" href="classstx_1_1btree.html">stx::btree</a>< _Key, _Data, _Value, _Compare, _Traits, _Duplicates >::<a class="el" href="structstx_1_1btree_1_1tree__stats.html#0b90769f6b8be18b1d97b0c50b6f041b">tree_stats::innerslots</a> = <a class="el" href="classstx_1_1btree.html#83a18c2fb7f4e9cfd47ce7545d004324">btree_self::innerslotmax</a><code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Base B+ tree parameter: The number of key slots in each inner <a class="el" href="structstx_1_1btree_1_1node.html" title="The header structure of each node in-memory.">node</a>.
<p>
<p>Definition at line <a class="el" href="btree_8h-source.html#l01198">1198</a> of file <a class="el" href="btree_8h-source.html">btree.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct 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>
