1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Quick Reference</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../string_algo.html" title="Chapter 2. Boost String Algorithms Library"> 10<link rel="prev" href="usage.html" title="Usage"> 11<link rel="next" href="design.html" title="Design Topics"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="usage.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../string_algo.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="design.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="section"> 27<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 28<a name="string_algo.quickref"></a>Quick Reference</h2></div></div></div> 29<div class="toc"><dl class="toc"> 30<dt><span class="section"><a href="quickref.html#id-1.3.3.6.2">Algorithms</a></span></dt> 31<dt><span class="section"><a href="quickref.html#id-1.3.3.6.3">Finders and Formatters</a></span></dt> 32<dt><span class="section"><a href="quickref.html#id-1.3.3.6.4">Iterators</a></span></dt> 33<dt><span class="section"><a href="quickref.html#id-1.3.3.6.5">Classification</a></span></dt> 34</dl></div> 35<div class="section"> 36<div class="titlepage"><div><div><h3 class="title"> 37<a name="id-1.3.3.6.2"></a>Algorithms</h3></div></div></div> 38<div class="table"> 39<a name="id-1.3.3.6.2.2"></a><p class="title"><b>Table 2.1. Case Conversion</b></p> 40<div class="table-contents"><table class="table" summary="Case Conversion"> 41<colgroup> 42<col> 43<col> 44<col> 45</colgroup> 46<thead><tr> 47<th align="left">Algorithm name</th> 48<th align="left">Description</th> 49<th align="left">Functions</th> 50</tr></thead> 51<tbody> 52<tr> 53<td align="left"><code class="computeroutput">to_upper</code></td> 54<td align="left">Convert a string to upper case</td> 55<td align="left"> 56 <code class="computeroutput"><a class="link" href="../boost/algorithm/to_upper_copy.html" title="Function to_upper_copy">to_upper_copy()</a></code> 57 <br> 58 <code class="computeroutput"><a class="link" href="../boost/algorithm/to_upper.html" title="Function template to_upper">to_upper()</a></code> 59 </td> 60</tr> 61<tr> 62<td align="left"><code class="computeroutput">to_lower</code></td> 63<td align="left">Convert a string to lower case</td> 64<td align="left"> 65 <code class="computeroutput"><a class="link" href="../boost/algorithm/to_lower_copy.html" title="Function to_lower_copy">to_lower_copy()</a></code> 66 <br> 67 <code class="computeroutput"><a class="link" href="../boost/algorithm/to_lower.html" title="Function template to_lower">to_lower()</a></code> 68 </td> 69</tr> 70</tbody> 71</table></div> 72</div> 73<br class="table-break"><div class="table"> 74<a name="id-1.3.3.6.2.3"></a><p class="title"><b>Table 2.2. Trimming</b></p> 75<div class="table-contents"><table class="table" summary="Trimming"> 76<colgroup> 77<col> 78<col> 79<col> 80</colgroup> 81<thead><tr> 82<th align="left">Algorithm name</th> 83<th align="left">Description</th> 84<th align="left">Functions</th> 85</tr></thead> 86<tbody> 87<tr> 88<td align="left"><code class="computeroutput">trim_left</code></td> 89<td align="left">Remove leading spaces from a string</td> 90<td align="left"> 91 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_left_copy_if.html" title="Function trim_left_copy_if">trim_left_copy_if()</a></code> 92 <br> 93 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_left_if.html" title="Function template trim_left_if">trim_left_if()</a></code> 94 <br> 95 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_left_copy.html" title="Function template trim_left_copy">trim_left_copy()</a></code> 96 <br> 97 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_left.html" title="Function template trim_left">trim_left()</a></code> 98 </td> 99</tr> 100<tr> 101<td align="left"><code class="computeroutput">trim_right</code></td> 102<td align="left">Remove trailing spaces from a string</td> 103<td align="left"> 104 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_right_copy_if.html" title="Function trim_right_copy_if">trim_right_copy_if()</a></code> 105 <br> 106 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_right_if.html" title="Function template trim_right_if">trim_right_if()</a></code> 107 <br> 108 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_right_copy.html" title="Function template trim_right_copy">trim_right_copy()</a></code> 109 <br> 110 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_right.html" title="Function template trim_right">trim_right()</a></code> 111 </td> 112</tr> 113<tr> 114<td align="left"><code class="computeroutput">trim</code></td> 115<td align="left">Remove leading and trailing spaces from a string</td> 116<td align="left"> 117 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_copy_if.html" title="Function trim_copy_if">trim_copy_if()</a></code> 118 <br> 119 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_if.html" title="Function template trim_if">trim_if()</a></code> 120 <br> 121 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim_copy.html" title="Function template trim_copy">trim_copy()</a></code> 122 <br> 123 <code class="computeroutput"><a class="link" href="../boost/algorithm/trim.html" title="Function template trim">trim()</a></code> 124 </td> 125</tr> 126</tbody> 127</table></div> 128</div> 129<br class="table-break"><div class="table"> 130<a name="id-1.3.3.6.2.4"></a><p class="title"><b>Table 2.3. Predicates</b></p> 131<div class="table-contents"><table class="table" summary="Predicates"> 132<colgroup> 133<col> 134<col> 135<col> 136</colgroup> 137<thead><tr> 138<th align="left">Algorithm name</th> 139<th align="left">Description</th> 140<th align="left">Functions</th> 141</tr></thead> 142<tbody> 143<tr> 144<td align="left"><code class="computeroutput">starts_with</code></td> 145<td align="left">Check if a string is a prefix of the other one</td> 146<td align="left"> 147 <code class="computeroutput"><a class="link" href="../boost/algorithm/starts_with.html" title="Function starts_with">starts_with()</a></code> 148 <br> 149 <code class="computeroutput"><a class="link" href="../boost/algorithm/istarts_with.html" title="Function template istarts_with">istarts_with()</a></code> 150 </td> 151</tr> 152<tr> 153<td align="left"><code class="computeroutput">ends_with</code></td> 154<td align="left">Check if a string is a suffix of the other one</td> 155<td align="left"> 156 <code class="computeroutput"><a class="link" href="../boost/algorithm/ends_with.html" title="Function ends_with">ends_with()</a></code> 157 <br> 158 <code class="computeroutput"><a class="link" href="../boost/algorithm/iends_with.html" title="Function template iends_with">iends_with()</a></code> 159 </td> 160</tr> 161<tr> 162<td align="left"><code class="computeroutput">contains</code></td> 163<td align="left">Check if a string is contained of the other one</td> 164<td align="left"> 165 <code class="computeroutput"><a class="link" href="../boost/algorithm/contains.html" title="Function contains">contains()</a></code> 166 <br> 167 <code class="computeroutput"><a class="link" href="../boost/algorithm/icontains.html" title="Function template icontains">icontains()</a></code> 168 </td> 169</tr> 170<tr> 171<td align="left"><code class="computeroutput">equals</code></td> 172<td align="left">Check if two strings are equal</td> 173<td align="left"> 174 <code class="computeroutput"><a class="link" href="../boost/algorithm/equals.html" title="Function equals">equals()</a></code> 175 <br> 176 <code class="computeroutput"><a class="link" href="../boost/algorithm/iequals.html" title="Function template iequals">iequals()</a></code> 177 </td> 178</tr> 179<tr> 180<td align="left"><code class="computeroutput">lexicographical_compare</code></td> 181<td align="left">Check if a string is lexicographically less then another one</td> 182<td align="left"> 183 <code class="computeroutput"><a class="link" href="../boost/algorithm/lexicographical_compare.html" title="Function lexicographical_compare">lexicographical_compare()</a></code> 184 <br> 185 <code class="computeroutput"><a class="link" href="../boost/algorithm/ilexicographical_compare.html" title="Function template ilexicographical_compare">ilexicographical_compare()</a></code> 186 </td> 187</tr> 188<tr> 189<td align="left"><code class="computeroutput">all</code></td> 190<td align="left">Check if all elements of a string satisfy the given predicate</td> 191<td align="left"> 192 <code class="computeroutput"><a class="link" href="../boost/algorithm/all.html" title="Function template all">all()</a></code> 193 </td> 194</tr> 195</tbody> 196</table></div> 197</div> 198<br class="table-break"><div class="table"> 199<a name="id-1.3.3.6.2.5"></a><p class="title"><b>Table 2.4. Find algorithms</b></p> 200<div class="table-contents"><table class="table" summary="Find algorithms"> 201<colgroup> 202<col> 203<col> 204<col> 205</colgroup> 206<thead><tr> 207<th align="left">Algorithm name</th> 208<th align="left">Description</th> 209<th align="left">Functions</th> 210</tr></thead> 211<tbody> 212<tr> 213<td align="left">find_first</td> 214<td align="left">Find the first occurrence of a string in the input</td> 215<td align="left"> 216 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_first.html" title="Function template find_first">find_first()</a></code> 217 <br> 218 <code class="computeroutput"><a class="link" href="../boost/algorithm/ifind_first.html" title="Function template ifind_first">ifind_first()</a></code> 219 </td> 220</tr> 221<tr> 222<td align="left">find_last</td> 223<td align="left">Find the last occurrence of a string in the input</td> 224<td align="left"> 225 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_last.html" title="Function template find_last">find_last()</a></code> 226 <br> 227 <code class="computeroutput"><a class="link" href="../boost/algorithm/ifind_last.html" title="Function template ifind_last">ifind_last()</a></code> 228 </td> 229</tr> 230<tr> 231<td align="left">find_nth</td> 232<td align="left">Find the nth (zero-indexed) occurrence of a string in the input</td> 233<td align="left"> 234 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_nth.html" title="Function template find_nth">find_nth()</a></code> 235 <br> 236 <code class="computeroutput"><a class="link" href="../boost/algorithm/ifind_nth.html" title="Function template ifind_nth">ifind_nth()</a></code> 237 </td> 238</tr> 239<tr> 240<td align="left">find_head</td> 241<td align="left">Retrieve the head of a string</td> 242<td align="left"> 243 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_head.html" title="Function template find_head">find_head()</a></code> 244 </td> 245</tr> 246<tr> 247<td align="left">find_tail</td> 248<td align="left">Retrieve the tail of a string</td> 249<td align="left"> 250 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_tail.html" title="Function template find_tail">find_tail()</a></code> 251 </td> 252</tr> 253<tr> 254<td align="left">find_token</td> 255<td align="left">Find first matching token in the string</td> 256<td align="left"> 257 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_token.html" title="Function template find_token">find_token()</a></code> 258 </td> 259</tr> 260<tr> 261<td align="left">find_regex</td> 262<td align="left">Use the regular expression to search the string</td> 263<td align="left"> 264 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_regex.html" title="Function template find_regex">find_regex()</a></code> 265 </td> 266</tr> 267<tr> 268<td align="left">find</td> 269<td align="left">Generic find algorithm</td> 270<td align="left"> 271 <code class="computeroutput"><a class="link" href="../boost/algorithm/find.html" title="Function template find">find()</a></code> 272 </td> 273</tr> 274</tbody> 275</table></div> 276</div> 277<br class="table-break"><div class="table"> 278<a name="id-1.3.3.6.2.6"></a><p class="title"><b>Table 2.5. Erase/Replace</b></p> 279<div class="table-contents"><table class="table" summary="Erase/Replace"> 280<colgroup> 281<col> 282<col> 283<col> 284</colgroup> 285<thead><tr> 286<th align="left">Algorithm name</th> 287<th align="left">Description</th> 288<th align="left">Functions</th> 289</tr></thead> 290<tbody> 291<tr> 292<td align="left">replace/erase_first</td> 293<td align="left">Replace/Erase the first occurrence of a string in the input</td> 294<td align="left"> 295 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_first.html" title="Function template replace_first">replace_first()</a></code> 296 <br> 297 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_first_copy.html" title="Function replace_first_copy">replace_first_copy()</a></code> 298 <br> 299 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_first.html" title="Function template ireplace_first">ireplace_first()</a></code> 300 <br> 301 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_first_copy.html" title="Function ireplace_first_copy">ireplace_first_copy()</a></code> 302 <br> 303 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_first.html" title="Function template erase_first">erase_first()</a></code> 304 <br> 305 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_first_copy.html" title="Function erase_first_copy">erase_first_copy()</a></code> 306 <br> 307 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_first.html" title="Function template ierase_first">ierase_first()</a></code> 308 <br> 309 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_first_copy.html" title="Function ierase_first_copy">ierase_first_copy()</a></code> 310 </td> 311</tr> 312<tr> 313<td align="left">replace/erase_last</td> 314<td align="left">Replace/Erase the last occurrence of a string in the input</td> 315<td align="left"> 316 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_last.html" title="Function template replace_last">replace_last()</a></code> 317 <br> 318 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_last_copy.html" title="Function replace_last_copy">replace_last_copy()</a></code> 319 <br> 320 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_last.html" title="Function template ireplace_last">ireplace_last()</a></code> 321 <br> 322 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_last_copy.html" title="Function ireplace_last_copy">ireplace_last_copy()</a></code> 323 <br> 324 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_last.html" title="Function template erase_last">erase_last()</a></code> 325 <br> 326 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_last_copy.html" title="Function erase_last_copy">erase_last_copy()</a></code> 327 <br> 328 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_last.html" title="Function template ierase_last">ierase_last()</a></code> 329 <br> 330 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_last_copy.html" title="Function ierase_last_copy">ierase_last_copy()</a></code> 331 </td> 332</tr> 333<tr> 334<td align="left">replace/erase_nth</td> 335<td align="left">Replace/Erase the nth (zero-indexed) occurrence of a string in the input</td> 336<td align="left"> 337 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_nth.html" title="Function template replace_nth">replace_nth()</a></code> 338 <br> 339 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_nth_copy.html" title="Function replace_nth_copy">replace_nth_copy()</a></code> 340 <br> 341 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_nth.html" title="Function template ireplace_nth">ireplace_nth()</a></code> 342 <br> 343 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_nth_copy.html" title="Function ireplace_nth_copy">ireplace_nth_copy()</a></code> 344 <br> 345 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_nth.html" title="Function template erase_nth">erase_nth()</a></code> 346 <br> 347 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_nth_copy.html" title="Function erase_nth_copy">erase_nth_copy()</a></code> 348 <br> 349 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_nth.html" title="Function template ierase_nth">ierase_nth()</a></code> 350 <br> 351 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_nth_copy.html" title="Function ierase_nth_copy">ierase_nth_copy()</a></code> 352 </td> 353</tr> 354<tr> 355<td align="left">replace/erase_all</td> 356<td align="left">Replace/Erase the all occurrences of a string in the input</td> 357<td align="left"> 358 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_all.html" title="Function template replace_all">replace_all()</a></code> 359 <br> 360 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_all_copy.html" title="Function replace_all_copy">replace_all_copy()</a></code> 361 <br> 362 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_all.html" title="Function template ireplace_all">ireplace_all()</a></code> 363 <br> 364 <code class="computeroutput"><a class="link" href="../boost/algorithm/ireplace_all_copy.html" title="Function ireplace_all_copy">ireplace_all_copy()</a></code> 365 <br> 366 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_all.html" title="Function template erase_all">erase_all()</a></code> 367 <br> 368 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_all_copy.html" title="Function erase_all_copy">erase_all_copy()</a></code> 369 <br> 370 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_all.html" title="Function template ierase_all">ierase_all()</a></code> 371 <br> 372 <code class="computeroutput"><a class="link" href="../boost/algorithm/ierase_all_copy.html" title="Function ierase_all_copy">ierase_all_copy()</a></code> 373 </td> 374</tr> 375<tr> 376<td align="left">replace/erase_head</td> 377<td align="left">Replace/Erase the head of the input</td> 378<td align="left"> 379 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_head.html" title="Function template replace_head">replace_head()</a></code> 380 <br> 381 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_head_copy.html" title="Function replace_head_copy">replace_head_copy()</a></code> 382 <br> 383 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_head.html" title="Function template erase_head">erase_head()</a></code> 384 <br> 385 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_head_copy.html" title="Function erase_head_copy">erase_head_copy()</a></code> 386 <br> 387 </td> 388</tr> 389<tr> 390<td align="left">replace/erase_tail</td> 391<td align="left">Replace/Erase the tail of the input</td> 392<td align="left"> 393 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_tail.html" title="Function template replace_tail">replace_tail()</a></code> 394 <br> 395 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_tail_copy.html" title="Function replace_tail_copy">replace_tail_copy()</a></code> 396 <br> 397 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_tail.html" title="Function template erase_tail">erase_tail()</a></code> 398 <br> 399 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_tail_copy.html" title="Function erase_tail_copy">erase_tail_copy()</a></code> 400 <br> 401 </td> 402</tr> 403<tr> 404<td align="left">replace/erase_regex</td> 405<td align="left">Replace/Erase a substring matching the given regular expression</td> 406<td align="left"> 407 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_regex.html" title="Function template replace_regex">replace_regex()</a></code> 408 <br> 409 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_regex_copy.html" title="Function replace_regex_copy">replace_regex_copy()</a></code> 410 <br> 411 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_regex.html" title="Function template erase_regex">erase_regex()</a></code> 412 <br> 413 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_regex_copy.html" title="Function erase_regex_copy">erase_regex_copy()</a></code> 414 <br> 415 </td> 416</tr> 417<tr> 418<td align="left">replace/erase_regex_all</td> 419<td align="left">Replace/Erase all substrings matching the given regular expression</td> 420<td align="left"> 421 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_all_regex.html" title="Function template replace_all_regex">replace_all_regex()</a></code> 422 <br> 423 <code class="computeroutput"><a class="link" href="../boost/algorithm/replace_all_regex_copy.html" title="Function replace_all_regex_copy">replace_all_regex_copy()</a></code> 424 <br> 425 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_all_regex.html" title="Function template erase_all_regex">erase_all_regex()</a></code> 426 <br> 427 <code class="computeroutput"><a class="link" href="../boost/algorithm/erase_all_regex_copy.html" title="Function erase_all_regex_copy">erase_all_regex_copy()</a></code> 428 <br> 429 </td> 430</tr> 431<tr> 432<td align="left">find_format</td> 433<td align="left">Generic replace algorithm</td> 434<td align="left"> 435 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_format.html" title="Function template find_format">find_format()</a></code> 436 <br> 437 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_format_copy.html" title="Function find_format_copy">find_format_copy()</a></code> 438 <br> 439 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_format_all.html" title="Function template find_format_all">find_format_all()</a></code> 440 <br> 441 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_format_all_copy.html" title="Function find_format_all_copy">find_format_all_copy()()</a></code> 442 </td> 443</tr> 444</tbody> 445</table></div> 446</div> 447<br class="table-break"><div class="table"> 448<a name="id-1.3.3.6.2.7"></a><p class="title"><b>Table 2.6. Split</b></p> 449<div class="table-contents"><table class="table" summary="Split"> 450<colgroup> 451<col> 452<col> 453<col> 454</colgroup> 455<thead><tr> 456<th align="left">Algorithm name</th> 457<th align="left">Description</th> 458<th align="left">Functions</th> 459</tr></thead> 460<tbody> 461<tr> 462<td align="left">find_all</td> 463<td align="left">Find/Extract all matching substrings in the input</td> 464<td align="left"> 465 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_all.html" title="Function template find_all">find_all()</a></code> 466 <br> 467 <code class="computeroutput"><a class="link" href="../boost/algorithm/ifind_all.html" title="Function template ifind_all">ifind_all()</a></code> 468 <br> 469 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_all_regex.html" title="Function template find_all_regex">find_all_regex()</a></code> 470 </td> 471</tr> 472<tr> 473<td align="left">split</td> 474<td align="left">Split input into parts</td> 475<td align="left"> 476 <code class="computeroutput"><a class="link" href="../boost/algorithm/split.html" title="Function template split">split()</a></code> 477 <br> 478 <code class="computeroutput"><a class="link" href="../boost/algorithm/split_regex.html" title="Function template split_regex">split_regex()</a></code> 479 </td> 480</tr> 481<tr> 482<td align="left">iter_find</td> 483<td align="left">Iteratively apply the finder to the input to find all matching substrings</td> 484<td align="left"> 485 <code class="computeroutput"><a class="link" href="../boost/algorithm/iter_find.html" title="Function template iter_find">iter_find()</a></code> 486 </td> 487</tr> 488<tr> 489<td align="left">iter_split</td> 490<td align="left">Use the finder to find matching substrings in the input and use them as separators to split the input into parts</td> 491<td align="left"> 492 <code class="computeroutput"><a class="link" href="../boost/algorithm/iter_split.html" title="Function template iter_split">iter_split()</a></code> 493 </td> 494</tr> 495</tbody> 496</table></div> 497</div> 498<br class="table-break"><div class="table"> 499<a name="id-1.3.3.6.2.8"></a><p class="title"><b>Table 2.7. Join</b></p> 500<div class="table-contents"><table class="table" summary="Join"> 501<colgroup> 502<col> 503<col> 504<col> 505</colgroup> 506<thead><tr> 507<th align="left">Algorithm name</th> 508<th align="left">Description</th> 509<th align="left">Functions</th> 510</tr></thead> 511<tbody> 512<tr> 513<td align="left">join</td> 514<td align="left">Join all elements in a container into a single string</td> 515<td align="left"> 516 <code class="computeroutput"><a class="link" href="../boost/algorithm/join.html" title="Function template join">join</a></code> 517 </td> 518</tr> 519<tr> 520<td align="left">join_if</td> 521<td align="left">Join all elements in a container that satisfies the condition into a single string</td> 522<td align="left"> 523 <code class="computeroutput"><a class="link" href="../boost/algorithm/join_if_1_3_3_9_14_3_1_2.html" title="Function template join_if">join_if()</a></code> 524 </td> 525</tr> 526</tbody> 527</table></div> 528</div> 529<br class="table-break"> 530</div> 531<div class="section"> 532<div class="titlepage"><div><div><h3 class="title"> 533<a name="id-1.3.3.6.3"></a>Finders and Formatters</h3></div></div></div> 534<div class="table"> 535<a name="id-1.3.3.6.3.2"></a><p class="title"><b>Table 2.8. Finders</b></p> 536<div class="table-contents"><table class="table" summary="Finders"> 537<colgroup> 538<col> 539<col> 540<col> 541</colgroup> 542<thead><tr> 543<th align="left">Finder</th> 544<th align="left">Description</th> 545<th align="left">Generators</th> 546</tr></thead> 547<tbody> 548<tr> 549<td align="left">first_finder</td> 550<td align="left">Search for the first match of the string in an input</td> 551<td align="left"> 552 <code class="computeroutput"><a class="link" href="../boost/algorithm/first_finder.html" title="Function first_finder">first_finder()</a></code> 553 </td> 554</tr> 555<tr> 556<td align="left">last_finder</td> 557<td align="left">Search for the last match of the string in an input</td> 558<td align="left"> 559 <code class="computeroutput"><a class="link" href="../boost/algorithm/last_finder.html" title="Function last_finder">last_finder()</a></code> 560 </td> 561</tr> 562<tr> 563<td align="left">nth_finder</td> 564<td align="left">Search for the nth (zero-indexed) match of the string in an input</td> 565<td align="left"> 566 <code class="computeroutput"><a class="link" href="../boost/algorithm/nth_finder.html" title="Function nth_finder">nth_finder()</a></code> 567 </td> 568</tr> 569<tr> 570<td align="left">head_finder</td> 571<td align="left">Retrieve the head of an input</td> 572<td align="left"> 573 <code class="computeroutput"><a class="link" href="../boost/algorithm/head_finder.html" title="Function head_finder">head_finder()</a></code> 574 </td> 575</tr> 576<tr> 577<td align="left">tail_finder</td> 578<td align="left">Retrieve the tail of an input</td> 579<td align="left"> 580 <code class="computeroutput"><a class="link" href="../boost/algorithm/tail_finder.html" title="Function tail_finder">tail_finder()</a></code> 581 </td> 582</tr> 583<tr> 584<td align="left">token_finder</td> 585<td align="left">Search for a matching token in an input</td> 586<td align="left"> 587 <code class="computeroutput"><a class="link" href="../boost/algorithm/token_finder.html" title="Function template token_finder">token_finder()</a></code> 588 </td> 589</tr> 590<tr> 591<td align="left">range_finder</td> 592<td align="left">Do no search, always returns the given range</td> 593<td align="left"> 594 <code class="computeroutput"><a class="link" href="../boost/algorithm/range_finder.html" title="Function range_finder">range_finder()</a></code> 595 </td> 596</tr> 597<tr> 598<td align="left">regex_finder</td> 599<td align="left">Search for a substring matching the given regex</td> 600<td align="left"> 601 <code class="computeroutput"><a class="link" href="../boost/algorithm/regex_finder.html" title="Function template regex_finder">regex_finder()</a></code> 602 </td> 603</tr> 604</tbody> 605</table></div> 606</div> 607<br class="table-break"><div class="table"> 608<a name="id-1.3.3.6.3.3"></a><p class="title"><b>Table 2.9. Formatters</b></p> 609<div class="table-contents"><table class="table" summary="Formatters"> 610<colgroup> 611<col> 612<col> 613<col> 614</colgroup> 615<thead><tr> 616<th align="left">Formatter</th> 617<th align="left">Description</th> 618<th align="left">Generators</th> 619</tr></thead> 620<tbody> 621<tr> 622<td align="left">const_formatter</td> 623<td align="left">Constant formatter. Always return the specified string</td> 624<td align="left"> 625 <code class="computeroutput"><a class="link" href="../boost/algorithm/const_formatter.html" title="Function template const_formatter">const_formatter()</a></code> 626 </td> 627</tr> 628<tr> 629<td align="left">identity_formatter</td> 630<td align="left">Identity formatter. Return unmodified input input</td> 631<td align="left"> 632 <code class="computeroutput"><a class="link" href="../boost/algorithm/identity_formatter.html" title="Function template identity_formatter">identity_formatter()</a></code> 633 </td> 634</tr> 635<tr> 636<td align="left">empty_formatter</td> 637<td align="left">Null formatter. Always return an empty string</td> 638<td align="left"> 639 <code class="computeroutput"><a class="link" href="../boost/algorithm/empty_formatter.html" title="Function template empty_formatter">empty_formatter()</a></code> 640 </td> 641</tr> 642<tr> 643<td align="left">regex_formatter</td> 644<td align="left">Regex formatter. Format regex match using the specification in the format string</td> 645<td align="left"> 646 <code class="computeroutput"><a class="link" href="../boost/algorithm/regex_formatter.html" title="Function template regex_formatter">regex_formatter()</a></code> 647 </td> 648</tr> 649</tbody> 650</table></div> 651</div> 652<br class="table-break"> 653</div> 654<div class="section"> 655<div class="titlepage"><div><div><h3 class="title"> 656<a name="id-1.3.3.6.4"></a>Iterators</h3></div></div></div> 657<div class="table"> 658<a name="id-1.3.3.6.4.2"></a><p class="title"><b>Table 2.10. Find Iterators</b></p> 659<div class="table-contents"><table class="table" summary="Find Iterators"> 660<colgroup> 661<col> 662<col> 663<col> 664</colgroup> 665<thead><tr> 666<th align="left">Iterator name</th> 667<th align="left">Description</th> 668<th align="left">Iterator class</th> 669</tr></thead> 670<tbody> 671<tr> 672<td align="left">find_iterator</td> 673<td align="left">Iterates through matching substrings in the input</td> 674<td align="left"> 675 <code class="computeroutput"><a class="link" href="../boost/algorithm/find_iterator.html" title="Class template find_iterator">find_iterator</a></code> 676 </td> 677</tr> 678<tr> 679<td align="left">split_iterator</td> 680<td align="left">Iterates through gaps between matching substrings in the input</td> 681<td align="left"> 682 <code class="computeroutput"><a class="link" href="../boost/algorithm/split_iterator.html" title="Class template split_iterator">split_iterator</a></code> 683 </td> 684</tr> 685</tbody> 686</table></div> 687</div> 688<br class="table-break"> 689</div> 690<div class="section"> 691<div class="titlepage"><div><div><h3 class="title"> 692<a name="id-1.3.3.6.5"></a>Classification</h3></div></div></div> 693<div class="table"> 694<a name="id-1.3.3.6.5.2"></a><p class="title"><b>Table 2.11. Predicates</b></p> 695<div class="table-contents"><table class="table" summary="Predicates"> 696<colgroup> 697<col> 698<col> 699<col> 700</colgroup> 701<thead><tr> 702<th align="left">Predicate name</th> 703<th align="left">Description</th> 704<th align="left">Generator</th> 705</tr></thead> 706<tbody> 707<tr> 708<td align="left">is_classified</td> 709<td align="left">Generic <code class="computeroutput">ctype</code> mask based classification</td> 710<td align="left"> 711 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_classified.html" title="Function is_classified">is_classified()</a></code> 712 </td> 713</tr> 714<tr> 715<td align="left">is_space</td> 716<td align="left">Recognize spaces</td> 717<td align="left"> 718 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_space.html" title="Function is_space">is_space()</a></code> 719 </td> 720</tr> 721<tr> 722<td align="left">is_alnum</td> 723<td align="left">Recognize alphanumeric characters</td> 724<td align="left"> 725 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_alnum.html" title="Function is_alnum">is_alnum()</a></code> 726 </td> 727</tr> 728<tr> 729<td align="left">is_alpha</td> 730<td align="left">Recognize letters</td> 731<td align="left"> 732 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_alpha.html" title="Function is_alpha">is_alpha()</a></code> 733 </td> 734</tr> 735<tr> 736<td align="left">is_cntrl</td> 737<td align="left">Recognize control characters</td> 738<td align="left"> 739 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_cntrl.html" title="Function is_cntrl">is_cntrl()</a></code> 740 </td> 741</tr> 742<tr> 743<td align="left">is_digit</td> 744<td align="left">Recognize decimal digits</td> 745<td align="left"> 746 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_digit.html" title="Function is_digit">is_digit()</a></code> 747 </td> 748</tr> 749<tr> 750<td align="left">is_graph</td> 751<td align="left">Recognize graphical characters</td> 752<td align="left"> 753 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_graph.html" title="Function is_graph">is_graph()</a></code> 754 </td> 755</tr> 756<tr> 757<td align="left">is_lower</td> 758<td align="left">Recognize lower case characters</td> 759<td align="left"> 760 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_lower.html" title="Function is_lower">is_lower()</a></code> 761 </td> 762</tr> 763<tr> 764<td align="left">is_print</td> 765<td align="left">Recognize printable characters</td> 766<td align="left"> 767 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_print.html" title="Function is_print">is_print()</a></code> 768 </td> 769</tr> 770<tr> 771<td align="left">is_punct</td> 772<td align="left">Recognize punctuation characters</td> 773<td align="left"> 774 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_punct.html" title="Function is_punct">is_punct()</a></code> 775 </td> 776</tr> 777<tr> 778<td align="left">is_upper</td> 779<td align="left">Recognize uppercase characters</td> 780<td align="left"> 781 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_upper.html" title="Function is_upper">is_upper()</a></code> 782 </td> 783</tr> 784<tr> 785<td align="left">is_xdigit</td> 786<td align="left">Recognize hexadecimal digits</td> 787<td align="left"> 788 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_xdigit.html" title="Function is_xdigit">is_xdigit()</a></code> 789 </td> 790</tr> 791<tr> 792<td align="left">is_any_of</td> 793<td align="left">Recognize any of a sequence of characters</td> 794<td align="left"> 795 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_any_of.html" title="Function template is_any_of">is_any_of()</a></code> 796 </td> 797</tr> 798<tr> 799<td align="left">is_from_range</td> 800<td align="left">Recognize characters inside a min..max range</td> 801<td align="left"> 802 <code class="computeroutput"><a class="link" href="../boost/algorithm/is_from_range.html" title="Function template is_from_range">is_from_range()</a></code> 803 </td> 804</tr> 805</tbody> 806</table></div> 807</div> 808<br class="table-break"> 809</div> 810</div> 811<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 812<td align="left"></td> 813<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost 814 Software License, Version 1.0. (See accompanying file 815 <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 816 </p> 817</div></td> 818</tr></table> 819<hr> 820<div class="spirit-nav"> 821<a accesskey="p" href="usage.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../string_algo.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="design.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 822</div> 823</body> 824</html> 825
