classboost_1_1locale_1_1collator.html 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>Boost.Locale: boost::locale::collator&lt; CharType &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. $(window).load(resizeHeight);
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  27. <td style="padding-left: 0.5em;">
  28. <div id="projectname">Boost.Locale
  29. </div>
  30. </td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. <!-- end header part -->
  36. <!-- Generated by Doxygen 1.8.6 -->
  37. <div id="navrow1" class="tabs">
  38. <ul class="tablist">
  39. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li><a href="examples.html"><span>Examples</span></a></li>
  46. </ul>
  47. </div>
  48. <div id="navrow2" class="tabs2">
  49. <ul class="tablist">
  50. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  51. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  53. </ul>
  54. </div>
  55. </div><!-- top -->
  56. <div id="side-nav" class="ui-resizable side-nav-resizable">
  57. <div id="nav-tree">
  58. <div id="nav-tree-contents">
  59. <div id="nav-sync" class="sync"></div>
  60. </div>
  61. </div>
  62. <div id="splitbar" style="-moz-user-select:none;"
  63. class="ui-resizable-handle">
  64. </div>
  65. </div>
  66. <script type="text/javascript">
  67. $(document).ready(function(){initNavTree('classboost_1_1locale_1_1collator.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-types">Public Types</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pro-methods">Protected Member Functions</a> &#124;
  75. <a href="classboost_1_1locale_1_1collator-members.html">List of all members</a> </div>
  76. <div class="headertitle">
  77. <div class="title">boost::locale::collator&lt; CharType &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__collation.html">Collation</a></div></div> </div>
  78. </div><!--header-->
  79. <div class="contents">
  80. <p>Collation facet.
  81. <a href="classboost_1_1locale_1_1collator.html#details">More...</a></p>
  82. <p><code>#include &lt;<a class="el" href="collator_8hpp_source.html">boost/locale/collator.hpp</a>&gt;</code></p>
  83. <div class="dynheader">
  84. Inheritance diagram for boost::locale::collator&lt; CharType &gt;:</div>
  85. <div class="dyncontent">
  86. <div class="center">
  87. <img src="classboost_1_1locale_1_1collator.png" usemap="#boost::locale::collator&lt; CharType &gt;_map" alt=""/>
  88. <map id="boost::locale::collator&lt; CharType &gt;_map" name="boost::locale::collator&lt; CharType &gt;_map">
  89. <area href="classboost_1_1locale_1_1collator__base.html" title="a base class that includes collation level flags " alt="boost::locale::collator_base" shape="rect" coords="220,0,430,24"/>
  90. </map>
  91. </div></div>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  94. Public Types</h2></td></tr>
  95. <tr class="memitem:a2b74a0b9a613a4a4337632bf34644c6f"><td class="memItemLeft" align="right" valign="top">typedef CharType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a></td></tr>
  96. <tr class="separator:a2b74a0b9a613a4a4337632bf34644c6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a106a3fe9e068530013c428661758733d"><td class="memItemLeft" align="right" valign="top">typedef std::basic_string<br class="typebreak"/>
  98. &lt; CharType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a></td></tr>
  99. <tr class="separator:a106a3fe9e068530013c428661758733d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="inherit_header pub_types_classboost_1_1locale_1_1collator__base"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classboost_1_1locale_1_1collator__base')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classboost_1_1locale_1_1collator__base.html">boost::locale::collator_base</a></td></tr>
  101. <tr class="memitem:a73c12de809733273304fef7f0af28b22 inherit pub_types_classboost_1_1locale_1_1collator__base"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> { <br/>
  102. &#160;&#160;<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22ae57e842f398a27ee490208f5af39675b">primary</a> = 0,
  103. <a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22ad8e103443d69f03f00ac4b68a7181866">secondary</a> = 1,
  104. <a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22a3a852752e9663b7b3340c435d0cfe36a">tertiary</a> = 2,
  105. <a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22a22ca1875fd63667fbb018df16b0aedba">quaternary</a> = 3,
  106. <br/>
  107. &#160;&#160;<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22a3c209055ff840e311581ab43013026f2">identical</a> = 4
  108. <br/>
  109. }</td></tr>
  110. <tr class="separator:a73c12de809733273304fef7f0af28b22 inherit pub_types_classboost_1_1locale_1_1collator__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  113. Public Member Functions</h2></td></tr>
  114. <tr class="memitem:ab90dc7bb909a71d3cd9a5e8d7b2eb80e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#ab90dc7bb909a71d3cd9a5e8d7b2eb80e">compare</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b1, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e1, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b2, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e2) const </td></tr>
  115. <tr class="separator:ab90dc7bb909a71d3cd9a5e8d7b2eb80e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a8dc6443fb193616332ca50f207a9b189"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a8dc6443fb193616332ca50f207a9b189">transform</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e) const </td></tr>
  117. <tr class="separator:a8dc6443fb193616332ca50f207a9b189"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a89752e2023643f972b6cc8024340d5d4"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a89752e2023643f972b6cc8024340d5d4">hash</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e) const </td></tr>
  119. <tr class="separator:a89752e2023643f972b6cc8024340d5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a9ccdfec693cdc5a71b5adc1f083881bf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a9ccdfec693cdc5a71b5adc1f083881bf">compare</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;l, <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;r) const </td></tr>
  121. <tr class="separator:a9ccdfec693cdc5a71b5adc1f083881bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a76000f6cf10bfe63dd7fd10652de3f5b"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a76000f6cf10bfe63dd7fd10652de3f5b">hash</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;s) const </td></tr>
  123. <tr class="separator:a76000f6cf10bfe63dd7fd10652de3f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aa9976b4fa0fba6c5d1a1dea9b5ef02ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#aa9976b4fa0fba6c5d1a1dea9b5ef02ca">transform</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;s) const </td></tr>
  125. <tr class="separator:aa9976b4fa0fba6c5d1a1dea9b5ef02ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  128. Protected Member Functions</h2></td></tr>
  129. <tr class="memitem:a25a8b21a756756e850a7488a54610053"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a25a8b21a756756e850a7488a54610053">collator</a> (size_t refs=0)</td></tr>
  130. <tr class="separator:a25a8b21a756756e850a7488a54610053"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ada3a683bed35789e081b710a8e9a9a07"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#ada3a683bed35789e081b710a8e9a9a07">do_compare</a> (<a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b1, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e1, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b2, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e2) const </td></tr>
  132. <tr class="separator:ada3a683bed35789e081b710a8e9a9a07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a84b5cb6ff01cf1a1330e1556a2c674d5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a84b5cb6ff01cf1a1330e1556a2c674d5">do_transform</a> (<a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e) const </td></tr>
  134. <tr class="separator:a84b5cb6ff01cf1a1330e1556a2c674d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aa093cd4ed0b4be4a5e38f0f04a56ac0b"><td class="memItemLeft" align="right" valign="top">virtual long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#aa093cd4ed0b4be4a5e38f0f04a56ac0b">do_hash</a> (<a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e) const </td></tr>
  136. <tr class="separator:aa093cd4ed0b4be4a5e38f0f04a56ac0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a5d04cf6c4ab84cf3eac20be402ac6bf9"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a5d04cf6c4ab84cf3eac20be402ac6bf9">do_compare</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b1, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e1, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b2, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e2) const =0</td></tr>
  138. <tr class="separator:a5d04cf6c4ab84cf3eac20be402ac6bf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a0ee27b7bc751b7a7fda4de1b0d896d57"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a0ee27b7bc751b7a7fda4de1b0d896d57">do_transform</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e) const =0</td></tr>
  140. <tr class="separator:a0ee27b7bc751b7a7fda4de1b0d896d57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a7748d5a6ef0d4dd149096b080938d4c4"><td class="memItemLeft" align="right" valign="top">virtual long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1collator.html#a7748d5a6ef0d4dd149096b080938d4c4">do_hash</a> (<a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a> level, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *b, <a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *e) const =0</td></tr>
  142. <tr class="separator:a7748d5a6ef0d4dd149096b080938d4c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table>
  144. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  145. <div class="textblock"><h3>template&lt;typename CharType&gt;<br/>
  146. class boost::locale::collator&lt; CharType &gt;</h3>
  147. <p>Collation facet. </p>
  148. <p>It reimplements standard C++ std::collate, allowing usage of std::locale for direct string comparison </p>
  149. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  150. <a class="anchor" id="a2b74a0b9a613a4a4337632bf34644c6f"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <div class="memtemplate">
  154. template&lt;typename CharType &gt; </div>
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">typedef CharType <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::<a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Type of the underlying character </p>
  162. </div>
  163. </div>
  164. <a class="anchor" id="a106a3fe9e068530013c428661758733d"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <div class="memtemplate">
  168. template&lt;typename CharType &gt; </div>
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">typedef std::basic_string&lt;CharType&gt; <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::<a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a></td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Type of string used with this facet </p>
  176. </div>
  177. </div>
  178. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  179. <a class="anchor" id="a25a8b21a756756e850a7488a54610053"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <div class="memtemplate">
  183. template&lt;typename CharType &gt; </div>
  184. <table class="mlabels">
  185. <tr>
  186. <td class="mlabels-left">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname"><a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::<a class="el" href="classboost_1_1locale_1_1collator.html">collator</a> </td>
  190. <td>(</td>
  191. <td class="paramtype">size_t&#160;</td>
  192. <td class="paramname"><em>refs</em> = <code>0</code></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>constructor of the collator object </p>
  203. </div>
  204. </div>
  205. <h2 class="groupheader">Member Function Documentation</h2>
  206. <a class="anchor" id="ab90dc7bb909a71d3cd9a5e8d7b2eb80e"></a>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <div class="memtemplate">
  210. template&lt;typename CharType &gt; </div>
  211. <table class="mlabels">
  212. <tr>
  213. <td class="mlabels-left">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">int <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::compare </td>
  217. <td>(</td>
  218. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  219. <td class="paramname"><em>level</em>, </td>
  220. </tr>
  221. <tr>
  222. <td class="paramkey"></td>
  223. <td></td>
  224. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  225. <td class="paramname"><em>b1</em>, </td>
  226. </tr>
  227. <tr>
  228. <td class="paramkey"></td>
  229. <td></td>
  230. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  231. <td class="paramname"><em>e1</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  237. <td class="paramname"><em>b2</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  243. <td class="paramname"><em>e2</em>&#160;</td>
  244. </tr>
  245. <tr>
  246. <td></td>
  247. <td>)</td>
  248. <td></td><td> const</td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Compare two strings in rage [b1,e1), [b2,e2) according using a collation level <em>level</em>. Calls do_compare</p>
  258. <p>Returns -1 if the first of the two strings sorts before the seconds, returns 1 if sorts after and 0 if they considered equal. </p>
  259. </div>
  260. </div>
  261. <a class="anchor" id="a9ccdfec693cdc5a71b5adc1f083881bf"></a>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <div class="memtemplate">
  265. template&lt;typename CharType &gt; </div>
  266. <table class="mlabels">
  267. <tr>
  268. <td class="mlabels-left">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">int <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::compare </td>
  272. <td>(</td>
  273. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  274. <td class="paramname"><em>level</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;&#160;</td>
  280. <td class="paramname"><em>l</em>, </td>
  281. </tr>
  282. <tr>
  283. <td class="paramkey"></td>
  284. <td></td>
  285. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;&#160;</td>
  286. <td class="paramname"><em>r</em>&#160;</td>
  287. </tr>
  288. <tr>
  289. <td></td>
  290. <td>)</td>
  291. <td></td><td> const</td>
  292. </tr>
  293. </table>
  294. </td>
  295. <td class="mlabels-right">
  296. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Compare two strings <em>l</em> and <em>r</em> using collation level <em>level</em> </p>
  301. <p>Returns -1 if the first of the two strings sorts before the seconds, returns 1 if sorts after and 0 if they considered equal. </p>
  302. </div>
  303. </div>
  304. <a class="anchor" id="ada3a683bed35789e081b710a8e9a9a07"></a>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <div class="memtemplate">
  308. template&lt;typename CharType &gt; </div>
  309. <table class="mlabels">
  310. <tr>
  311. <td class="mlabels-left">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">virtual int <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::do_compare </td>
  315. <td>(</td>
  316. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  317. <td class="paramname"><em>b1</em>, </td>
  318. </tr>
  319. <tr>
  320. <td class="paramkey"></td>
  321. <td></td>
  322. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  323. <td class="paramname"><em>e1</em>, </td>
  324. </tr>
  325. <tr>
  326. <td class="paramkey"></td>
  327. <td></td>
  328. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  329. <td class="paramname"><em>b2</em>, </td>
  330. </tr>
  331. <tr>
  332. <td class="paramkey"></td>
  333. <td></td>
  334. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  335. <td class="paramname"><em>e2</em>&#160;</td>
  336. </tr>
  337. <tr>
  338. <td></td>
  339. <td>)</td>
  340. <td></td><td> const</td>
  341. </tr>
  342. </table>
  343. </td>
  344. <td class="mlabels-right">
  345. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. <p>This function is used to override default collation function that does not take in account collation level. Uses primary level </p>
  350. </div>
  351. </div>
  352. <a class="anchor" id="a5d04cf6c4ab84cf3eac20be402ac6bf9"></a>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <div class="memtemplate">
  356. template&lt;typename CharType &gt; </div>
  357. <table class="mlabels">
  358. <tr>
  359. <td class="mlabels-left">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname">virtual int <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::do_compare </td>
  363. <td>(</td>
  364. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  365. <td class="paramname"><em>level</em>, </td>
  366. </tr>
  367. <tr>
  368. <td class="paramkey"></td>
  369. <td></td>
  370. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  371. <td class="paramname"><em>b1</em>, </td>
  372. </tr>
  373. <tr>
  374. <td class="paramkey"></td>
  375. <td></td>
  376. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  377. <td class="paramname"><em>e1</em>, </td>
  378. </tr>
  379. <tr>
  380. <td class="paramkey"></td>
  381. <td></td>
  382. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  383. <td class="paramname"><em>b2</em>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  389. <td class="paramname"><em>e2</em>&#160;</td>
  390. </tr>
  391. <tr>
  392. <td></td>
  393. <td>)</td>
  394. <td></td><td> const</td>
  395. </tr>
  396. </table>
  397. </td>
  398. <td class="mlabels-right">
  399. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  400. </tr>
  401. </table>
  402. </div><div class="memdoc">
  403. <p>Actual function that performs comparison between the strings. For details see compare member function. Can be overridden. </p>
  404. </div>
  405. </div>
  406. <a class="anchor" id="aa093cd4ed0b4be4a5e38f0f04a56ac0b"></a>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <div class="memtemplate">
  410. template&lt;typename CharType &gt; </div>
  411. <table class="mlabels">
  412. <tr>
  413. <td class="mlabels-left">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">virtual long <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::do_hash </td>
  417. <td>(</td>
  418. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  419. <td class="paramname"><em>b</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  425. <td class="paramname"><em>e</em>&#160;</td>
  426. </tr>
  427. <tr>
  428. <td></td>
  429. <td>)</td>
  430. <td></td><td> const</td>
  431. </tr>
  432. </table>
  433. </td>
  434. <td class="mlabels-right">
  435. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <p>This function is used to override default collation function that does not take in account collation level. Uses primary level </p>
  440. </div>
  441. </div>
  442. <a class="anchor" id="a7748d5a6ef0d4dd149096b080938d4c4"></a>
  443. <div class="memitem">
  444. <div class="memproto">
  445. <div class="memtemplate">
  446. template&lt;typename CharType &gt; </div>
  447. <table class="mlabels">
  448. <tr>
  449. <td class="mlabels-left">
  450. <table class="memname">
  451. <tr>
  452. <td class="memname">virtual long <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::do_hash </td>
  453. <td>(</td>
  454. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  455. <td class="paramname"><em>level</em>, </td>
  456. </tr>
  457. <tr>
  458. <td class="paramkey"></td>
  459. <td></td>
  460. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  461. <td class="paramname"><em>b</em>, </td>
  462. </tr>
  463. <tr>
  464. <td class="paramkey"></td>
  465. <td></td>
  466. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  467. <td class="paramname"><em>e</em>&#160;</td>
  468. </tr>
  469. <tr>
  470. <td></td>
  471. <td>)</td>
  472. <td></td><td> const</td>
  473. </tr>
  474. </table>
  475. </td>
  476. <td class="mlabels-right">
  477. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  478. </tr>
  479. </table>
  480. </div><div class="memdoc">
  481. <p>Actual function that calculates hash. For details see hash member function. Can be overridden. </p>
  482. </div>
  483. </div>
  484. <a class="anchor" id="a84b5cb6ff01cf1a1330e1556a2c674d5"></a>
  485. <div class="memitem">
  486. <div class="memproto">
  487. <div class="memtemplate">
  488. template&lt;typename CharType &gt; </div>
  489. <table class="mlabels">
  490. <tr>
  491. <td class="mlabels-left">
  492. <table class="memname">
  493. <tr>
  494. <td class="memname">virtual <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::do_transform </td>
  495. <td>(</td>
  496. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  497. <td class="paramname"><em>b</em>, </td>
  498. </tr>
  499. <tr>
  500. <td class="paramkey"></td>
  501. <td></td>
  502. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  503. <td class="paramname"><em>e</em>&#160;</td>
  504. </tr>
  505. <tr>
  506. <td></td>
  507. <td>)</td>
  508. <td></td><td> const</td>
  509. </tr>
  510. </table>
  511. </td>
  512. <td class="mlabels-right">
  513. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  514. </tr>
  515. </table>
  516. </div><div class="memdoc">
  517. <p>This function is used to override default collation function that does not take in account collation level. Uses primary level </p>
  518. </div>
  519. </div>
  520. <a class="anchor" id="a0ee27b7bc751b7a7fda4de1b0d896d57"></a>
  521. <div class="memitem">
  522. <div class="memproto">
  523. <div class="memtemplate">
  524. template&lt;typename CharType &gt; </div>
  525. <table class="mlabels">
  526. <tr>
  527. <td class="mlabels-left">
  528. <table class="memname">
  529. <tr>
  530. <td class="memname">virtual <a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::do_transform </td>
  531. <td>(</td>
  532. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  533. <td class="paramname"><em>level</em>, </td>
  534. </tr>
  535. <tr>
  536. <td class="paramkey"></td>
  537. <td></td>
  538. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  539. <td class="paramname"><em>b</em>, </td>
  540. </tr>
  541. <tr>
  542. <td class="paramkey"></td>
  543. <td></td>
  544. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  545. <td class="paramname"><em>e</em>&#160;</td>
  546. </tr>
  547. <tr>
  548. <td></td>
  549. <td>)</td>
  550. <td></td><td> const</td>
  551. </tr>
  552. </table>
  553. </td>
  554. <td class="mlabels-right">
  555. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
  556. </tr>
  557. </table>
  558. </div><div class="memdoc">
  559. <p>Actual function that performs transformation. For details see transform member function. Can be overridden. </p>
  560. </div>
  561. </div>
  562. <a class="anchor" id="a89752e2023643f972b6cc8024340d5d4"></a>
  563. <div class="memitem">
  564. <div class="memproto">
  565. <div class="memtemplate">
  566. template&lt;typename CharType &gt; </div>
  567. <table class="mlabels">
  568. <tr>
  569. <td class="mlabels-left">
  570. <table class="memname">
  571. <tr>
  572. <td class="memname">long <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::hash </td>
  573. <td>(</td>
  574. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  575. <td class="paramname"><em>level</em>, </td>
  576. </tr>
  577. <tr>
  578. <td class="paramkey"></td>
  579. <td></td>
  580. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  581. <td class="paramname"><em>b</em>, </td>
  582. </tr>
  583. <tr>
  584. <td class="paramkey"></td>
  585. <td></td>
  586. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  587. <td class="paramname"><em>e</em>&#160;</td>
  588. </tr>
  589. <tr>
  590. <td></td>
  591. <td>)</td>
  592. <td></td><td> const</td>
  593. </tr>
  594. </table>
  595. </td>
  596. <td class="mlabels-right">
  597. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  598. </tr>
  599. </table>
  600. </div><div class="memdoc">
  601. <p>Calculate a hash of a text in range [b,e). The value can be used for collation sensitive string comparison.</p>
  602. <p>If compare(level,b1,e1,b2,e2) == 0 then hash(level,b1,e1) == hash(level,b2,e2)</p>
  603. <p>Calls do_hash </p>
  604. </div>
  605. </div>
  606. <a class="anchor" id="a76000f6cf10bfe63dd7fd10652de3f5b"></a>
  607. <div class="memitem">
  608. <div class="memproto">
  609. <div class="memtemplate">
  610. template&lt;typename CharType &gt; </div>
  611. <table class="mlabels">
  612. <tr>
  613. <td class="mlabels-left">
  614. <table class="memname">
  615. <tr>
  616. <td class="memname">long <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::hash </td>
  617. <td>(</td>
  618. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  619. <td class="paramname"><em>level</em>, </td>
  620. </tr>
  621. <tr>
  622. <td class="paramkey"></td>
  623. <td></td>
  624. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;&#160;</td>
  625. <td class="paramname"><em>s</em>&#160;</td>
  626. </tr>
  627. <tr>
  628. <td></td>
  629. <td>)</td>
  630. <td></td><td> const</td>
  631. </tr>
  632. </table>
  633. </td>
  634. <td class="mlabels-right">
  635. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  636. </tr>
  637. </table>
  638. </div><div class="memdoc">
  639. <p>Calculate a hash that can be used for collation sensitive string comparison of a string <em>s</em> </p>
  640. <p>If compare(level,s1,s2) == 0 then hash(level,s1) == hash(level,s2) </p>
  641. </div>
  642. </div>
  643. <a class="anchor" id="a8dc6443fb193616332ca50f207a9b189"></a>
  644. <div class="memitem">
  645. <div class="memproto">
  646. <div class="memtemplate">
  647. template&lt;typename CharType &gt; </div>
  648. <table class="mlabels">
  649. <tr>
  650. <td class="mlabels-left">
  651. <table class="memname">
  652. <tr>
  653. <td class="memname"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::transform </td>
  654. <td>(</td>
  655. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  656. <td class="paramname"><em>level</em>, </td>
  657. </tr>
  658. <tr>
  659. <td class="paramkey"></td>
  660. <td></td>
  661. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  662. <td class="paramname"><em>b</em>, </td>
  663. </tr>
  664. <tr>
  665. <td class="paramkey"></td>
  666. <td></td>
  667. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a2b74a0b9a613a4a4337632bf34644c6f">char_type</a> const *&#160;</td>
  668. <td class="paramname"><em>e</em>&#160;</td>
  669. </tr>
  670. <tr>
  671. <td></td>
  672. <td>)</td>
  673. <td></td><td> const</td>
  674. </tr>
  675. </table>
  676. </td>
  677. <td class="mlabels-right">
  678. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  679. </tr>
  680. </table>
  681. </div><div class="memdoc">
  682. <p>Create a binary string that can be compared to other in order to get collation order. The string is created for text in range [b,e). It is useful for collation of multiple strings for text.</p>
  683. <p>The transformation follows these rules: </p>
  684. <div class="fragment"><div class="line"><a class="code" href="classboost_1_1locale_1_1collator.html#ab90dc7bb909a71d3cd9a5e8d7b2eb80e">compare</a>(level,b1,e1,b2,e2) == sign( <a class="code" href="classboost_1_1locale_1_1collator.html#a8dc6443fb193616332ca50f207a9b189">transform</a>(level,b1,e1).<a class="code" href="classboost_1_1locale_1_1collator.html#ab90dc7bb909a71d3cd9a5e8d7b2eb80e">compare</a>(<a class="code" href="classboost_1_1locale_1_1collator.html#a8dc6443fb193616332ca50f207a9b189">transform</a>(level,b2,e2)) );</div>
  685. </div><!-- fragment --><p>Calls do_transform </p>
  686. </div>
  687. </div>
  688. <a class="anchor" id="aa9976b4fa0fba6c5d1a1dea9b5ef02ca"></a>
  689. <div class="memitem">
  690. <div class="memproto">
  691. <div class="memtemplate">
  692. template&lt;typename CharType &gt; </div>
  693. <table class="mlabels">
  694. <tr>
  695. <td class="mlabels-left">
  696. <table class="memname">
  697. <tr>
  698. <td class="memname"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> <a class="el" href="classboost_1_1locale_1_1collator.html">boost::locale::collator</a>&lt; CharType &gt;::transform </td>
  699. <td>(</td>
  700. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator__base.html#a73c12de809733273304fef7f0af28b22">level_type</a>&#160;</td>
  701. <td class="paramname"><em>level</em>, </td>
  702. </tr>
  703. <tr>
  704. <td class="paramkey"></td>
  705. <td></td>
  706. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1collator.html#a106a3fe9e068530013c428661758733d">string_type</a> const &amp;&#160;</td>
  707. <td class="paramname"><em>s</em>&#160;</td>
  708. </tr>
  709. <tr>
  710. <td></td>
  711. <td>)</td>
  712. <td></td><td> const</td>
  713. </tr>
  714. </table>
  715. </td>
  716. <td class="mlabels-right">
  717. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  718. </tr>
  719. </table>
  720. </div><div class="memdoc">
  721. <p>Create a binary string from string <em>s</em>, that can be compared to other, useful for collation of multiple strings.</p>
  722. <p>The transformation follows these rules: </p>
  723. <div class="fragment"><div class="line"><a class="code" href="classboost_1_1locale_1_1collator.html#ab90dc7bb909a71d3cd9a5e8d7b2eb80e">compare</a>(level,s1,s2) == sign( <a class="code" href="classboost_1_1locale_1_1collator.html#a8dc6443fb193616332ca50f207a9b189">transform</a>(level,s1).<a class="code" href="classboost_1_1locale_1_1collator.html#ab90dc7bb909a71d3cd9a5e8d7b2eb80e">compare</a>(<a class="code" href="classboost_1_1locale_1_1collator.html#a8dc6443fb193616332ca50f207a9b189">transform</a>(level,s2)) );</div>
  724. </div><!-- fragment -->
  725. </div>
  726. </div>
  727. <hr/>The documentation for this class was generated from the following file:<ul>
  728. <li>boost/locale/<a class="el" href="collator_8hpp_source.html">collator.hpp</a></li>
  729. </ul>
  730. </div><!-- contents -->
  731. </div><!-- doc-content -->
  732. <li class="footer">
  733. &copy; Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
  734. </li>
  735. </ul>
  736. </div>
  737. </body>
  738. </html>