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 <title>Boost.Locale: boost::locale::boundary::boundary_point< IteratorType > Class Template Reference</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
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);
21 <div id="top"><!-- do not remove this div! -->
25 <table cellspacing="0" cellpadding="0">
27 <tr style="height: 56px;">
29 <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">Boost.Locale
46 <!-- Generated by Doxygen 1.7.6.1 -->
47 <div id="navrow1" class="tabs">
49 <li><a href="index.html"><span>Main Page</span></a></li>
50 <li><a href="modules.html"><span>Modules</span></a></li>
51 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
52 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
53 <li><a href="files.html"><span>Files</span></a></li>
54 <li><a href="examples.html"><span>Examples</span></a></li>
57 <div id="navrow2" class="tabs2">
59 <li><a href="annotated.html"><span>Class List</span></a></li>
60 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
61 <li><a href="functions.html"><span>Class Members</span></a></li>
65 <div id="side-nav" class="ui-resizable side-nav-resizable">
67 <div id="nav-tree-contents">
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
74 <script type="text/javascript">
75 initNavTree('classboost_1_1locale_1_1boundary_1_1boundary__point.html','');
77 <div id="doc-content">
80 <a href="#pub-types">Public Types</a> |
81 <a href="#pub-methods">Public Member Functions</a> </div>
82 <div class="headertitle">
83 <div class="title">boost::locale::boundary::boundary_point< IteratorType > Class Template Reference<div class="ingroups"><a class="el" href="group__boundary.html">Boundary Analysis</a></div></div> </div>
85 <div class="contents">
86 <!-- doxytag: class="boost::locale::boundary::boundary_point" -->
87 <p>This class represents a boundary point in the text.
88 <a href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#details">More...</a></p>
90 <p><code>#include <<a class="el" href="boundary__point_8hpp_source.html">boost/locale/boundary/boundary_point.hpp</a>></code></p>
92 <p><a href="classboost_1_1locale_1_1boundary_1_1boundary__point-members.html">List of all members.</a></p>
93 <table class="memberdecls">
94 <tr><td colspan="2"><h2><a name="pub-types"></a>
95 Public Types</h2></td></tr>
96 <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>
97 <tr><td colspan="2"><h2><a name="pub-methods"></a>
98 Public Member Functions</h2></td></tr>
99 <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>
100 <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>
101 <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>
102 <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>
103 <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>
104 <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>
105 <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>
106 <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>
107 <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>
108 <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>
109 <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>
111 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
112 <div class="textblock"><h3>template<typename IteratorType><br/>
113 class boost::locale::boundary::boundary_point< IteratorType ></h3>
115 <p>This class represents a boundary point in the text. </p>
116 <p>It represents a pair - an iterator and a rule that defines this point.</p>
117 <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>
118 <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>
119 <dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
121 <li>The beginning of analyzed range is always considered a boundary point and its rule is always 0.</li>
122 <li>when using a word boundary analysis the returned rule relates to a chunk of text preceding this point.</li>
124 <dl class="see"><dt><b>See also:</b></dt><dd></dd></dl>
126 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point__index.html">boundary_point_index</a></li>
127 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment.html">segment</a></li>
128 <li><a class="el" href="classboost_1_1locale_1_1boundary_1_1segment__index.html">segment_index</a> </li>
130 </div><hr/><h2>Member Typedef Documentation</h2>
131 <a class="anchor" id="af3c3a74a9a79690ff44f38d267b3b694"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::iterator_type" ref="af3c3a74a9a79690ff44f38d267b3b694" args="" -->
132 <div class="memitem">
133 <div class="memproto">
134 <div class="memtemplate">
135 template<typename IteratorType> </div>
136 <table class="memname">
138 <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>
143 <p>The type of the base iterator that iterates the original text </p>
147 <hr/><h2>Constructor & Destructor Documentation</h2>
148 <a class="anchor" id="aabbbee60c2c97ffd95210206a86c9298"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::boundary_point" ref="aabbbee60c2c97ffd95210206a86c9298" args="()" -->
149 <div class="memitem">
150 <div class="memproto">
151 <div class="memtemplate">
152 template<typename IteratorType> </div>
153 <table class="memname">
155 <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>
157 <td class="paramname"></td><td>)</td>
158 <td><code> [inline]</code></td>
163 <p>Empty default constructor </p>
167 <a class="anchor" id="a653a1c0d7480006ff647a656c74521df"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::boundary_point" ref="a653a1c0d7480006ff647a656c74521df" args="(iterator_type p, rule_type r)" -->
168 <div class="memitem">
169 <div class="memproto">
170 <div class="memtemplate">
171 template<typename IteratorType> </div>
172 <table class="memname">
174 <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>
176 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> </td>
177 <td class="paramname"><em>p</em>, </td>
180 <td class="paramkey"></td>
182 <td class="paramtype"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> </td>
183 <td class="paramname"><em>r</em> </td>
188 <td></td><td><code> [inline]</code></td>
193 <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>
197 <hr/><h2>Member Function Documentation</h2>
198 <a class="anchor" id="a5ea18137618a1a84ff0b75c3b166c495"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::iterator" ref="a5ea18137618a1a84ff0b75c3b166c495" args="(iterator_type i)" -->
199 <div class="memitem">
200 <div class="memproto">
201 <div class="memtemplate">
202 template<typename IteratorType> </div>
203 <table class="memname">
205 <td class="memname">void <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#a5ea18137618a1a84ff0b75c3b166c495">iterator</a> </td>
207 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> </td>
208 <td class="paramname"><em>i</em></td><td>)</td>
209 <td><code> [inline]</code></td>
214 <p>Set an new iterator value <em>i</em> </p>
218 <a class="anchor" id="af279d5382e1b28c2ce82035c1929ea66"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::iterator" ref="af279d5382e1b28c2ce82035c1929ea66" args="() const " -->
219 <div class="memitem">
220 <div class="memproto">
221 <div class="memtemplate">
222 template<typename IteratorType> </div>
223 <table class="memname">
225 <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 >::<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a5ea18137618a1a84ff0b75c3b166c495">iterator</a> </td>
227 <td class="paramname"></td><td>)</td>
228 <td> const<code> [inline]</code></td>
233 <p>Fetch an iterator </p>
237 <a class="anchor" id="aa2dc88b4d02151aea939a01b7fc88730"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator iterator_type" ref="aa2dc88b4d02151aea939a01b7fc88730" args="() const " -->
238 <div class="memitem">
239 <div class="memproto">
240 <div class="memtemplate">
241 template<typename IteratorType> </div>
242 <table class="memname">
244 <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>
246 <td class="paramname"></td><td>)</td>
247 <td> const<code> [inline]</code></td>
252 <p>Automatic cast to the iterator it represents </p>
256 <a class="anchor" id="a4347b22dd7edb8af49d1316a6f86d0c2"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator!=" ref="a4347b22dd7edb8af49d1316a6f86d0c2" args="(boundary_point const &other) const " -->
257 <div class="memitem">
258 <div class="memproto">
259 <div class="memtemplate">
260 template<typename IteratorType> </div>
261 <table class="memname">
263 <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>
265 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a>< IteratorType > const & </td>
266 <td class="paramname"><em>other</em></td><td>)</td>
267 <td> const<code> [inline]</code></td>
272 <p>Check if two boundary points are different </p>
276 <a class="anchor" id="a4cd03f39d75bb054be9a0ae23189fa7a"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator!=" ref="a4cd03f39d75bb054be9a0ae23189fa7a" args="(iterator_type const &other) const " -->
277 <div class="memitem">
278 <div class="memproto">
279 <div class="memtemplate">
280 template<typename IteratorType> </div>
281 <table class="memname">
283 <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>
285 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> const & </td>
286 <td class="paramname"><em>other</em></td><td>)</td>
287 <td> const<code> [inline]</code></td>
292 <p>Check if the boundary point points to different location from an iterator <em>other</em> </p>
296 <a class="anchor" id="a058ffbcbd43fc41a40a4a1cf5be987f2"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator==" ref="a058ffbcbd43fc41a40a4a1cf5be987f2" args="(boundary_point const &other) const " -->
297 <div class="memitem">
298 <div class="memproto">
299 <div class="memtemplate">
300 template<typename IteratorType> </div>
301 <table class="memname">
303 <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>
305 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a>< IteratorType > const & </td>
306 <td class="paramname"><em>other</em></td><td>)</td>
307 <td> const<code> [inline]</code></td>
312 <p>Check if two boundary points are the same </p>
316 <a class="anchor" id="a87a96a1745184ff7495db87943aca424"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::operator==" ref="a87a96a1745184ff7495db87943aca424" args="(iterator_type 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#af3c3a74a9a79690ff44f38d267b3b694">iterator_type</a> const & </td>
326 <td class="paramname"><em>other</em></td><td>)</td>
327 <td> const<code> [inline]</code></td>
332 <p>Check if the boundary point points to same location as an iterator <em>other</em> </p>
336 <a class="anchor" id="a757b28e11c66f9871d3f51fe93a51bdb"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::rule" ref="a757b28e11c66f9871d3f51fe93a51bdb" args="(rule_type r)" -->
337 <div class="memitem">
338 <div class="memproto">
339 <div class="memtemplate">
340 template<typename IteratorType> </div>
341 <table class="memname">
343 <td class="memname">void <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#a757b28e11c66f9871d3f51fe93a51bdb">rule</a> </td>
345 <td class="paramtype"><a class="el" href="group__boundary.html#ga25e193c81052ef1795f1b53b46bc2095">rule_type</a> </td>
346 <td class="paramname"><em>r</em></td><td>)</td>
347 <td><code> [inline]</code></td>
352 <p>Set an new rule value <em>r</em> </p>
356 <a class="anchor" id="a75e2f04f0f7c1065470f722d1f2e004b"></a><!-- doxytag: member="boost::locale::boundary::boundary_point::rule" ref="a75e2f04f0f7c1065470f722d1f2e004b" args="() const " -->
357 <div class="memitem">
358 <div class="memproto">
359 <div class="memtemplate">
360 template<typename IteratorType> </div>
361 <table class="memname">
363 <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 >::<a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html#a757b28e11c66f9871d3f51fe93a51bdb">rule</a> </td>
365 <td class="paramname"></td><td>)</td>
366 <td> const<code> [inline]</code></td>
375 <hr/>The documentation for this class was generated from the following file:<ul>
376 <li>boost/locale/boundary/<a class="el" href="boundary__point_8hpp_source.html">boundary_point.hpp</a></li>
378 </div><!-- contents -->
380 <div id="nav-path" class="navpath">
382 <li class="navelem"><b>boost</b> </li>
383 <li class="navelem"><a class="el" href="namespaceboost_1_1locale.html">locale</a> </li>
384 <li class="navelem"><a class="el" href="namespaceboost_1_1locale_1_1boundary.html">boundary</a> </li>
385 <li class="navelem"><a class="el" href="classboost_1_1locale_1_1boundary_1_1boundary__point.html">boundary_point</a> </li>
388 © 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.