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">
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_point_index
< BaseIterator
> 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);
18 <link href=
"doxygen.css" rel=
"stylesheet" type=
"text/css" />
21 <div id=
"top"><!-- do not remove this div, it is closed by doxygen! -->
23 <table cellspacing=
"0" cellpadding=
"0">
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
35 <!-- end header part -->
36 <!-- Generated by Doxygen 1.8.6 -->
37 <div id=
"navrow1" class=
"tabs">
39 <li><a href=
"index.html"><span>Main
 Page
</span></a></li>
40 <li><a href=
"pages.html"><span>Related
 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>
48 <div id=
"navrow2" class=
"tabs2">
50 <li><a href=
"annotated.html"><span>Class
 List
</span></a></li>
51 <li><a href=
"hierarchy.html"><span>Class
 Hierarchy
</span></a></li>
52 <li><a href=
"functions.html"><span>Class
 Members
</span></a></li>
56 <div id=
"side-nav" class=
"ui-resizable side-nav-resizable">
58 <div id=
"nav-tree-contents">
59 <div id=
"nav-sync" class=
"sync"></div>
62 <div id=
"splitbar" style=
"-moz-user-select:none;"
63 class=
"ui-resizable-handle">
66 <script type=
"text/javascript">
67 $(document).ready(function(){initNavTree('classboost_1_1locale_1_1boundary_1_1boundary__point__index.html','');});
69 <div id=
"doc-content">
72 <a href=
"#pub-types">Public Types
</a> |
73 <a href=
"#pub-methods">Public Member Functions
</a> |
74 <a href=
"#friends">Friends
</a> |
75 <a href=
"classboost_1_1locale_1_1boundary_1_1boundary__point__index-members.html">List of all members
</a> </div>
76 <div class=
"headertitle">
77 <div class=
"title">boost::locale::boundary::boundary_point_index
< BaseIterator
> Class Template Reference
<div class=
"ingroups"><a class=
"el" href=
"group__boundary.html">Boundary Analysis
</a></div></div> </div>
79 <div class=
"contents">
81 <p>This class holds an index of
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary points
</a> and allows iterating over them.
82 <a href=
"classboost_1_1locale_1_1boundary_1_1boundary__point__index.html#details">More...
</a></p>
84 <p><code>#include
<<a class=
"el" href=
"index_8hpp_source.html">boost/locale/boundary/index.hpp
</a>></code></p>
85 <table class=
"memberdecls">
86 <tr class=
"heading"><td colspan=
"2"><h2 class=
"groupheader"><a name=
"pub-types"></a>
87 Public Types
</h2></td></tr>
88 <tr class=
"memitem:gab3189e2eaf4386cdf37598e0ba16cfd5"><td class=
"memItemLeft" align=
"right" valign=
"top">typedef BaseIterator
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a></td></tr>
89 <tr class=
"separator:gab3189e2eaf4386cdf37598e0ba16cfd5"><td class=
"memSeparator" colspan=
"2"> </td></tr>
90 <tr class=
"memitem:ga1af6e72b3c384edcebc0cf319fe97efe"><td class=
"memItemLeft" align=
"right" valign=
"top">typedef unspecified_iterator_type
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga1af6e72b3c384edcebc0cf319fe97efe">iterator
</a></td></tr>
91 <tr class=
"separator:ga1af6e72b3c384edcebc0cf319fe97efe"><td class=
"memSeparator" colspan=
"2"> </td></tr>
92 <tr class=
"memitem:gac9ce9158eb2fb030c1baf93376203d16"><td class=
"memItemLeft" align=
"right" valign=
"top">typedef unspecified_iterator_type
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#gac9ce9158eb2fb030c1baf93376203d16">const_iterator
</a></td></tr>
93 <tr class=
"separator:gac9ce9158eb2fb030c1baf93376203d16"><td class=
"memSeparator" colspan=
"2"> </td></tr>
94 <tr class=
"memitem:ga7f7328a860cf485a4bd8f17658c291e1"><td class=
"memItemLeft" align=
"right" valign=
"top">typedef
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point
</a><br class=
"typebreak"/>
95 < <a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> > </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga7f7328a860cf485a4bd8f17658c291e1">value_type
</a></td></tr>
96 <tr class=
"separator:ga7f7328a860cf485a4bd8f17658c291e1"><td class=
"memSeparator" colspan=
"2"> </td></tr>
97 </table><table class=
"memberdecls">
98 <tr class=
"heading"><td colspan=
"2"><h2 class=
"groupheader"><a name=
"pub-methods"></a>
99 Public Member Functions
</h2></td></tr>
100 <tr class=
"memitem:gaba6993dd50ad8cf2db8921e5cf668a69"><td class=
"memItemLeft" align=
"right" valign=
"top"> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#gaba6993dd50ad8cf2db8921e5cf668a69">boundary_point_index
</a> ()
</td></tr>
101 <tr class=
"separator:gaba6993dd50ad8cf2db8921e5cf668a69"><td class=
"memSeparator" colspan=
"2"> </td></tr>
102 <tr class=
"memitem:gacc189288792012cfdb21c07fddbadc4f"><td class=
"memItemLeft" align=
"right" valign=
"top"> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#gacc189288792012cfdb21c07fddbadc4f">boundary_point_index
</a> (
<a class=
"el" href=
"group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type
</a> type,
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> <a class=
"el" href=
"group__boundary.html#ga56f42a32f0378b6e157671f9e17bd66f">begin
</a>,
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> <a class=
"el" href=
"group__boundary.html#gaf3d66d578e32a63b3f0ffbb59740667b">end
</a>,
<a class=
"el" href=
"group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type
</a> mask, std::locale const
&loc=std::locale())
</td></tr>
103 <tr class=
"separator:gacc189288792012cfdb21c07fddbadc4f"><td class=
"memSeparator" colspan=
"2"> </td></tr>
104 <tr class=
"memitem:ga9b926379fa2fcc7f87dc067953049d69"><td class=
"memItemLeft" align=
"right" valign=
"top"> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga9b926379fa2fcc7f87dc067953049d69">boundary_point_index
</a> (
<a class=
"el" href=
"group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type
</a> type,
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> <a class=
"el" href=
"group__boundary.html#ga56f42a32f0378b6e157671f9e17bd66f">begin
</a>,
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> <a class=
"el" href=
"group__boundary.html#gaf3d66d578e32a63b3f0ffbb59740667b">end
</a>, std::locale const
&loc=std::locale())
</td></tr>
105 <tr class=
"separator:ga9b926379fa2fcc7f87dc067953049d69"><td class=
"memSeparator" colspan=
"2"> </td></tr>
106 <tr class=
"memitem:gac48665ff53789c6ee44a423963b6550d"><td class=
"memItemLeft" align=
"right" valign=
"top"> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#gac48665ff53789c6ee44a423963b6550d">boundary_point_index
</a> (
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1segment__index.html">segment_index
</a>< <a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> > const
&other)
</td></tr>
107 <tr class=
"separator:gac48665ff53789c6ee44a423963b6550d"><td class=
"memSeparator" colspan=
"2"> </td></tr>
108 <tr class=
"memitem:ga83d57b993b00686b2cac711667c6a931"><td class=
"memItemLeft" align=
"right" valign=
"top"><a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point__index.html">boundary_point_index
</a> const
& </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga83d57b993b00686b2cac711667c6a931">operator=
</a> (
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1segment__index.html">segment_index
</a>< <a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> > const
&other)
</td></tr>
109 <tr class=
"separator:ga83d57b993b00686b2cac711667c6a931"><td class=
"memSeparator" colspan=
"2"> </td></tr>
110 <tr class=
"memitem:ga6b4b5d5cf80b55302a88e7b36c812418"><td class=
"memItemLeft" align=
"right" valign=
"top">void
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga6b4b5d5cf80b55302a88e7b36c812418">map
</a> (
<a class=
"el" href=
"group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type
</a> type,
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> <a class=
"el" href=
"group__boundary.html#ga56f42a32f0378b6e157671f9e17bd66f">begin
</a>,
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> <a class=
"el" href=
"group__boundary.html#gaf3d66d578e32a63b3f0ffbb59740667b">end
</a>, std::locale const
&loc=std::locale())
</td></tr>
111 <tr class=
"separator:ga6b4b5d5cf80b55302a88e7b36c812418"><td class=
"memSeparator" colspan=
"2"> </td></tr>
112 <tr class=
"memitem:ga56f42a32f0378b6e157671f9e17bd66f"><td class=
"memItemLeft" align=
"right" valign=
"top"><a class=
"el" href=
"group__boundary.html#ga1af6e72b3c384edcebc0cf319fe97efe">iterator
</a> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga56f42a32f0378b6e157671f9e17bd66f">begin
</a> () const
</td></tr>
113 <tr class=
"separator:ga56f42a32f0378b6e157671f9e17bd66f"><td class=
"memSeparator" colspan=
"2"> </td></tr>
114 <tr class=
"memitem:gaf3d66d578e32a63b3f0ffbb59740667b"><td class=
"memItemLeft" align=
"right" valign=
"top"><a class=
"el" href=
"group__boundary.html#ga1af6e72b3c384edcebc0cf319fe97efe">iterator
</a> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#gaf3d66d578e32a63b3f0ffbb59740667b">end
</a> () const
</td></tr>
115 <tr class=
"separator:gaf3d66d578e32a63b3f0ffbb59740667b"><td class=
"memSeparator" colspan=
"2"> </td></tr>
116 <tr class=
"memitem:ga0bb71a287afca990e85b17246568492d"><td class=
"memItemLeft" align=
"right" valign=
"top"><a class=
"el" href=
"group__boundary.html#ga1af6e72b3c384edcebc0cf319fe97efe">iterator
</a> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga0bb71a287afca990e85b17246568492d">find
</a> (
<a class=
"el" href=
"group__boundary.html#gab3189e2eaf4386cdf37598e0ba16cfd5">base_iterator
</a> p) const
</td></tr>
117 <tr class=
"separator:ga0bb71a287afca990e85b17246568492d"><td class=
"memSeparator" colspan=
"2"> </td></tr>
118 <tr class=
"memitem:ga1d214029f1a780b7bf6e3f23a3004c03"><td class=
"memItemLeft" align=
"right" valign=
"top"><a class=
"el" href=
"group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type
</a> </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga1d214029f1a780b7bf6e3f23a3004c03">rule
</a> () const
</td></tr>
119 <tr class=
"separator:ga1d214029f1a780b7bf6e3f23a3004c03"><td class=
"memSeparator" colspan=
"2"> </td></tr>
120 <tr class=
"memitem:ga56e63913f51109e05a24a7136472a975"><td class=
"memItemLeft" align=
"right" valign=
"top">void
 </td><td class=
