ceph/src/boost/libs/locale/doc/html/classboost_1_1locale_1_1boundary_1_1boundary__indexing.html

   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
  80 <p>This facet generates an index for boundary analysis for a given text.
  81  <a href="classboost_1_1locale_1_1boundary_1_1boundary__indexing.html#details">More...</a></p>
  82
  83 <p><code>#include &lt;<a class="el" href="facets_8hpp_source.html">boost/locale/boundary/facets.hpp</a>&gt;</code></p>
  84 <div class="dynheader">
  85 Inheritance diagram for boost::locale::boundary::boundary_indexing&lt; CharType &gt;:</div>
  86 <div class="dyncontent">
  87  <div class="center">
  88   <img src="classboost_1_1locale_1_1boundary_1_1boundary__indexing.png" usemap="#boost::locale::boundary::boundary_indexing&lt; CharType &gt;_map" alt=""/>
  89   <map id="boost::locale::boundary::boundary_indexing&lt; CharType &gt;_map" name="boost::locale::boundary::boundary_indexing&lt; CharType &gt;_map">
  90 </map>
  91  </div></div>
  92 <table class="memberdecls">
  93 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94 Public Member Functions</h2></td></tr>
  95 <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>
  96 <tr class="separator:a0e4c06efec1f1fca78bec34988aec881"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <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>
  98 <tr class="separator:ac971f4219181ee587844d2c74cca7ef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99 </table><table class="memberdecls">
 100 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
 101 Static Public Attributes</h2></td></tr>
 102 <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>
 103 <tr class="separator:aa7050fa0d55227034c80f811bc9ca97c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 </table>
 105 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 106 <div class="textblock"><h3>template&lt;typename CharType&gt;<br/>
 107 class boost::locale::boundary::boundary_indexing&lt; CharType &gt;</h3>
 108
 109 <p>This facet generates an index for boundary analysis for a given text. </p>
 110 <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>
 111 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 112 <a class="anchor" id="a0e4c06efec1f1fca78bec34988aec881"></a>
 113 <div class="memitem">
 114 <div class="memproto">
 115 <div class="memtemplate">
 116 template&lt;typename CharType &gt; </div>
 117 <table class="mlabels">
 118   <tr>
 119   <td class="mlabels-left">
 120       <table class="memname">
 121         <tr>
 122           <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>
 123           <td>(</td>
 124           <td class="paramtype">size_t&#160;</td>
 125           <td class="paramname"><em>refs</em> = <code>0</code></td><td>)</td>
 126           <td></td>
 127         </tr>
 128       </table>
 129   </td>
 130   <td class="mlabels-right">
 131 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 132   </tr>
 133 </table>
 134 </div><div class="memdoc">
 135 <p>Default constructor typical for facets </p>
 136
 137 </div>
 138 </div>
 139 <h2 class="groupheader">Member Function Documentation</h2>
 140 <a class="anchor" id="ac971f4219181ee587844d2c74cca7ef4"></a>
 141 <div class="memitem">
 142 <div class="memproto">
 143 <div class="memtemplate">
 144 template&lt;typename CharType &gt; </div>
 145 <table class="mlabels">
 146   <tr>
 147   <td class="mlabels-left">
 148       <table class="memname">
 149         <tr>
 150           <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>
 151           <td>(</td>
 152           <td class="paramtype"><a class="el" href="group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type</a>&#160;</td>
 153           <td class="paramname"><em>t</em>, </td>
 154         </tr>
 155         <tr>
 156           <td class="paramkey"></td>
 157           <td></td>
 158           <td class="paramtype">Char const *&#160;</td>
 159           <td class="paramname"><em>begin</em>, </td>
 160         </tr>
 161         <tr>
 162           <td class="paramkey"></td>
 163           <td></td>
 164           <td class="paramtype">Char const *&#160;</td>
 165           <td class="paramname"><em>end</em>&#160;</td>
 166         </tr>
 167         <tr>
 168           <td></td>
 169           <td>)</td>
 170           <td></td><td> const</td>
 171         </tr>
 172       </table>
 173   </td>
 174   <td class="mlabels-right">
 175 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 176   </tr>
 177 </table>
 178 </div><div class="memdoc">
 179 <p>Create index for boundary type <em>t</em> for text in range [begin,end)</p>
 180 <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>
 181
 182 </div>
 183 </div>
 184 <h2 class="groupheader">Member Data Documentation</h2>
 185 <a class="anchor" id="aa7050fa0d55227034c80f811bc9ca97c"></a>
 186 <div class="memitem">
 187 <div class="memproto">
 188 <div class="memtemplate">
 189 template&lt;typename CharType &gt; </div>
 190 <table class="mlabels">
 191   <tr>
 192   <td class="mlabels-left">
 193       <table class="memname">
 194         <tr>
 195           <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>
 196         </tr>
 197       </table>
 198   </td>
 199   <td class="mlabels-right">
 200 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 201   </tr>
 202 </table>
 203 </div><div class="memdoc">
 204 <p>Identification of this facet </p>
 205
 206 </div>
 207 </div>
 208 <hr/>The documentation for this class was generated from the following file:<ul>
 209 <li>boost/locale/boundary/<a class="el" href="facets_8hpp_source.html">facets.hpp</a></li>
 210 </ul>
 211 </div><!-- contents -->
 212 </div><!-- doc-content -->
 213
 214     <li class="footer">
 215 &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.
 216     </li>
 217    </ul>
 218  </div>
 219 </body>
 220 </html>