classboost_1_1locale_1_1boundary_1_1boundary__indexing.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  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::boundary::boundary_indexing&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_1boundary_1_1boundary__indexing.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  74. <a href="classboost_1_1locale_1_1boundary_1_1boundary__indexing-members.html">List of all members</a> </div>
  75. <div class="headertitle">
  76. <div class="title">boost::locale::boundary::boundary_indexing&lt; CharType &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__boundary.html">Boundary Analysis</a></div></div> </div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>This facet generates an index for boundary analysis for a given text.
  80. <a href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html#details">More...</a></p>
  81. <p><code>#include &lt;<a class="el" href="facets_8hpp_source.html">boost/locale/boundary/facets.hpp</a>&gt;</code></p>
  82. <div class="dynheader">
  83. Inheritance diagram for boost::locale::boundary::boundary_indexing&lt; CharType &gt;:</div>
  84. <div class="dyncontent">
  85. <div class="center">
  86. <img src="classboost_1_1locale_1_1boundary_1_1boundary__indexing.png" usemap="#boost::locale::boundary::boundary_indexing&lt; CharType &gt;_map" alt=""/>
  87. <map id="boost::locale::boundary::boundary_indexing&lt; CharType &gt;_map" name="boost::locale::boundary::boundary_indexing&lt; CharType &gt;_map">
  88. </map>
  89. </div></div>
  90. <table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  92. Public Member Functions</h2></td></tr>
  93. <tr class="memitem:a0e4c06efec1f1fca78bec34988aec881"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html#a0e4c06efec1f1fca78bec34988aec881">boundary_indexing</a> (size_t refs=0)</td></tr>
  94. <tr class="separator:a0e4c06efec1f1fca78bec34988aec881"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ac971f4219181ee587844d2c74cca7ef4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__boundary.html#ga7b4dd7af8fad53fabd77e629da24d466">index_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html#ac971f4219181ee587844d2c74cca7ef4">map</a> (<a class="el" href="group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type</a> t, Char const *begin, Char const *end) const =0</td></tr>
  96. <tr class="separator:ac971f4219181ee587844d2c74cca7ef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  99. Static Public Attributes</h2></td></tr>
  100. <tr class="memitem:aa7050fa0d55227034c80f811bc9ca97c"><td class="memItemLeft" align="right" valign="top">static std::locale::id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html#aa7050fa0d55227034c80f811bc9ca97c">id</a></td></tr>
  101. <tr class="separator:aa7050fa0d55227034c80f811bc9ca97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  104. <div class="textblock"><h3>template&lt;typename CharType&gt;<br/>
  105. class boost::locale::boundary::boundary_indexing&lt; CharType &gt;</h3>
  106. <p>This facet generates an index for boundary analysis for a given text. </p>
  107. <p>It is specialized for 4 types of characters <code>char_t</code>, <code>wchar_t</code>, <code>char16_t</code> and <code>char32_t</code> </p>
  108. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  109. <a class="anchor" id="a0e4c06efec1f1fca78bec34988aec881"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <div class="memtemplate">
  113. template&lt;typename CharType &gt; </div>
  114. <table class="mlabels">
  115. <tr>
  116. <td class="mlabels-left">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html">boost::locale::boundary::boundary_indexing</a>&lt; CharType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html">boundary_indexing</a> </td>
  120. <td>(</td>
  121. <td class="paramtype">size_t&#160;</td>
  122. <td class="paramname"><em>refs</em> = <code>0</code></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </td>
  127. <td class="mlabels-right">
  128. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>Default constructor typical for facets </p>
  133. </div>
  134. </div>
  135. <h2 class="groupheader">Member Function Documentation</h2>
  136. <a class="anchor" id="ac971f4219181ee587844d2c74cca7ef4"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <div class="memtemplate">
  140. template&lt;typename CharType &gt; </div>
  141. <table class="mlabels">
  142. <tr>
  143. <td class="mlabels-left">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">virtual <a class="el" href="group__boundary.html#ga7b4dd7af8fad53fabd77e629da24d466">index_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html">boost::locale::boundary::boundary_indexing</a>&lt; CharType &gt;::map </td>
  147. <td>(</td>
  148. <td class="paramtype"><a class="el" href="group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type</a>&#160;</td>
  149. <td class="paramname"><em>t</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">Char const *&#160;</td>
  155. <td class="paramname"><em>begin</em>, </td>
  156. </tr>
  157. <tr>
  158. <td class="paramkey"></td>
  159. <td></td>
  160. <td class="paramtype">Char const *&#160;</td>
  161. <td class="paramname"><em>end</em>&#160;</td>
  162. </tr>
  163. <tr>
  164. <td></td>
  165. <td>)</td>
  166. <td></td><td> const</td>
  167. </tr>
  168. </table>
  169. </td>
  170. <td class="mlabels-right">
  171. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Create index for boundary type <em>t</em> for text in range [begin,end)</p>
  176. <p>The returned value is an index of type <a class="el" href="group__boundary.html#ga7b4dd7af8fad53fabd77e629da24d466">index_type</a>. Note that this index is never empty, even if the range [begin,end) is empty it consists of at least one boundary point with the offset 0. </p>
  177. </div>
  178. </div>
  179. <h2 class="groupheader">Member Data Documentation</h2>
  180. <a class="anchor" id="aa7050fa0d55227034c80f811bc9ca97c"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <div class="memtemplate">
  184. template&lt;typename CharType &gt; </div>
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">std::locale::id <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html">boost::locale::boundary::boundary_indexing</a>&lt; CharType &gt;::id</td>
  191. </tr>
  192. </table>
  193. </td>
  194. <td class="mlabels-right">
  195. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Identification of this facet </p>
  200. </div>
  201. </div>
  202. <hr/>The documentation for this class was generated from the following file:<ul>
  203. <li>boost/locale/boundary/<a class="el" href="facets_8hpp_source.html">facets.hpp</a></li>
  204. </ul>
  205. </div><!-- contents -->
  206. </div><!-- doc-content -->
  207. <li class="footer">
  208. &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.
  209. </li>
  210. </ul>
  211. </div>
  212. </body>
  213. </html>