"memItemRight" valign=
"bottom"><a class=
"el" href=
"group__boundary.html#ga56e63913f51109e05a24a7136472a975">rule
</a> (
<a class=
"el" href=
"group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type
</a> v)
</td></tr>
121 <tr class=
"separator:ga56e63913f51109e05a24a7136472a975"><td class=
"memSeparator" colspan=
"2"> </td></tr>
122 </table><table class=
"memberdecls">
123 <tr class=
"heading"><td colspan=
"2"><h2 class=
"groupheader"><a name=
"friends"></a>
124 Friends
</h2></td></tr>
125 <tr class=
"memitem:gaa8ba2e18ec3780af8f001ba85e40b9e2"><td class=
"memItemLeft" align=
"right" valign=
"top"><a class=
"anchor" id=
"gaa8ba2e18ec3780af8f001ba85e40b9e2"></a>
126 class
 </td><td class=
"memItemRight" valign=
"bottom"><b>segment_index
< base_iterator
></b></td></tr>
127 <tr class=
"separator:gaa8ba2e18ec3780af8f001ba85e40b9e2"><td class=
"memSeparator" colspan=
"2"> </td></tr>
129 <a name=
"details" id=
"details"></a><h2 class=
"groupheader">Detailed Description
</h2>
130 <div class=
"textblock"><h3>template
<typename BaseIterator
><br/>
131 class boost::locale::boundary::boundary_point_index
< BaseIterator
></h3>
133 <p>This class holds an index of
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary points
</a> and allows iterating over them.
</p>
134 <p>This class is provides
<a class=
"el" href=
"group__boundary.html#ga56f42a32f0378b6e157671f9e17bd66f">begin()
</a> and
<a class=
"el" href=
"group__boundary.html#gaf3d66d578e32a63b3f0ffbb59740667b">end()
</a> member functions that return bidirectional iterators to the
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point
</a> objects.
</p>
135 <p>It provides an option that affects selecting boundary points according to different rules: using
<a class=
"el" href=
"group__boundary.html#ga56e63913f51109e05a24a7136472a975">rule(rule_type mask)
</a> member function. It allows to set a mask that select only specific types of boundary points like
<a class=
"el" href=
"group__boundary.html#ga3befefe67f79691c117bf5588741355b">sentence_term
</a>.
</p>
136 <p>For example for a sentence boundary analysis of a text
"Hello! How\nare you?" when the default rule is used the boundary points would be:
</p>
138 <li>"|Hello! How\nare you?"</li>
139 <li>"Hello! |How\nare you?"</li>
140 <li>"Hello! How\n|are you?"</li>
141 <li>"Hello! How\nare you?|"</li>
143 <p>However if
<a class=
"el" href=
"group__boundary.html#ga1d214029f1a780b7bf6e3f23a3004c03">rule()
</a> is set to
<a class=
"el" href=
"group__boundary.html#ga3befefe67f79691c117bf5588741355b">sentence_term
</a> then the selected boundary points would be:
</p>
145 <li>"|Hello! How\nare you?"</li>
146 <li>"Hello! |How\nare you?"</li>
147 <li>"Hello! How\nare you?|"</li>
149 <p>Such that a boundary point defined by a line feed character would be ignored.
</p>
150 <p>This class allows to find a
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point.html" title=
"This class represents a boundary point in the text. ">boundary_point
</a> according to the given iterator in range using
<a class=
"el" href=
"group__boundary.html#ga0bb71a287afca990e85b17246568492d">find()
</a> member function.
</p>
151 <dl class=
"section note"><dt>Note
</dt><dd><ul>
152 <li>Even an empty text range [x,x) considered to have a one boundary point x.
</li>
153 <li><em>a
</em> and
<em>b
</em> points of the range [a,b) are always considered boundary points regardless the rules used.
</li>
154 <li>Changing any of the option
<a class=
"el" href=
"group__boundary.html#ga1d214029f1a780b7bf6e3f23a3004c03">rule()
</a> or course re-indexing the text invalidates existing iterators and they can't be used any more.
</li>
155 <li><a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point__index.html" title=
"This class holds an index of boundary points and allows iterating over them. ">boundary_point_index
</a> can be created from
<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> or other
<a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point__index.html" title=
"This class holds an index of boundary points and allows iterating over them. ">boundary_point_index
</a> that was created with same
<a class=
"el" href=
"group__boundary.html#ga15de9963ce9bb6037c8525901dfbf641">boundary_type
</a>. This is very fast operation as they shared same index and it does not require its regeneration.
</li>
158 <dl class=
"section see"><dt>See Also
</dt><dd></dd></dl>
160 <li><a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1segment__index.html">segment_index
</a></li>
161 <li><a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point
</a></li>
162 <li><a class=
"el" href=
"classboost_1_1locale_1_1boundary_1_1segment.html">segment
</a> </li>
164 </div><hr/>The documentation for this class was generated from the following file:
<ul>
165 <li>boost/locale/boundary/
<a class=
"el" href=
"index_8hpp_source.html">index.hpp
</a></li>
167 </div><!-- contents -->
168 </div><!-- doc-content -->
171 © 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.