classboost_1_1locale_1_1boundary_1_1segment.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
  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::segment&lt; IteratorType &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_1segment.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="classboost_1_1locale_1_1boundary_1_1segment-members.html">List of all members</a> </div>
  75. <div class="headertitle">
  76. <div class="title">boost::locale::boundary::segment&lt; IteratorType &gt; Class Template Reference<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>a segment object that represents a pair of two iterators that define the range where this segment exits and a rule that defines it.
  80. <a href="classboost_1_1locale_1_1boundary_1_1segment.html#details">More...</a></p>
  81. <p><code>#include &lt;<a class="el" href="segment_8hpp_source.html">boost/locale/boundary/segment.hpp</a>&gt;</code></p>
  82. <div class="dynheader">
  83. Inheritance diagram for boost::locale::boundary::segment&lt; IteratorType &gt;:</div>
  84. <div class="dyncontent">
  85. <div class="center">
  86. <img src="classboost_1_1locale_1_1boundary_1_1segment.png" usemap="#boost::locale::boundary::segment&lt; IteratorType &gt;_map" alt=""/>
  87. <map id="boost::locale::boundary::segment&lt; IteratorType &gt;_map" name="boost::locale::boundary::segment&lt; IteratorType &gt;_map">
  88. </map>
  89. </div></div>
  90. <table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  92. Public Types</h2></td></tr>
  93. <tr class="memitem:ad3785355ea817c087bf428315a332169"><td class="memItemLeft" align="right" valign="top">typedef std::iterator_traits<br class="typebreak"/>
  94. &lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ab7ba55015262b4fb85bb531882a32ead">value_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a></td></tr>
  95. <tr class="separator:ad3785355ea817c087bf428315a332169"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a795d3328ac4d1692294f172c8480da47"><td class="memItemLeft" align="right" valign="top">typedef std::basic_string<br class="typebreak"/>
  97. &lt; <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a795d3328ac4d1692294f172c8480da47">string_type</a></td></tr>
  98. <tr class="separator:a795d3328ac4d1692294f172c8480da47"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ab7ba55015262b4fb85bb531882a32ead"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ab7ba55015262b4fb85bb531882a32ead">value_type</a></td></tr>
  100. <tr class="separator:ab7ba55015262b4fb85bb531882a32ead"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a31960fd7b416715d012b686bc1f2c205"><td class="memItemLeft" align="right" valign="top">typedef IteratorType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a></td></tr>
  102. <tr class="separator:a31960fd7b416715d012b686bc1f2c205"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:aa24dcd83aefe4925bfc11b0285e2517a"><td class="memItemLeft" align="right" valign="top">typedef IteratorType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#aa24dcd83aefe4925bfc11b0285e2517a">const_iterator</a></td></tr>
  104. <tr class="separator:aa24dcd83aefe4925bfc11b0285e2517a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a79ee4d48248ffbc23f84a33355ca3b62"><td class="memItemLeft" align="right" valign="top">typedef std::iterator_traits<br class="typebreak"/>
  106. &lt; IteratorType &gt;<br class="typebreak"/>
  107. ::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a79ee4d48248ffbc23f84a33355ca3b62">difference_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a79ee4d48248ffbc23f84a33355ca3b62">difference_type</a></td></tr>
  108. <tr class="separator:a79ee4d48248ffbc23f84a33355ca3b62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  111. Public Member Functions</h2></td></tr>
  112. <tr class="memitem:a4e785bc97dba9e8e25f18b43957723e5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a4e785bc97dba9e8e25f18b43957723e5">segment</a> ()</td></tr>
  113. <tr class="separator:a4e785bc97dba9e8e25f18b43957723e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:aea72505bb4940b21bb00a3660fefb7b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#aea72505bb4940b21bb00a3660fefb7b7">segment</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a> b, <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a> e, <a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> r)</td></tr>
  115. <tr class="separator:aea72505bb4940b21bb00a3660fefb7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a5428ff79bc05b78989f56519b58a6d9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a5428ff79bc05b78989f56519b58a6d9c">begin</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a> const &amp;v)</td></tr>
  117. <tr class="separator:a5428ff79bc05b78989f56519b58a6d9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:aaedd7bb4760bae3dcdb165b330806261"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#aaedd7bb4760bae3dcdb165b330806261">end</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a> const &amp;v)</td></tr>
  119. <tr class="separator:aaedd7bb4760bae3dcdb165b330806261"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a445da30d993880a1bd6d998e78755a44"><td class="memItemLeft" align="right" valign="top">IteratorType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a445da30d993880a1bd6d998e78755a44">begin</a> () const </td></tr>
  121. <tr class="separator:a445da30d993880a1bd6d998e78755a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a7e36b7f1c88ad1f5756ba6e501454bc4"><td class="memItemLeft" align="right" valign="top">IteratorType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a7e36b7f1c88ad1f5756ba6e501454bc4">end</a> () const </td></tr>
  123. <tr class="separator:a7e36b7f1c88ad1f5756ba6e501454bc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a5230094b346bd26dc83529b47ca97153"><td class="memTemplParams" colspan="2">template&lt;class T , class A &gt; </td></tr>
  125. <tr class="memitem:a5230094b346bd26dc83529b47ca97153"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a5230094b346bd26dc83529b47ca97153">operator std::basic_string&lt; char_type, T, A &gt;</a> () const </td></tr>
  126. <tr class="separator:a5230094b346bd26dc83529b47ca97153"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ac139eae8c07ed82ba8343fedfa76c2bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a795d3328ac4d1692294f172c8480da47">string_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ac139eae8c07ed82ba8343fedfa76c2bf">str</a> () const </td></tr>
  128. <tr class="separator:ac139eae8c07ed82ba8343fedfa76c2bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a45edfde079b2afe36c55043c7a00b438"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a45edfde079b2afe36c55043c7a00b438">length</a> () const </td></tr>
  130. <tr class="separator:a45edfde079b2afe36c55043c7a00b438"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a84022afa120893d0716fc446816eb83f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a84022afa120893d0716fc446816eb83f">empty</a> () const </td></tr>
  132. <tr class="separator:a84022afa120893d0716fc446816eb83f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a5b36a522d7013306617dbcccc9919343"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a5b36a522d7013306617dbcccc9919343">rule</a> () const </td></tr>
  134. <tr class="separator:a5b36a522d7013306617dbcccc9919343"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a962c26b7e2024767ad25f2be080fd53a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a962c26b7e2024767ad25f2be080fd53a">rule</a> (<a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> r)</td></tr>
  136. <tr class="separator:a962c26b7e2024767ad25f2be080fd53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a9a30e70d41591b25c8c77961bff00057"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a30e70d41591b25c8c77961bff00057"></a>
  138. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a9a30e70d41591b25c8c77961bff00057">operator==</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">segment</a> const &amp;other)</td></tr>
  139. <tr class="memdesc:a9a30e70d41591b25c8c77961bff00057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare two segments. <br/></td></tr>
  140. <tr class="separator:a9a30e70d41591b25c8c77961bff00057"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a2e38c575af16843a3aa140a4332646a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e38c575af16843a3aa140a4332646a3"></a>
  142. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a2e38c575af16843a3aa140a4332646a3">operator!=</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">segment</a> const &amp;other)</td></tr>
  143. <tr class="memdesc:a2e38c575af16843a3aa140a4332646a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compare two segments. <br/></td></tr>
  144. <tr class="separator:a2e38c575af16843a3aa140a4332646a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. </table>
  146. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  147. <div class="textblock"><h3>template&lt;typename IteratorType&gt;<br/>
  148. class boost::locale::boundary::segment&lt; IteratorType &gt;</h3>
  149. <p>a segment object that represents a pair of two iterators that define the range where this segment exits and a rule that defines it. </p>
  150. <p>This type of object is dereferenced by the iterators of <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment__index.html" title="This class holds an index of segments in the text range and allows to iterate over them...">segment_index</a>. Using a <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a5b36a522d7013306617dbcccc9919343">rule()</a> member function you can get a specific rule this segment was selected with. For example, when you use word boundary analysis, you can check if the specific word contains Kana letters by checking (<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a5b36a522d7013306617dbcccc9919343">rule()</a> &amp; <a class="el" href="group__boundary.html#ga52d8c63e1f3f8c898c645352206a78ef">word_kana</a>)!=0 For a sentence analysis you can check if the sentence is selected because a sentence terminator is found (<a class="el" href="group__boundary.html#ga3befefe67f79691c117bf5588741355b">sentence_term</a>) or there is a line break (<a class="el" href="group__boundary.html#gaf67883341dd3d8f786e7281d40790000">sentence_sep</a>).</p>
  151. <p>This object can be automatically converted to std::basic_string with the same type of character. It is also valid range that has <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a5428ff79bc05b78989f56519b58a6d9c">begin()</a> and <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#aaedd7bb4760bae3dcdb165b330806261">end()</a> member functions returning iterators on the location of the segment.</p>
  152. <dl class="section see"><dt>See Also</dt><dd></dd></dl>
  153. <ul>
  154. <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment__index.html">segment_index</a></li>
  155. <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a></li>
  156. <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point__index.html">boundary_point_index</a> </li>
  157. </ul>
  158. </div><h2 class="groupheader">Member Typedef Documentation</h2>
  159. <a class="anchor" id="ad3785355ea817c087bf428315a332169"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <div class="memtemplate">
  163. template&lt;typename IteratorType&gt; </div>
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">typedef std::iterator_traits&lt;IteratorType&gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ab7ba55015262b4fb85bb531882a32ead">value_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a></td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p>The type of the underlying character </p>
  171. </div>
  172. </div>
  173. <a class="anchor" id="aa24dcd83aefe4925bfc11b0285e2517a"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <div class="memtemplate">
  177. template&lt;typename IteratorType&gt; </div>
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">typedef IteratorType <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#aa24dcd83aefe4925bfc11b0285e2517a">const_iterator</a></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>The iterator that allows to iterate the range </p>
  185. </div>
  186. </div>
  187. <a class="anchor" id="a79ee4d48248ffbc23f84a33355ca3b62"></a>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <div class="memtemplate">
  191. template&lt;typename IteratorType&gt; </div>
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">typedef std::iterator_traits&lt;IteratorType&gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a79ee4d48248ffbc23f84a33355ca3b62">difference_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a79ee4d48248ffbc23f84a33355ca3b62">difference_type</a></td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. <p>The type that represent a difference between two iterators </p>
  199. </div>
  200. </div>
  201. <a class="anchor" id="a31960fd7b416715d012b686bc1f2c205"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <div class="memtemplate">
  205. template&lt;typename IteratorType&gt; </div>
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">typedef IteratorType <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>The iterator that allows to iterate the range </p>
  213. </div>
  214. </div>
  215. <a class="anchor" id="a795d3328ac4d1692294f172c8480da47"></a>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <div class="memtemplate">
  219. template&lt;typename IteratorType&gt; </div>
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">typedef std::basic_string&lt;<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a>&gt; <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a795d3328ac4d1692294f172c8480da47">string_type</a></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>The type of the string it is converted to </p>
  227. </div>
  228. </div>
  229. <a class="anchor" id="ab7ba55015262b4fb85bb531882a32ead"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <div class="memtemplate">
  233. template&lt;typename IteratorType&gt; </div>
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">typedef <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ab7ba55015262b4fb85bb531882a32ead">value_type</a></td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>The value that iterators return - the character itself </p>
  241. </div>
  242. </div>
  243. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  244. <a class="anchor" id="a4e785bc97dba9e8e25f18b43957723e5"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <div class="memtemplate">
  248. template&lt;typename IteratorType&gt; </div>
  249. <table class="mlabels">
  250. <tr>
  251. <td class="mlabels-left">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">segment</a> </td>
  255. <td>(</td>
  256. <td class="paramname"></td><td>)</td>
  257. <td></td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Default constructor </p>
  267. </div>
  268. </div>
  269. <a class="anchor" id="aea72505bb4940b21bb00a3660fefb7b7"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <div class="memtemplate">
  273. template&lt;typename IteratorType&gt; </div>
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::<a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">segment</a> </td>
  280. <td>(</td>
  281. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a>&#160;</td>
  282. <td class="paramname"><em>b</em>, </td>
  283. </tr>
  284. <tr>
  285. <td class="paramkey"></td>
  286. <td></td>
  287. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a>&#160;</td>
  288. <td class="paramname"><em>e</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a>&#160;</td>
  294. <td class="paramname"><em>r</em>&#160;</td>
  295. </tr>
  296. <tr>
  297. <td></td>
  298. <td>)</td>
  299. <td></td><td></td>
  300. </tr>
  301. </table>
  302. </td>
  303. <td class="mlabels-right">
  304. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  305. </tr>
  306. </table>
  307. </div><div class="memdoc">
  308. <p>Create a segment using two iterators and a rule that represents this point </p>
  309. </div>
  310. </div>
  311. <h2 class="groupheader">Member Function Documentation</h2>
  312. <a class="anchor" id="a5428ff79bc05b78989f56519b58a6d9c"></a>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <div class="memtemplate">
  316. template&lt;typename IteratorType&gt; </div>
  317. <table class="mlabels">
  318. <tr>
  319. <td class="mlabels-left">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">void <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::begin </td>
  323. <td>(</td>
  324. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a> const &amp;&#160;</td>
  325. <td class="paramname"><em>v</em></td><td>)</td>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </td>
  330. <td class="mlabels-right">
  331. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  332. </tr>
  333. </table>
  334. </div><div class="memdoc">
  335. <p>Set the start of the range </p>
  336. </div>
  337. </div>
  338. <a class="anchor" id="a445da30d993880a1bd6d998e78755a44"></a>
  339. <div class="memitem">
  340. <div class="memproto">
  341. <div class="memtemplate">
  342. template&lt;typename IteratorType&gt; </div>
  343. <table class="mlabels">
  344. <tr>
  345. <td class="mlabels-left">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">IteratorType <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::begin </td>
  349. <td>(</td>
  350. <td class="paramname"></td><td>)</td>
  351. <td> const</td>
  352. </tr>
  353. </table>
  354. </td>
  355. <td class="mlabels-right">
  356. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  357. </tr>
  358. </table>
  359. </div><div class="memdoc">
  360. <p>Get the start of the range </p>
  361. </div>
  362. </div>
  363. <a class="anchor" id="a84022afa120893d0716fc446816eb83f"></a>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <div class="memtemplate">
  367. template&lt;typename IteratorType&gt; </div>
  368. <table class="mlabels">
  369. <tr>
  370. <td class="mlabels-left">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">bool <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::empty </td>
  374. <td>(</td>
  375. <td class="paramname"></td><td>)</td>
  376. <td> const</td>
  377. </tr>
  378. </table>
  379. </td>
  380. <td class="mlabels-right">
  381. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Check if the segment is empty </p>
  386. </div>
  387. </div>
  388. <a class="anchor" id="aaedd7bb4760bae3dcdb165b330806261"></a>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <div class="memtemplate">
  392. template&lt;typename IteratorType&gt; </div>
  393. <table class="mlabels">
  394. <tr>
  395. <td class="mlabels-left">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">void <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::end </td>
  399. <td>(</td>
  400. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a31960fd7b416715d012b686bc1f2c205">iterator</a> const &amp;&#160;</td>
  401. <td class="paramname"><em>v</em></td><td>)</td>
  402. <td></td>
  403. </tr>
  404. </table>
  405. </td>
  406. <td class="mlabels-right">
  407. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  408. </tr>
  409. </table>
  410. </div><div class="memdoc">
  411. <p>Set the end of the range </p>
  412. </div>
  413. </div>
  414. <a class="anchor" id="a7e36b7f1c88ad1f5756ba6e501454bc4"></a>
  415. <div class="memitem">
  416. <div class="memproto">
  417. <div class="memtemplate">
  418. template&lt;typename IteratorType&gt; </div>
  419. <table class="mlabels">
  420. <tr>
  421. <td class="mlabels-left">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">IteratorType <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::end </td>
  425. <td>(</td>
  426. <td class="paramname"></td><td>)</td>
  427. <td> const</td>
  428. </tr>
  429. </table>
  430. </td>
  431. <td class="mlabels-right">
  432. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <p>Set the end of the range </p>
  437. </div>
  438. </div>
  439. <a class="anchor" id="a45edfde079b2afe36c55043c7a00b438"></a>
  440. <div class="memitem">
  441. <div class="memproto">
  442. <div class="memtemplate">
  443. template&lt;typename IteratorType&gt; </div>
  444. <table class="mlabels">
  445. <tr>
  446. <td class="mlabels-left">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">size_t <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::length </td>
  450. <td>(</td>
  451. <td class="paramname"></td><td>)</td>
  452. <td> const</td>
  453. </tr>
  454. </table>
  455. </td>
  456. <td class="mlabels-right">
  457. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Get the length of the text chunk </p>
  462. </div>
  463. </div>
  464. <a class="anchor" id="a5230094b346bd26dc83529b47ca97153"></a>
  465. <div class="memitem">
  466. <div class="memproto">
  467. <div class="memtemplate">
  468. template&lt;typename IteratorType&gt; </div>
  469. <div class="memtemplate">
  470. template&lt;class T , class A &gt; </div>
  471. <table class="mlabels">
  472. <tr>
  473. <td class="mlabels-left">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::operator std::basic_string&lt; <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#ad3785355ea817c087bf428315a332169">char_type</a>, T, A &gt; </td>
  477. <td>(</td>
  478. <td class="paramname"></td><td>)</td>
  479. <td> const</td>
  480. </tr>
  481. </table>
  482. </td>
  483. <td class="mlabels-right">
  484. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  485. </tr>
  486. </table>
  487. </div><div class="memdoc">
  488. <p>Convert the range to a string automatically </p>
  489. </div>
  490. </div>
  491. <a class="anchor" id="a5b36a522d7013306617dbcccc9919343"></a>
  492. <div class="memitem">
  493. <div class="memproto">
  494. <div class="memtemplate">
  495. template&lt;typename IteratorType&gt; </div>
  496. <table class="mlabels">
  497. <tr>
  498. <td class="mlabels-left">
  499. <table class="memname">
  500. <tr>
  501. <td class="memname"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::rule </td>
  502. <td>(</td>
  503. <td class="paramname"></td><td>)</td>
  504. <td> const</td>
  505. </tr>
  506. </table>
  507. </td>
  508. <td class="mlabels-right">
  509. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  510. </tr>
  511. </table>
  512. </div><div class="memdoc">
  513. <p>Get the rule that is used for selection of this segment. </p>
  514. </div>
  515. </div>
  516. <a class="anchor" id="a962c26b7e2024767ad25f2be080fd53a"></a>
  517. <div class="memitem">
  518. <div class="memproto">
  519. <div class="memtemplate">
  520. template&lt;typename IteratorType&gt; </div>
  521. <table class="mlabels">
  522. <tr>
  523. <td class="mlabels-left">
  524. <table class="memname">
  525. <tr>
  526. <td class="memname">void <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::rule </td>
  527. <td>(</td>
  528. <td class="paramtype"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a>&#160;</td>
  529. <td class="paramname"><em>r</em></td><td>)</td>
  530. <td></td>
  531. </tr>
  532. </table>
  533. </td>
  534. <td class="mlabels-right">
  535. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  536. </tr>
  537. </table>
  538. </div><div class="memdoc">
  539. <p>Set a rule that is used for segment selection </p>
  540. </div>
  541. </div>
  542. <a class="anchor" id="ac139eae8c07ed82ba8343fedfa76c2bf"></a>
  543. <div class="memitem">
  544. <div class="memproto">
  545. <div class="memtemplate">
  546. template&lt;typename IteratorType&gt; </div>
  547. <table class="mlabels">
  548. <tr>
  549. <td class="mlabels-left">
  550. <table class="memname">
  551. <tr>
  552. <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html#a795d3328ac4d1692294f172c8480da47">string_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">boost::locale::boundary::segment</a>&lt; IteratorType &gt;::str </td>
  553. <td>(</td>
  554. <td class="paramname"></td><td>)</td>
  555. <td> const</td>
  556. </tr>
  557. </table>
  558. </td>
  559. <td class="mlabels-right">
  560. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. <p>Create a string from the range explicitly </p>
  565. </div>
  566. </div>
  567. <hr/>The documentation for this class was generated from the following file:<ul>
  568. <li>boost/locale/boundary/<a class="el" href="segment_8hpp_source.html">segment.hpp</a></li>
  569. </ul>
  570. </div><!-- contents -->
  571. </div><!-- doc-content -->
  572. <li class="footer">
  573. &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.
  574. </li>
  575. </ul>
  576. </div>
  577. </body>
  578. </html>