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 <title>Boost.Locale: boost::locale::boundary::boundary_point< IteratorType > Class Template Reference</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
8 <link rel="stylesheet" type="text/css" href="../style/section-basic.css">
11 <div id="boost-common-heading-doc">
12 <div class="heading-inner">
13 <div class="heading-placard"></div>
15 <h1 class="heading-title">
16 <a href="http://www.boost.org/">
17 <img src="../style/space.png" alt= "Boost C++ Libraries" class="heading-logo" />
18 <span class="heading-boost">Boost</span>
19 <span class="heading-cpplibraries">C++ Libraries</span>
23 <p class="heading-quote">
25 <q>...one of the most highly
26 regarded and expertly designed C++ library projects in the
29 <span class="heading-attribution">— <a href=
30 "http://www.gotw.ca/" class="external">Herb Sutter</a> and <a href=
31 "http://en.wikipedia.org/wiki/Andrei_Alexandrescu" class="external">Andrei
32 Alexandrescu</a>, <a href=
33 "http://safari.awprofessional.com/?XmlId=0321113586" class="external">C++
34 Coding Standards</a></span>
39 <div id="boost-common-heading-doc-spacer"></div>
40 <!-- Generated by Doxygen 1.7.1 -->
41 <div class="navigation" id="top">
44 <li><a href="main.html"><span>Main Page</span></a></li>
45 <li><a href="modules.html"><span>Modules</span></a></li>
46 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
47 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
48 <li><a href="files.html"><span>Files</span></a></li>
49 <li><a href="examples.html"><span>Examples</span></a></li>
54 <li><a href="annotated.html"><span>Class List</span></a></li>
55 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
56 <li><a href="functions.html"><span>Class Members</span></a></li>
61 <li><b>boost</b> </li>
62 <li><a class="el" href="namespaceboost_1_1locale.html">locale</a> </li>
63 <li><a class="el" href="namespaceboost_1_1locale_1_1boundary.html">boundary</a> </li>
64 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point< IteratorType ></a> </li>
70 <a href="#pub-types">Public Types</a> |
71 <a href="#pub-methods">Public Member Functions</a> </div>
72 <div class="headertitle">
73 <h1>boost::locale::boundary::boundary_point< IteratorType > Class Template Reference<br/>
75 [<a class="el" href="group__boundary.html">Boundary Analysis</a>]</small>
78 <div class="contents">
79 <!-- doxytag: class="boost::locale::boundary::boundary_point" -->
80 <p>This class represents a boundary point in the text.
81 <a href="#_details">More...</a></p>
83 <p><code>#include <<a class="el" href="boundary__point_8hpp_source.html">boost/locale/boundary/boundary_point.hpp</a>></code></p>
85 <p><a href="classboost_1_1locale_1_1boundary_1_1boundary__point-members.html">List of all members.</a></p>
86 <table class="memberdecls">
87 <tr><td colspan="2"><h2><a name="pub-types"></a>
88 Public Types</h2></td></tr>
89 <tr><td class="memItemLeft" align="right" valign="top">typedef IteratorType </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a></td></tr>
90 <tr><td colspan="2"><h2><a name="pub-methods"></a>
91 Public Member Functions</h2></td></tr>
92 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#aabbbee60c2c97ffd95210206a86c9298">boundary_point</a> ()</td></tr>
93 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a653a1c0d7480006ff647a656c74521df">boundary_point</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> p, <a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> r)</td></tr>
94 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a5ea18137618a1a84ff0b75c3b166c495">iterator</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> i)</td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a757b28e11c66f9871d3f51fe93a51bdb">rule</a> (<a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> r)</td></tr>
96 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af279d5382e1b28c2ce82035c1929ea66">iterator</a> () const </td></tr>
97 <tr><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="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a75e2f04f0f7c1065470f722d1f2e004b">rule</a> () const </td></tr>
98 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a058ffbcbd43fc41a40a4a1cf5be987f2">operator==</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a> const &other) const </td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a4347b22dd7edb8af49d1316a6f86d0c2">operator!=</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a> const &other) const </td></tr>
100 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a87a96a1745184ff7495db87943aca424">operator==</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> const &other) const </td></tr>
101 <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a4cd03f39d75bb054be9a0ae23189fa7a">operator!=</a> (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> const &other) const </td></tr>
102 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#aa2dc88b4d02151aea939a01b7fc88730">operator iterator_type</a> () const </td></tr>
104 <hr/><a name="_details"></a><h2>Detailed Description</h2>
105 <h3>template<typename IteratorType><br/>
106 class boost::locale::boundary::boundary_point< IteratorType ></h3>
108 <p>This class represents a boundary point in the text. </p>
109 <p>It represents a pair - an iterator and a rule that defines this point.</p>
110 <p>This type of object is dereference by the iterators of <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>. Using a <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a757b28e11c66f9871d3f51fe93a51bdb">rule()</a> member function you can get the reason why this specific boundary point was selected.</p>
111 <p>For example, When you use a sentence boundary analysis, the (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a757b28e11c66f9871d3f51fe93a51bdb">rule()</a> & <a class="el" href="group__boundary.html#ga3befefe67f79691c117bf5588741355b">sentence_term</a>) != 0 means that this boundary point was selected because a sentence terminator (like .?!) was spotted and the (<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a757b28e11c66f9871d3f51fe93a51bdb">rule()</a> & <a class="el" href="group__boundary.html#gaf67883341dd3d8f786e7281d40790000">sentence_sep</a>)!=0 means that a separator like line feed or carriage return was observed.</p>
112 <dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
114 <li>The beginning of analyzed range is always considered a boundary point and its rule is always 0.</li>
115 <li>when using a word boundary analysis the returned rule relates to a chunk of text preceding this point.</li>
117 <dl class="see"><dt><b>See also:</b></dt><dd></dd></dl>
119 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point__index.html">boundary_point_index</a></li>
120 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">segment</a></li>
121 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment__index.html">segment_index</a> </li>
123 <hr/><h2>Member Typedef Documentation</h2>
124 <a class="anchor" id="af3c3a74a9a79690ff44f38d267b3b694"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::iterator_type" ref="af3c3a74a9a79690ff44f38d267b3b694" args="" -->
125 <div class="memitem">
126 <div class="memproto">
127 <div class="memtemplate">
128 template<typename IteratorType> </div>
129 <table class="memname">
131 <td class="memname">typedef IteratorType <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a></td>
136 <p>The type of the base iterator that iterates the original text </p>
140 <hr/><h2>Constructor & Destructor Documentation</h2>
141 <a class="anchor" id="aabbbee60c2c97ffd95210206a86c9298"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::boundary_point" ref="aabbbee60c2c97ffd95210206a86c9298" args="()" -->
142 <div class="memitem">
143 <div class="memproto">
144 <div class="memtemplate">
145 template<typename IteratorType> </div>
146 <table class="memname">
148 <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a> </td>
150 <td class="paramname"></td>
151 <td> ) </td>
152 <td><code> [inline]</code></td>
157 <p>Empty default constructor </p>
161 <a class="anchor" id="a653a1c0d7480006ff647a656c74521df"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::boundary_point" ref="a653a1c0d7480006ff647a656c74521df" args="(iterator_type p, rule_type r)" -->
162 <div class="memitem">
163 <div class="memproto">
164 <div class="memtemplate">
165 template<typename IteratorType> </div>
166 <table class="memname">
168 <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a> </td>
170 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> </td>
171 <td class="paramname"> <em>p</em>, </td>
174 <td class="paramkey"></td>
176 <td class="paramtype"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> </td>
177 <td class="paramname"> <em>r</em></td><td> </td>
182 <td></td><td></td><td><code> [inline]</code></td>
187 <p>Create a new <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> using iterator <code>and</code> a rule <em>r</em> </p>
191 <hr/><h2>Member Function Documentation</h2>
192 <a class="anchor" id="a5ea18137618a1a84ff0b75c3b166c495"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::iterator" ref="a5ea18137618a1a84ff0b75c3b166c495" args="(iterator_type i)" -->
193 <div class="memitem">
194 <div class="memproto">
195 <div class="memtemplate">
196 template<typename IteratorType> </div>
197 <table class="memname">
199 <td class="memname">void <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::iterator </td>
201 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> </td>
202 <td class="paramname"> <em>i</em></td>
203 <td> ) </td>
204 <td><code> [inline]</code></td>
209 <p>Set an new iterator value <em>i</em> </p>
213 <a class="anchor" id="af279d5382e1b28c2ce82035c1929ea66"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::iterator" ref="af279d5382e1b28c2ce82035c1929ea66" args="() const " -->
214 <div class="memitem">
215 <div class="memproto">
216 <div class="memtemplate">
217 template<typename IteratorType> </div>
218 <table class="memname">
220 <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::iterator </td>
222 <td class="paramname"></td>
223 <td> ) </td>
224 <td> const<code> [inline]</code></td>
229 <p>Fetch an iterator </p>
233 <a class="anchor" id="aa2dc88b4d02151aea939a01b7fc88730"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator iterator_type" ref="aa2dc88b4d02151aea939a01b7fc88730" args="() const " -->
234 <div class="memitem">
235 <div class="memproto">
236 <div class="memtemplate">
237 template<typename IteratorType> </div>
238 <table class="memname">
240 <td class="memname"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::operator <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> </td>
242 <td class="paramname"></td>
243 <td> ) </td>
244 <td> const<code> [inline]</code></td>
249 <p>Automatic cast to the iterator it represents </p>
253 <a class="anchor" id="a4cd03f39d75bb054be9a0ae23189fa7a"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator!=" ref="a4cd03f39d75bb054be9a0ae23189fa7a" args="(iterator_type const &other) const " -->
254 <div class="memitem">
255 <div class="memproto">
256 <div class="memtemplate">
257 template<typename IteratorType> </div>
258 <table class="memname">
260 <td class="memname">bool <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::operator!= </td>
262 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> const & </td>
263 <td class="paramname"> <em>other</em></td>
264 <td> ) </td>
265 <td> const<code> [inline]</code></td>
270 <p>Check if the boundary point points to different location from an iterator <em>other</em> </p>
274 <a class="anchor" id="a4347b22dd7edb8af49d1316a6f86d0c2"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator!=" ref="a4347b22dd7edb8af49d1316a6f86d0c2" args="(boundary_point const &other) const " -->
275 <div class="memitem">
276 <div class="memproto">
277 <div class="memtemplate">
278 template<typename IteratorType> </div>
279 <table class="memname">
281 <td class="memname">bool <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::operator!= </td>
283 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a>< IteratorType > const & </td>
284 <td class="paramname"> <em>other</em></td>
285 <td> ) </td>
286 <td> const<code> [inline]</code></td>
291 <p>Check if two boundary points are different </p>
295 <a class="anchor" id="a87a96a1745184ff7495db87943aca424"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator==" ref="a87a96a1745184ff7495db87943aca424" args="(iterator_type const &other) const " -->
296 <div class="memitem">
297 <div class="memproto">
298 <div class="memtemplate">
299 template<typename IteratorType> </div>
300 <table class="memname">
302 <td class="memname">bool <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::operator== </td>
304 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> const & </td>
305 <td class="paramname"> <em>other</em></td>
306 <td> ) </td>
307 <td> const<code> [inline]</code></td>
312 <p>Check if the boundary point points to same location as an iterator <em>other</em> </p>
316 <a class="anchor" id="a058ffbcbd43fc41a40a4a1cf5be987f2"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator==" ref="a058ffbcbd43fc41a40a4a1cf5be987f2" args="(boundary_point const &other) const " -->
317 <div class="memitem">
318 <div class="memproto">
319 <div class="memtemplate">
320 template<typename IteratorType> </div>
321 <table class="memname">
323 <td class="memname">bool <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::operator== </td>
325 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a>< IteratorType > const & </td>
326 <td class="paramname"> <em>other</em></td>
327 <td> ) </td>
328 <td> const<code> [inline]</code></td>
333 <p>Check if two boundary points are the same </p>
337 <a class="anchor" id="a75e2f04f0f7c1065470f722d1f2e004b"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::rule" ref="a75e2f04f0f7c1065470f722d1f2e004b" args="() const " -->
338 <div class="memitem">
339 <div class="memproto">
340 <div class="memtemplate">
341 template<typename IteratorType> </div>
342 <table class="memname">
344 <td class="memname"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::rule </td>
346 <td class="paramname"></td>
347 <td> ) </td>
348 <td> const<code> [inline]</code></td>
357 <a class="anchor" id="a757b28e11c66f9871d3f51fe93a51bdb"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::rule" ref="a757b28e11c66f9871d3f51fe93a51bdb" args="(rule_type r)" -->
358 <div class="memitem">
359 <div class="memproto">
360 <div class="memtemplate">
361 template<typename IteratorType> </div>
362 <table class="memname">
364 <td class="memname">void <a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boost::locale::boundary::boundary_point</a>< IteratorType >::rule </td>
366 <td class="paramtype"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> </td>
367 <td class="paramname"> <em>r</em></td>
368 <td> ) </td>
369 <td><code> [inline]</code></td>
374 <p>Set an new rule value <em>r</em> </p>
378 <hr/>The documentation for this class was generated from the following file:<ul>
379 <li>boost/locale/boundary/<a class="el" href="boundary__point_8hpp_source.html">boundary_point.hpp</a></li>
382 <hr class="footer"/><address class="footer"><small>
383 © Copyright 2009-2011 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.