<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Kyoto Cabinet: kyotocabinet::TinyHashMap::Sorter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Kyoto Cabinet </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a> </li> <li class="navelem"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> </li> <li class="navelem"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html">Sorter</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">kyotocabinet::TinyHashMap::Sorter Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="kyotocabinet::TinyHashMap::Sorter" --> <p><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html" title="Sorter of records.">Sorter</a> of records. <a href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#details">More...</a></p> <p><code>#include <kcmap.h></code></p> <p><a href="classkyotocabinet_1_1TinyHashMap_1_1Sorter-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#aed51f631acd7539582663b730368451d">Sorter</a> (<a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> *map)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aed51f631acd7539582663b730368451d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#ab17a849095758d678dde042480550f69">~Sorter</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab17a849095758d678dde042480550f69"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#a6a7347bedca1125145547839f805c835">get_key</a> (size_t *sp)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key of the current record. <a href="#a6a7347bedca1125145547839f805c835"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#accfe868d8cdd5eac2fa13c0b9af39578">get_value</a> (size_t *sp)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the current record. <a href="#accfe868d8cdd5eac2fa13c0b9af39578"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#ac29a1415a597cd1a084b3cb574064e9b">get</a> (size_t *ksp, const char **vbp, size_t *vsp)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pair of the key and the value of the current record. <a href="#ac29a1415a597cd1a084b3cb574064e9b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#a03e37ddd7a89d6b0f4007331c79888da">step</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the next record. <a href="#a03e37ddd7a89d6b0f4007331c79888da"></a><br/></td></tr> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#ace5defb7872f62d58e90610613026ebf">map_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The container. <a href="#ace5defb7872f62d58e90610613026ebf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#af1caf6dfa1a9938f06ae458a73fa5c1b">ridx_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The current record index. <a href="#af1caf6dfa1a9938f06ae458a73fa5c1b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::vector< char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#a5ec750ceb17a2da906091df19dd5d056">recs_</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The current records. <a href="#a5ec750ceb17a2da906091df19dd5d056"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html" title="Sorter of records.">Sorter</a> of records. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aed51f631acd7539582663b730368451d"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::Sorter" ref="aed51f631acd7539582663b730368451d" args="(TinyHashMap *map)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#aed51f631acd7539582663b730368451d">kyotocabinet::TinyHashMap::Sorter::Sorter</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> * </td> <td class="paramname"><em>map</em></td><td>)</td> <td><code> [explicit]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">map</td><td>the container. </td></tr> </table> </dd> </dl> <dl class="note"><dt><b>Note:</b></dt><dd>This object will be invalidated when the map object is updated once. </dd></dl> </div> </div> <a class="anchor" id="ab17a849095758d678dde042480550f69"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::~Sorter" ref="ab17a849095758d678dde042480550f69" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#ab17a849095758d678dde042480550f69">kyotocabinet::TinyHashMap::Sorter::~Sorter</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6a7347bedca1125145547839f805c835"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::get_key" ref="a6a7347bedca1125145547839f805c835" args="(size_t *sp)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#a6a7347bedca1125145547839f805c835">kyotocabinet::TinyHashMap::Sorter::get_key</a> </td> <td>(</td> <td class="paramtype">size_t * </td> <td class="paramname"><em>sp</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Get the key of the current record. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region of the current record, or NULL on failure. </dd></dl> </div> </div> <a class="anchor" id="accfe868d8cdd5eac2fa13c0b9af39578"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::get_value" ref="accfe868d8cdd5eac2fa13c0b9af39578" args="(size_t *sp)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#accfe868d8cdd5eac2fa13c0b9af39578">kyotocabinet::TinyHashMap::Sorter::get_value</a> </td> <td>(</td> <td class="paramtype">size_t * </td> <td class="paramname"><em>sp</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Get the value of the current record. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the value region of the current record, or NULL on failure. </dd></dl> </div> </div> <a class="anchor" id="ac29a1415a597cd1a084b3cb574064e9b"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::get" ref="ac29a1415a597cd1a084b3cb574064e9b" args="(size_t *ksp, const char **vbp, size_t *vsp)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#ac29a1415a597cd1a084b3cb574064e9b">kyotocabinet::TinyHashMap::Sorter::get</a> </td> <td>(</td> <td class="paramtype">size_t * </td> <td class="paramname"><em>ksp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char ** </td> <td class="paramname"><em>vbp</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t * </td> <td class="paramname"><em>vsp</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Get a pair of the key and the value of the current record. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">ksp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr> <tr><td class="paramname">vbp</td><td>the pointer to the variable into which the pointer to the value region is assigned. </td></tr> <tr><td class="paramname">vsp</td><td>the pointer to the variable into which the size of the value region is assigned. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region, or NULL on failure. </dd></dl> </div> </div> <a class="anchor" id="a03e37ddd7a89d6b0f4007331c79888da"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::step" ref="a03e37ddd7a89d6b0f4007331c79888da" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#a03e37ddd7a89d6b0f4007331c79888da">kyotocabinet::TinyHashMap::Sorter::step</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Step the cursor to the next record. </p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="ace5defb7872f62d58e90610613026ebf"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::map_" ref="ace5defb7872f62d58e90610613026ebf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a>* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#ace5defb7872f62d58e90610613026ebf">kyotocabinet::TinyHashMap::Sorter::map_</a></td> </tr> </table> </div> <div class="memdoc"> <p>The container. </p> </div> </div> <a class="anchor" id="af1caf6dfa1a9938f06ae458a73fa5c1b"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::ridx_" ref="af1caf6dfa1a9938f06ae458a73fa5c1b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#af1caf6dfa1a9938f06ae458a73fa5c1b">kyotocabinet::TinyHashMap::Sorter::ridx_</a></td> </tr> </table> </div> <div class="memdoc"> <p>The current record index. </p> </div> </div> <a class="anchor" id="a5ec750ceb17a2da906091df19dd5d056"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Sorter::recs_" ref="a5ec750ceb17a2da906091df19dd5d056" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std::vector<char*> <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Sorter.html#a5ec750ceb17a2da906091df19dd5d056">kyotocabinet::TinyHashMap::Sorter::recs_</a></td> </tr> </table> </div> <div class="memdoc"> <p>The current records. </p> </div> </div> </div><!-- contents --> <hr class="footer"/><address class="footer"><small> Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>