1<?xml version="1.0" standalone="yes"?> 2<library-reference><header name="boost/algorithm/string.hpp"> 3<para>Cumulative include for string_algo library </para></header> 4<header name="boost/algorithm/string/case_conv.hpp"> 5<para>Defines sequence case-conversion algorithms. Algorithms convert each element in the input sequence to the desired case using provided locales. </para><namespace name="boost"> 6<namespace name="algorithm"> 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24<overloaded-function name="to_lower_copy"><signature><type>OutputIteratorT</type><template> 25 <template-type-parameter name="OutputIteratorT"/> 26 <template-type-parameter name="RangeT"/> 27 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input range </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for conversion </para></description></parameter></signature><signature><type>SequenceT</type><template> 28 <template-type-parameter name="SequenceT"/> 29 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Convert to lower case. </purpose><description><para>Each element of the input sequence is converted to lower case. The result is a copy of the input converted to lower case. It is returned as a sequence or copied to the output iterator.</para><para> 30 31<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 32</note> 33</para></description><returns><para>An output iterator pointing just after the last inserted character or a copy of the input</para> 34</returns></overloaded-function> 35 36<function name="to_lower"><type>void</type><template> 37 <template-type-parameter name="WritableRangeT"/> 38 </template><parameter name="Input"><paramtype>WritableRangeT &</paramtype><description><para>A range </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>a locale used for conversion </para></description></parameter><purpose>Convert to lower case. </purpose><description><para>Each element of the input sequence is converted to lower case. The input sequence is modified in-place.</para><para> 39</para></description></function> 40<overloaded-function name="to_upper_copy"><signature><type>OutputIteratorT</type><template> 41 <template-type-parameter name="OutputIteratorT"/> 42 <template-type-parameter name="RangeT"/> 43 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input range </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for conversion </para></description></parameter></signature><signature><type>SequenceT</type><template> 44 <template-type-parameter name="SequenceT"/> 45 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Convert to upper case. </purpose><description><para>Each element of the input sequence is converted to upper case. The result is a copy of the input converted to upper case. It is returned as a sequence or copied to the output iterator</para><para> 46 47<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 48</note> 49</para></description><returns><para>An output iterator pointing just after the last inserted character or a copy of the input</para> 50</returns></overloaded-function> 51 52<function name="to_upper"><type>void</type><template> 53 <template-type-parameter name="WritableRangeT"/> 54 </template><parameter name="Input"><paramtype>WritableRangeT &</paramtype><description><para>An input range </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>a locale used for conversion </para></description></parameter><purpose>Convert to upper case. </purpose><description><para>Each element of the input sequence is converted to upper case. The input sequence is modified in-place.</para><para> 55</para></description></function> 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219</namespace> 220</namespace> 221</header> 222<header name="boost/algorithm/string/classification.hpp"> 223<para>Classification predicates are included in the library to give some more convenience when using algorithms like <computeroutput>trim()</computeroutput> and <computeroutput>all()</computeroutput>. They wrap functionality of STL classification functions ( e.g. <computeroutput>std::isspace()</computeroutput> ) into generic functors. </para><namespace name="boost"> 224<namespace name="algorithm"> 225<function name="is_classified"><type><emphasis>unspecified</emphasis></type><parameter name="Type"><paramtype>std::ctype_base::mask</paramtype><description><para>A <computeroutput>std::ctype</computeroutput> category </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_classified predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate. This predicate holds if the input is of specified <computeroutput>std::ctype</computeroutput> category.</para><para> 226 227</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 228</returns></function> 229<function name="is_space"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_space predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::space</computeroutput> category.</para><para> 230 231</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 232</returns></function> 233<function name="is_alnum"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_alnum predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::alnum</computeroutput> category.</para><para> 234 235</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 236</returns></function> 237<function name="is_alpha"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_alpha predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::alpha</computeroutput> category.</para><para> 238 239</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 240</returns></function> 241<function name="is_cntrl"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_cntrl predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::cntrl</computeroutput> category.</para><para> 242 243</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 244</returns></function> 245<function name="is_digit"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_digit predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::digit</computeroutput> category.</para><para> 246 247</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 248</returns></function> 249<function name="is_graph"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_graph predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::graph</computeroutput> category.</para><para> 250 251</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 252</returns></function> 253<function name="is_lower"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_lower predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::lower</computeroutput> category.</para><para> 254 255</para></description><returns><para>An instance of <computeroutput>is_classified</computeroutput> predicate </para> 256</returns></function> 257<function name="is_print"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_print predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::print</computeroutput> category.</para><para> 258 259</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 260</returns></function> 261<function name="is_punct"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_punct predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::punct</computeroutput> category.</para><para> 262 263</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 264</returns></function> 265<function name="is_upper"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_upper predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::upper</computeroutput> category.</para><para> 266 267</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 268</returns></function> 269<function name="is_xdigit"><type><emphasis>unspecified</emphasis></type><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for classification </para></description></parameter><purpose>is_xdigit predicate </purpose><description><para>Construct the <computeroutput>is_classified</computeroutput> predicate for the <computeroutput>ctype_base::xdigit</computeroutput> category.</para><para> 270 271</para></description><returns><para>An instance of the <computeroutput>is_classified</computeroutput> predicate </para> 272</returns></function> 273<function name="is_any_of"><type><emphasis>unspecified</emphasis></type><template> 274 <template-type-parameter name="RangeT"/> 275 </template><parameter name="Set"><paramtype>const RangeT &</paramtype><description><para>A set of characters to be recognized </para></description></parameter><purpose>is_any_of predicate </purpose><description><para>Construct the <computeroutput>is_any_of</computeroutput> predicate. The predicate holds if the input is included in the specified set of characters.</para><para> 276 277</para></description><returns><para>An instance of the <computeroutput>is_any_of</computeroutput> predicate </para> 278</returns></function> 279<function name="is_from_range"><type><emphasis>unspecified</emphasis></type><template> 280 <template-type-parameter name="CharT"/> 281 </template><parameter name="From"><paramtype>CharT</paramtype><description><para>The start of the range </para></description></parameter><parameter name="To"><paramtype>CharT</paramtype><description><para>The end of the range </para></description></parameter><purpose>is_from_range predicate </purpose><description><para>Construct the <computeroutput>is_from_range</computeroutput> predicate. The predicate holds if the input is included in the specified range. (i.e. From <= Ch <= To )</para><para> 282 283</para></description><returns><para>An instance of the <computeroutput>is_from_range</computeroutput> predicate </para> 284</returns></function> 285<function name="operator&&"><type><emphasis>unspecified</emphasis></type><template> 286 <template-type-parameter name="Pred1T"/> 287 <template-type-parameter name="Pred2T"/> 288 </template><parameter name="Pred1"><paramtype>const predicate_facade< Pred1T > &</paramtype><description><para>The first predicate </para></description></parameter><parameter name="Pred2"><paramtype>const predicate_facade< Pred2T > &</paramtype><description><para>The second predicate </para></description></parameter><purpose>predicate 'and' composition predicate </purpose><description><para>Construct the <computeroutput>class_and</computeroutput> predicate. This predicate can be used to logically combine two classification predicates. <computeroutput>class_and</computeroutput> holds, if both predicates return true.</para><para> 289 290</para></description><returns><para>An instance of the <computeroutput>class_and</computeroutput> predicate </para> 291</returns></function> 292<function name="operator||"><type><emphasis>unspecified</emphasis></type><template> 293 <template-type-parameter name="Pred1T"/> 294 <template-type-parameter name="Pred2T"/> 295 </template><parameter name="Pred1"><paramtype>const predicate_facade< Pred1T > &</paramtype><description><para>The first predicate </para></description></parameter><parameter name="Pred2"><paramtype>const predicate_facade< Pred2T > &</paramtype><description><para>The second predicate </para></description></parameter><purpose>predicate 'or' composition predicate </purpose><description><para>Construct the <computeroutput>class_or</computeroutput> predicate. This predicate can be used to logically combine two classification predicates. <computeroutput>class_or</computeroutput> holds, if one of the predicates return true.</para><para> 296 297</para></description><returns><para>An instance of the <computeroutput>class_or</computeroutput> predicate </para> 298</returns></function> 299<function name="operator!"><type><emphasis>unspecified</emphasis></type><template> 300 <template-type-parameter name="PredT"/> 301 </template><parameter name="Pred"><paramtype>const predicate_facade< PredT > &</paramtype><description><para>The predicate to be negated </para></description></parameter><purpose>predicate negation operator </purpose><description><para>Construct the <computeroutput>class_not</computeroutput> predicate. This predicate represents a negation. <computeroutput>class_or</computeroutput> holds if of the predicates return false.</para><para> 302 303</para></description><returns><para>An instance of the <computeroutput>class_not</computeroutput> predicate </para> 304</returns></function> 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474</namespace> 475</namespace> 476</header> 477<header name="boost/algorithm/string/compare.hpp"> 478<para>Defines element comparison predicates. Many algorithms in this library can take an additional argument with a predicate used to compare elements. This makes it possible, for instance, to have case insensitive versions of the algorithms. </para><namespace name="boost"> 479<namespace name="algorithm"> 480<struct name="is_equal"><purpose><classname alt="boost::algorithm::is_equal">is_equal</classname> functor </purpose><description><para>Standard STL equal_to only handle comparison between arguments of the same type. This is a less restrictive version which wraps operator ==. </para></description><method-group name="public member functions"> 481<method name="operator()" cv="const"><type>bool</type><template> 482 <template-type-parameter name="T1"/> 483 <template-type-parameter name="T2"/> 484 </template><parameter name="Arg1"><paramtype>const T1 &</paramtype></parameter><parameter name="Arg2"><paramtype>const T2 &</paramtype></parameter><purpose>Function operator. </purpose><description><para>Compare two operands for equality </para></description></method> 485</method-group> 486</struct><struct name="is_iequal"><purpose>case insensitive version of <classname alt="boost::algorithm::is_equal">is_equal</classname> </purpose><description><para>Case insensitive comparison predicate. Comparison is done using specified locales. </para></description><method-group name="public member functions"> 487<method name="operator()" cv="const"><type>bool</type><template> 488 <template-type-parameter name="T1"/> 489 <template-type-parameter name="T2"/> 490 </template><parameter name="Arg1"><paramtype>const T1 &</paramtype></parameter><parameter name="Arg2"><paramtype>const T2 &</paramtype></parameter><purpose>Function operator. </purpose><description><para>Compare two operands. Case is ignored. </para></description></method> 491</method-group> 492<constructor><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>locales used for comparison </para></description></parameter><purpose>Constructor. </purpose><description><para> 493</para></description></constructor> 494</struct><struct name="is_iless"><purpose>case insensitive version of <classname alt="boost::algorithm::is_less">is_less</classname> </purpose><description><para>Case insensitive comparison predicate. Comparison is done using specified locales. </para></description><method-group name="public member functions"> 495<method name="operator()" cv="const"><type>bool</type><template> 496 <template-type-parameter name="T1"/> 497 <template-type-parameter name="T2"/> 498 </template><parameter name="Arg1"><paramtype>const T1 &</paramtype></parameter><parameter name="Arg2"><paramtype>const T2 &</paramtype></parameter><purpose>Function operator. </purpose><description><para>Compare two operands. Case is ignored. </para></description></method> 499</method-group> 500<constructor><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>locales used for comparison </para></description></parameter><purpose>Constructor. </purpose><description><para> 501</para></description></constructor> 502</struct><struct name="is_less"><purpose><classname alt="boost::algorithm::is_less">is_less</classname> functor </purpose><description><para>Convenient version of standard std::less. Operation is templated, therefore it is not required to specify the exact types upon the construction </para></description><method-group name="public member functions"> 503<method name="operator()" cv="const"><type>bool</type><template> 504 <template-type-parameter name="T1"/> 505 <template-type-parameter name="T2"/> 506 </template><parameter name="Arg1"><paramtype>const T1 &</paramtype></parameter><parameter name="Arg2"><paramtype>const T2 &</paramtype></parameter><purpose>Functor operation. </purpose><description><para>Compare two operands using > operator </para></description></method> 507</method-group> 508</struct><struct name="is_not_greater"><purpose><classname alt="boost::algorithm::is_not_greater">is_not_greater</classname> functor </purpose><description><para>Convenient version of standard std::not_greater_to. Operation is templated, therefore it is not required to specify the exact types upon the construction </para></description><method-group name="public member functions"> 509<method name="operator()" cv="const"><type>bool</type><template> 510 <template-type-parameter name="T1"/> 511 <template-type-parameter name="T2"/> 512 </template><parameter name="Arg1"><paramtype>const T1 &</paramtype></parameter><parameter name="Arg2"><paramtype>const T2 &</paramtype></parameter><purpose>Functor operation. </purpose><description><para>Compare two operands using > operator </para></description></method> 513</method-group> 514</struct><struct name="is_not_igreater"><purpose>case insensitive version of <classname alt="boost::algorithm::is_not_greater">is_not_greater</classname> </purpose><description><para>Case insensitive comparison predicate. Comparison is done using specified locales. </para></description><method-group name="public member functions"> 515<method name="operator()" cv="const"><type>bool</type><template> 516 <template-type-parameter name="T1"/> 517 <template-type-parameter name="T2"/> 518 </template><parameter name="Arg1"><paramtype>const T1 &</paramtype></parameter><parameter name="Arg2"><paramtype>const T2 &</paramtype></parameter><purpose>Function operator. </purpose><description><para>Compare two operands. Case is ignored. </para></description></method> 519</method-group> 520<constructor><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>locales used for comparison </para></description></parameter><purpose>Constructor. </purpose><description><para> 521</para></description></constructor> 522</struct> 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708</namespace> 709</namespace> 710</header> 711<header name="boost/algorithm/string/concept.hpp"> 712<para>Defines concepts used in string_algo library </para><namespace name="boost"> 713<namespace name="algorithm"> 714<struct name="FinderConcept"><template> 715 <template-type-parameter name="FinderT"/> 716 <template-type-parameter name="IteratorT"/> 717 </template><purpose>Finder concept. </purpose><description><para>Defines the Finder concept. Finder is a functor which selects an arbitrary part of a string. Search is performed on the range specified by starting and ending iterators.</para><para>Result of the find operation must be convertible to iterator_range. </para></description><method-group name="public member functions"> 718<method name="constraints"><type>void</type></method> 719</method-group> 720</struct><struct name="FormatterConcept"><template> 721 <template-type-parameter name="FormatterT"/> 722 <template-type-parameter name="FinderT"/> 723 <template-type-parameter name="IteratorT"/> 724 </template><purpose>Formatter concept. </purpose><description><para>Defines the Formatter concept. Formatter is a functor, which takes a result from a finder operation and transforms it in a specific way.</para><para>Result must be a container supported by container_traits, or a reference to it. </para></description><method-group name="public member functions"> 725<method name="constraints"><type>void</type></method> 726</method-group> 727</struct> 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913</namespace> 914</namespace> 915</header> 916<header name="boost/algorithm/string/constants.hpp"> 917<namespace name="boost"> 918<namespace name="algorithm"> 919<enum name="token_compress_mode_type"><enumvalue name="token_compress_on"><purpose>Compress adjacent tokens. </purpose></enumvalue><enumvalue name="token_compress_off"><purpose>Do not compress adjacent tokens. </purpose></enumvalue><purpose>Token compression mode. </purpose><description><para>Specifies token compression mode for the token_finder. </para></description></enum> 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106</namespace> 1107</namespace> 1108</header> 1109<header name="boost/algorithm/string/erase.hpp"> 1110<para>Defines various erase algorithms. Each algorithm removes part(s) of the input according to a searching criteria. </para><namespace name="boost"> 1111<namespace name="algorithm"> 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194<overloaded-function name="erase_range_copy"><signature><type>OutputIteratorT</type><template> 1195 <template-type-parameter name="OutputIteratorT"/> 1196 <template-type-parameter name="RangeT"/> 1197 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="SearchRange"><paramtype>const iterator_range< typename range_const_iterator< RangeT >::type > &</paramtype><description><para>A range in the input to be removed </para></description></parameter></signature><signature><type>SequenceT</type><template> 1198 <template-type-parameter name="SequenceT"/> 1199 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="SearchRange"><paramtype>const iterator_range< typename range_const_iterator< SequenceT >::type > &</paramtype></parameter></signature><purpose>Erase range algorithm. </purpose><description><para>Remove the given range from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1200 1201<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1202</note> 1203</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1204</returns></overloaded-function> 1205 1206<function name="erase_range"><type>void</type><template> 1207 <template-type-parameter name="SequenceT"/> 1208 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="SearchRange"><paramtype>const iterator_range< typename range_iterator< SequenceT >::type > &</paramtype><description><para>A range in the input to be removed </para></description></parameter><purpose>Erase range algorithm. </purpose><description><para>Remove the given range from the input. The input sequence is modified in-place.</para><para> 1209</para></description></function> 1210<overloaded-function name="erase_first_copy"><signature><type>OutputIteratorT</type><template> 1211 <template-type-parameter name="OutputIteratorT"/> 1212 <template-type-parameter name="Range1T"/> 1213 <template-type-parameter name="Range2T"/> 1214 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter></signature><signature><type>SequenceT</type><template> 1215 <template-type-parameter name="SequenceT"/> 1216 <template-type-parameter name="RangeT"/> 1217 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter></signature><purpose>Erase first algorithm. </purpose><description><para>Remove the first occurrence of the substring from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1218 1219<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1220</note> 1221</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1222</returns></overloaded-function> 1223 1224<function name="erase_first"><type>void</type><template> 1225 <template-type-parameter name="SequenceT"/> 1226 <template-type-parameter name="RangeT"/> 1227 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter><purpose>Erase first algorithm. </purpose><description><para>Remove the first occurrence of the substring from the input. The input sequence is modified in-place.</para><para> 1228</para></description></function> 1229<overloaded-function name="ierase_first_copy"><signature><type>OutputIteratorT</type><template> 1230 <template-type-parameter name="OutputIteratorT"/> 1231 <template-type-parameter name="Range1T"/> 1232 <template-type-parameter name="Range2T"/> 1233 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 1234 <template-type-parameter name="SequenceT"/> 1235 <template-type-parameter name="RangeT"/> 1236 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Erase first algorithm ( case insensitive ) </purpose><description><para>Remove the first occurrence of the substring from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 1237 1238<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1239</note> 1240</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1241</returns></overloaded-function> 1242 1243<function name="ierase_first"><type>void</type><template> 1244 <template-type-parameter name="SequenceT"/> 1245 <template-type-parameter name="RangeT"/> 1246 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Erase first algorithm ( case insensitive ) </purpose><description><para>Remove the first occurrence of the substring from the input. The input sequence is modified in-place. Searching is case insensitive.</para><para> 1247</para></description></function> 1248<overloaded-function name="erase_last_copy"><signature><type>OutputIteratorT</type><template> 1249 <template-type-parameter name="OutputIteratorT"/> 1250 <template-type-parameter name="Range1T"/> 1251 <template-type-parameter name="Range2T"/> 1252 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter></signature><signature><type>SequenceT</type><template> 1253 <template-type-parameter name="SequenceT"/> 1254 <template-type-parameter name="RangeT"/> 1255 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter></signature><purpose>Erase last algorithm. </purpose><description><para>Remove the last occurrence of the substring from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1256 1257<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1258</note> 1259</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1260</returns></overloaded-function> 1261 1262<function name="erase_last"><type>void</type><template> 1263 <template-type-parameter name="SequenceT"/> 1264 <template-type-parameter name="RangeT"/> 1265 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for </para></description></parameter><purpose>Erase last algorithm. </purpose><description><para>Remove the last occurrence of the substring from the input. The input sequence is modified in-place.</para><para> 1266</para></description></function> 1267<overloaded-function name="ierase_last_copy"><signature><type>OutputIteratorT</type><template> 1268 <template-type-parameter name="OutputIteratorT"/> 1269 <template-type-parameter name="Range1T"/> 1270 <template-type-parameter name="Range2T"/> 1271 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 1272 <template-type-parameter name="SequenceT"/> 1273 <template-type-parameter name="RangeT"/> 1274 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Erase last algorithm ( case insensitive ) </purpose><description><para>Remove the last occurrence of the substring from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 1275 1276<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1277</note> 1278</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1279</returns></overloaded-function> 1280 1281<function name="ierase_last"><type>void</type><template> 1282 <template-type-parameter name="SequenceT"/> 1283 <template-type-parameter name="RangeT"/> 1284 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Erase last algorithm ( case insensitive ) </purpose><description><para>Remove the last occurrence of the substring from the input. The input sequence is modified in-place. Searching is case insensitive.</para><para> 1285</para></description></function> 1286<overloaded-function name="erase_nth_copy"><signature><type>OutputIteratorT</type><template> 1287 <template-type-parameter name="OutputIteratorT"/> 1288 <template-type-parameter name="Range1T"/> 1289 <template-type-parameter name="Range2T"/> 1290 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter></signature><signature><type>SequenceT</type><template> 1291 <template-type-parameter name="SequenceT"/> 1292 <template-type-parameter name="RangeT"/> 1293 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Nth"><paramtype>int</paramtype></parameter></signature><purpose>Erase nth algorithm. </purpose><description><para>Remove the Nth occurrence of the substring in the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1294 1295<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1296</note> 1297</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1298</returns></overloaded-function> 1299 1300<function name="erase_nth"><type>void</type><template> 1301 <template-type-parameter name="SequenceT"/> 1302 <template-type-parameter name="RangeT"/> 1303 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><purpose>Erase nth algorithm. </purpose><description><para>Remove the Nth occurrence of the substring in the input. The input sequence is modified in-place.</para><para> 1304</para></description></function> 1305<overloaded-function name="ierase_nth_copy"><signature><type>OutputIteratorT</type><template> 1306 <template-type-parameter name="OutputIteratorT"/> 1307 <template-type-parameter name="Range1T"/> 1308 <template-type-parameter name="Range2T"/> 1309 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 1310 <template-type-parameter name="SequenceT"/> 1311 <template-type-parameter name="RangeT"/> 1312 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Nth"><paramtype>int</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Erase nth algorithm ( case insensitive ) </purpose><description><para>Remove the Nth occurrence of the substring in the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 1313 1314<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1315</note> 1316</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1317</returns></overloaded-function> 1318 1319<function name="ierase_nth"><type>void</type><template> 1320 <template-type-parameter name="SequenceT"/> 1321 <template-type-parameter name="RangeT"/> 1322 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Erase nth algorithm. </purpose><description><para>Remove the Nth occurrence of the substring in the input. The input sequence is modified in-place. Searching is case insensitive.</para><para> 1323</para></description></function> 1324<overloaded-function name="erase_all_copy"><signature><type>OutputIteratorT</type><template> 1325 <template-type-parameter name="OutputIteratorT"/> 1326 <template-type-parameter name="Range1T"/> 1327 <template-type-parameter name="Range2T"/> 1328 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter></signature><signature><type>SequenceT</type><template> 1329 <template-type-parameter name="SequenceT"/> 1330 <template-type-parameter name="RangeT"/> 1331 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter></signature><purpose>Erase all algorithm. </purpose><description><para>Remove all the occurrences of the string from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1332 1333<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1334</note> 1335</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1336</returns></overloaded-function> 1337 1338<function name="erase_all"><type>void</type><template> 1339 <template-type-parameter name="SequenceT"/> 1340 <template-type-parameter name="RangeT"/> 1341 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter><purpose>Erase all algorithm. </purpose><description><para>Remove all the occurrences of the string from the input. The input sequence is modified in-place.</para><para> 1342</para></description></function> 1343<overloaded-function name="ierase_all_copy"><signature><type>OutputIteratorT</type><template> 1344 <template-type-parameter name="OutputIteratorT"/> 1345 <template-type-parameter name="Range1T"/> 1346 <template-type-parameter name="Range2T"/> 1347 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 1348 <template-type-parameter name="SequenceT"/> 1349 <template-type-parameter name="RangeT"/> 1350 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Erase all algorithm ( case insensitive ) </purpose><description><para>Remove all the occurrences of the string from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 1351 1352<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1353</note> 1354</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1355</returns></overloaded-function> 1356 1357<function name="ierase_all"><type>void</type><template> 1358 <template-type-parameter name="SequenceT"/> 1359 <template-type-parameter name="RangeT"/> 1360 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Erase all algorithm ( case insensitive ) </purpose><description><para>Remove all the occurrences of the string from the input. The input sequence is modified in-place. Searching is case insensitive.</para><para> 1361</para></description></function> 1362<overloaded-function name="erase_head_copy"><signature><type>OutputIteratorT</type><template> 1363 <template-type-parameter name="OutputIteratorT"/> 1364 <template-type-parameter name="RangeT"/> 1365 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the head. For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter></signature><signature><type>SequenceT</type><template> 1366 <template-type-parameter name="SequenceT"/> 1367 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="N"><paramtype>int</paramtype></parameter></signature><purpose>Erase head algorithm. </purpose><description><para>Remove the head from the input. The head is a prefix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the head. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1368 1369<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1370</note> 1371</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1372</returns></overloaded-function> 1373 1374<function name="erase_head"><type>void</type><template> 1375 <template-type-parameter name="SequenceT"/> 1376 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the head For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter><purpose>Erase head algorithm. </purpose><description><para>Remove the head from the input. The head is a prefix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the head. The input sequence is modified in-place.</para><para> 1377</para></description></function> 1378<overloaded-function name="erase_tail_copy"><signature><type>OutputIteratorT</type><template> 1379 <template-type-parameter name="OutputIteratorT"/> 1380 <template-type-parameter name="RangeT"/> 1381 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the tail.</para></description></parameter></signature><signature><type>SequenceT</type><template> 1382 <template-type-parameter name="SequenceT"/> 1383 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="N"><paramtype>int</paramtype></parameter></signature><purpose>Erase tail algorithm. </purpose><description><para>Remove the tail from the input. The tail is a suffix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the tail. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1384For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. 1385<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1386</note> 1387</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1388</returns></overloaded-function> 1389 1390<function name="erase_tail"><type>void</type><template> 1391 <template-type-parameter name="SequenceT"/> 1392 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the tail For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter><purpose>Erase tail algorithm. </purpose><description><para>Remove the tail from the input. The tail is a suffix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the tail. The input sequence is modified in-place.</para><para> 1393</para></description></function> 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465</namespace> 1466</namespace> 1467</header> 1468<header name="boost/algorithm/string/find.hpp"> 1469<para>Defines a set of find algorithms. The algorithms are searching for a substring of the input. The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the substring. </para><namespace name="boost"> 1470<namespace name="algorithm"> 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494<function name="find"><type>iterator_range< typename range_iterator< RangeT >::type ></type><template> 1495 <template-type-parameter name="RangeT"/> 1496 <template-type-parameter name="FinderT"/> 1497 </template><parameter name="Input"><paramtype>RangeT &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Finder"><paramtype>const FinderT &</paramtype><description><para>Finder object used for searching. </para></description></parameter><purpose>Generic find algorithm. </purpose><description><para>Search the input using the given finder.</para><para> 1498 1499</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>RangeT::iterator</computeroutput> or <computeroutput>RangeT::const_iterator</computeroutput>, depending on the constness of the input parameter. </para> 1500</returns></function> 1501<function name="find_first"><type>iterator_range< typename range_iterator< Range1T >::type ></type><template> 1502 <template-type-parameter name="Range1T"/> 1503 <template-type-parameter name="Range2T"/> 1504 </template><parameter name="Input"><paramtype>Range1T &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><purpose>Find first algorithm. </purpose><description><para>Search for the first occurrence of the substring in the input.</para><para> 1505 1506<note><para>This function provides the strong exception-safety guarantee </para> 1507</note> 1508</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>RangeT::iterator</computeroutput> or <computeroutput>RangeT::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1509</returns></function> 1510<function name="ifind_first"><type>iterator_range< typename range_iterator< Range1T >::type ></type><template> 1511 <template-type-parameter name="Range1T"/> 1512 <template-type-parameter name="Range2T"/> 1513 </template><parameter name="Input"><paramtype>Range1T &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Find first algorithm ( case insensitive ) </purpose><description><para>Search for the first occurrence of the substring in the input. Searching is case insensitive.</para><para> 1514 1515<note><para>This function provides the strong exception-safety guarantee </para> 1516</note> 1517</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>Range1T::iterator</computeroutput> or <computeroutput>Range1T::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1518</returns></function> 1519<function name="find_last"><type>iterator_range< typename range_iterator< Range1T >::type ></type><template> 1520 <template-type-parameter name="Range1T"/> 1521 <template-type-parameter name="Range2T"/> 1522 </template><parameter name="Input"><paramtype>Range1T &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><purpose>Find last algorithm. </purpose><description><para>Search for the last occurrence of the substring in the input.</para><para> 1523 1524<note><para>This function provides the strong exception-safety guarantee </para> 1525</note> 1526</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>Range1T::iterator</computeroutput> or <computeroutput>Range1T::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1527</returns></function> 1528<function name="ifind_last"><type>iterator_range< typename range_iterator< Range1T >::type ></type><template> 1529 <template-type-parameter name="Range1T"/> 1530 <template-type-parameter name="Range2T"/> 1531 </template><parameter name="Input"><paramtype>Range1T &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Find last algorithm ( case insensitive ) </purpose><description><para>Search for the last match a string in the input. Searching is case insensitive.</para><para> 1532 1533<note><para>This function provides the strong exception-safety guarantee </para> 1534</note> 1535</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>Range1T::iterator</computeroutput> or <computeroutput>Range1T::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1536</returns></function> 1537<function name="find_nth"><type>iterator_range< typename range_iterator< Range1T >::type ></type><template> 1538 <template-type-parameter name="Range1T"/> 1539 <template-type-parameter name="Range2T"/> 1540 </template><parameter name="Input"><paramtype>Range1T &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index (zero-indexed) of the match to be found. For negative N, the matches are counted from the end of string. </para></description></parameter><purpose>Find n-th algorithm. </purpose><description><para>Search for the n-th (zero-indexed) occurrence of the substring in the input.</para><para> 1541 1542</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>Range1T::iterator</computeroutput> or <computeroutput>Range1T::const_iterator</computeroutput>, depending on the constness of the input parameter. </para> 1543</returns></function> 1544<function name="ifind_nth"><type>iterator_range< typename range_iterator< Range1T >::type ></type><template> 1545 <template-type-parameter name="Range1T"/> 1546 <template-type-parameter name="Range2T"/> 1547 </template><parameter name="Input"><paramtype>Range1T &</paramtype><description><para>A string which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index (zero-indexed) of the match to be found. For negative N, the matches are counted from the end of string. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Find n-th algorithm ( case insensitive ). </purpose><description><para>Search for the n-th (zero-indexed) occurrence of the substring in the input. Searching is case insensitive.</para><para> 1548 1549<note><para>This function provides the strong exception-safety guarantee </para> 1550</note> 1551</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>Range1T::iterator</computeroutput> or <computeroutput>Range1T::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1552</returns></function> 1553<function name="find_head"><type>iterator_range< typename range_iterator< RangeT >::type ></type><template> 1554 <template-type-parameter name="RangeT"/> 1555 </template><parameter name="Input"><paramtype>RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the head For N>=0, at most N characters are extracted. For N<0, at most size(Input)-|N| characters are extracted. </para></description></parameter><purpose>Find head algorithm. </purpose><description><para>Get the head of the input. Head is a prefix of the string of the given size. If the input is shorter then required, whole input is considered to be the head.</para><para> 1556 1557<note><para>This function provides the strong exception-safety guarantee </para> 1558</note> 1559</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>Range1T::iterator</computeroutput> or <computeroutput>Range1T::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1560</returns></function> 1561<function name="find_tail"><type>iterator_range< typename range_iterator< RangeT >::type ></type><template> 1562 <template-type-parameter name="RangeT"/> 1563 </template><parameter name="Input"><paramtype>RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the tail. For N>=0, at most N characters are extracted. For N<0, at most size(Input)-|N| characters are extracted. </para></description></parameter><purpose>Find tail algorithm. </purpose><description><para>Get the tail of the input. Tail is a suffix of the string of the given size. If the input is shorter then required, whole input is considered to be the tail.</para><para> 1564 1565<note><para>This function provides the strong exception-safety guarantee </para> 1566</note> 1567</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>RangeT::iterator</computeroutput> or <computeroutput>RangeT::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1568</returns></function> 1569<function name="find_token"><type>iterator_range< typename range_iterator< RangeT >::type ></type><template> 1570 <template-type-parameter name="RangeT"/> 1571 <template-type-parameter name="PredicateT"/> 1572 </template><parameter name="Input"><paramtype>RangeT &</paramtype><description><para>A input string. </para></description></parameter><parameter name="Pred"><paramtype>PredicateT</paramtype><description><para>A unary predicate to identify a token </para></description></parameter><parameter name="eCompress"><paramtype>token_compress_mode_type</paramtype><default>token_compress_off</default><description><para>Enable/Disable compressing of adjacent tokens </para></description></parameter><purpose>Find token algorithm. </purpose><description><para>Look for a given token in the string. Token is a character that matches the given predicate. If the "token compress mode" is enabled, adjacent tokens are considered to be one match.</para><para> 1573 1574<note><para>This function provides the strong exception-safety guarantee </para> 1575</note> 1576</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>RangeT::iterator</computeroutput> or <computeroutput>RangeT::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 1577</returns></function> 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731</namespace> 1732</namespace> 1733</header> 1734<header name="boost/algorithm/string/find_format.hpp"> 1735<para>Defines generic replace algorithms. Each algorithm replaces part(s) of the input. The part to be replaced is looked up using a Finder object. Result of finding is then used by a Formatter object to generate the replacement. </para><namespace name="boost"> 1736<namespace name="algorithm"> 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887<overloaded-function name="find_format_copy"><signature><type>OutputIteratorT</type><template> 1888 <template-type-parameter name="OutputIteratorT"/> 1889 <template-type-parameter name="RangeT"/> 1890 <template-type-parameter name="FinderT"/> 1891 <template-type-parameter name="FormatterT"/> 1892 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Finder"><paramtype>FinderT</paramtype><description><para>A Finder object used to search for a match to be replaced </para></description></parameter><parameter name="Formatter"><paramtype>FormatterT</paramtype><description><para>A Formatter object used to format a match </para></description></parameter></signature><signature><type>SequenceT</type><template> 1893 <template-type-parameter name="SequenceT"/> 1894 <template-type-parameter name="FinderT"/> 1895 <template-type-parameter name="FormatterT"/> 1896 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><parameter name="Formatter"><paramtype>FormatterT</paramtype></parameter></signature><purpose>Generic replace algorithm. </purpose><description><para>Use the Finder to search for a substring. Use the Formatter to format this substring and replace it in the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1897 1898<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1899</note> 1900</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1901</returns></overloaded-function> 1902 1903<function name="find_format"><type>void</type><template> 1904 <template-type-parameter name="SequenceT"/> 1905 <template-type-parameter name="FinderT"/> 1906 <template-type-parameter name="FormatterT"/> 1907 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Finder"><paramtype>FinderT</paramtype><description><para>A Finder object used to search for a match to be replaced </para></description></parameter><parameter name="Formatter"><paramtype>FormatterT</paramtype><description><para>A Formatter object used to format a match </para></description></parameter><purpose>Generic replace algorithm. </purpose><description><para>Use the Finder to search for a substring. Use the Formatter to format this substring and replace it in the input. The input is modified in-place.</para><para> 1908</para></description></function> 1909<overloaded-function name="find_format_all_copy"><signature><type>OutputIteratorT</type><template> 1910 <template-type-parameter name="OutputIteratorT"/> 1911 <template-type-parameter name="RangeT"/> 1912 <template-type-parameter name="FinderT"/> 1913 <template-type-parameter name="FormatterT"/> 1914 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Finder"><paramtype>FinderT</paramtype><description><para>A Finder object used to search for a match to be replaced </para></description></parameter><parameter name="Formatter"><paramtype>FormatterT</paramtype><description><para>A Formatter object used to format a match </para></description></parameter></signature><signature><type>SequenceT</type><template> 1915 <template-type-parameter name="SequenceT"/> 1916 <template-type-parameter name="FinderT"/> 1917 <template-type-parameter name="FormatterT"/> 1918 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><parameter name="Formatter"><paramtype>FormatterT</paramtype></parameter></signature><purpose>Generic replace all algorithm. </purpose><description><para>Use the Finder to search for a substring. Use the Formatter to format this substring and replace it in the input. Repeat this for all matching substrings. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 1919 1920<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 1921</note> 1922</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 1923</returns></overloaded-function> 1924 1925<function name="find_format_all"><type>void</type><template> 1926 <template-type-parameter name="SequenceT"/> 1927 <template-type-parameter name="FinderT"/> 1928 <template-type-parameter name="FormatterT"/> 1929 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Finder"><paramtype>FinderT</paramtype><description><para>A Finder object used to search for a match to be replaced </para></description></parameter><parameter name="Formatter"><paramtype>FormatterT</paramtype><description><para>A Formatter object used to format a match </para></description></parameter><purpose>Generic replace all algorithm. </purpose><description><para>Use the Finder to search for a substring. Use the Formatter to format this substring and replace it in the input. Repeat this for all matching substrings.The input is modified in-place.</para><para> 1930</para></description></function> 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961</namespace> 1962</namespace> 1963</header> 1964<header name="boost/algorithm/string/find_iterator.hpp"> 1965<para>Defines find iterator classes. Find iterator repeatedly applies a Finder to the specified input string to search for matches. Dereferencing the iterator yields the current match or a range between the last and the current match depending on the iterator used. </para><namespace name="boost"> 1966<namespace name="algorithm"> 1967<class name="find_iterator"><template> 1968 <template-type-parameter name="IteratorT"/> 1969 </template><inherit access="public">iterator_facade< find_iterator< IteratorT >, const iterator_range< IteratorT >, forward_traversal_tag ></inherit><purpose><classname alt="boost::algorithm::find_iterator">find_iterator</classname> </purpose><description><para>Find iterator encapsulates a Finder and allows for incremental searching in a string. Each increment moves the iterator to the next match.</para><para>Find iterator is a readable forward traversal iterator.</para><para>Dereferencing the iterator yields an iterator_range delimiting the current match. </para></description><method-group name="public member functions"> 1970<method name="eof" cv="const"><type>bool</type><purpose>Eof check. </purpose><description><para>Check the eof condition. Eof condition means that there is nothing more to be searched i.e. <classname alt="boost::algorithm::find_iterator">find_iterator</classname> is after the last match. </para></description></method> 1971</method-group> 1972<constructor><purpose>Default constructor. </purpose><description><para>Construct null iterator. All null iterators are equal.</para><para> 1973</para></description><postconditions><para>eof()==true </para> 1974</postconditions></constructor> 1975<constructor><parameter name="Other"><paramtype>const <classname>find_iterator</classname> &</paramtype></parameter><purpose>Copy constructor. </purpose><description><para>Construct a copy of the <classname alt="boost::algorithm::find_iterator">find_iterator</classname> </para></description></constructor> 1976<constructor><template> 1977 <template-type-parameter name="FinderT"/> 1978 </template><parameter name="Begin"><paramtype>IteratorT</paramtype></parameter><parameter name="End"><paramtype>IteratorT</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><purpose>Constructor. </purpose><description><para>Construct new <classname alt="boost::algorithm::find_iterator">find_iterator</classname> for a given finder and a range. </para></description></constructor> 1979<constructor><template> 1980 <template-type-parameter name="FinderT"/> 1981 <template-type-parameter name="RangeT"/> 1982 </template><parameter name="Col"><paramtype>RangeT &</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><purpose>Constructor. </purpose><description><para>Construct new <classname alt="boost::algorithm::find_iterator">find_iterator</classname> for a given finder and a range. </para></description></constructor> 1983<method-group name="private member functions"> 1984<method name="dereference" cv="const"><type>const match_type &</type></method> 1985<method name="increment"><type>void</type></method> 1986<method name="equal" cv="const"><type>bool</type><parameter name="Other"><paramtype>const <classname>find_iterator</classname> &</paramtype></parameter></method> 1987</method-group> 1988</class><class name="split_iterator"><template> 1989 <template-type-parameter name="IteratorT"/> 1990 </template><inherit access="public">iterator_facade< split_iterator< IteratorT >, const iterator_range< IteratorT >, forward_traversal_tag ></inherit><purpose><classname alt="boost::algorithm::split_iterator">split_iterator</classname> </purpose><description><para>Split iterator encapsulates a Finder and allows for incremental searching in a string. Unlike the find iterator, split iterator iterates through gaps between matches.</para><para>Find iterator is a readable forward traversal iterator.</para><para>Dereferencing the iterator yields an iterator_range delimiting the current match. </para></description><method-group name="public member functions"> 1991<method name="eof" cv="const"><type>bool</type><purpose>Eof check. </purpose><description><para>Check the eof condition. Eof condition means that there is nothing more to be searched i.e. <classname alt="boost::algorithm::find_iterator">find_iterator</classname> is after the last match. </para></description></method> 1992</method-group> 1993<constructor><purpose>Default constructor. </purpose><description><para>Construct null iterator. All null iterators are equal.</para><para> 1994</para></description><postconditions><para>eof()==true </para> 1995</postconditions></constructor> 1996<constructor><parameter name="Other"><paramtype>const <classname>split_iterator</classname> &</paramtype></parameter><purpose>Copy constructor. </purpose><description><para>Construct a copy of the <classname alt="boost::algorithm::split_iterator">split_iterator</classname> </para></description></constructor> 1997<constructor><template> 1998 <template-type-parameter name="FinderT"/> 1999 </template><parameter name="Begin"><paramtype>IteratorT</paramtype></parameter><parameter name="End"><paramtype>IteratorT</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><purpose>Constructor. </purpose><description><para>Construct new <classname alt="boost::algorithm::split_iterator">split_iterator</classname> for a given finder and a range. </para></description></constructor> 2000<constructor><template> 2001 <template-type-parameter name="FinderT"/> 2002 <template-type-parameter name="RangeT"/> 2003 </template><parameter name="Col"><paramtype>RangeT &</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><purpose>Constructor. </purpose><description><para>Construct new <classname alt="boost::algorithm::split_iterator">split_iterator</classname> for a given finder and a collection. </para></description></constructor> 2004<method-group name="private member functions"> 2005<method name="dereference" cv="const"><type>const match_type &</type></method> 2006<method name="increment"><type>void</type></method> 2007<method name="equal" cv="const"><type>bool</type><parameter name="Other"><paramtype>const <classname>split_iterator</classname> &</paramtype></parameter></method> 2008</method-group> 2009</class> 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053<function name="make_find_iterator"><type><classname>find_iterator</classname>< typename range_iterator< RangeT >::type ></type><template> 2054 <template-type-parameter name="RangeT"/> 2055 <template-type-parameter name="FinderT"/> 2056 </template><parameter name="Collection"><paramtype>RangeT &</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><purpose>find iterator construction helper </purpose><description><para>Construct a find iterator to iterate through the specified string </para></description></function> 2057<function name="make_split_iterator"><type><classname>split_iterator</classname>< typename range_iterator< RangeT >::type ></type><template> 2058 <template-type-parameter name="RangeT"/> 2059 <template-type-parameter name="FinderT"/> 2060 </template><parameter name="Collection"><paramtype>RangeT &</paramtype></parameter><parameter name="Finder"><paramtype>FinderT</paramtype></parameter><purpose>split iterator construction helper </purpose><description><para>Construct a split iterator to iterate through the specified collection </para></description></function> 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201</namespace> 2202</namespace> 2203</header> 2204<header name="boost/algorithm/string/finder.hpp"> 2205<para>Defines Finder generators. Finder object is a functor which is able to find a substring matching a specific criteria in the input. Finders are used as a pluggable components for replace, find and split facilities. This header contains generator functions for finders provided in this library. </para><namespace name="boost"> 2206<namespace name="algorithm"> 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240<overloaded-function name="first_finder"><signature><type><emphasis>unspecified</emphasis></type><template> 2241 <template-type-parameter name="RangeT"/> 2242 </template><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter></signature><signature><type><emphasis>unspecified</emphasis></type><template> 2243 <template-type-parameter name="RangeT"/> 2244 <template-type-parameter name="PredicateT"/> 2245 </template><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype></parameter></signature><purpose>"First" finder </purpose><description><para>Construct the <computeroutput>first_finder</computeroutput>. The finder searches for the first occurrence of the string in a given input. The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the match.</para><para> 2246 2247</para></description><returns><para>An instance of the <computeroutput>first_finder</computeroutput> object </para> 2248</returns></overloaded-function> 2249 2250<overloaded-function name="last_finder"><signature><type><emphasis>unspecified</emphasis></type><template> 2251 <template-type-parameter name="RangeT"/> 2252 </template><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter></signature><signature><type><emphasis>unspecified</emphasis></type><template> 2253 <template-type-parameter name="RangeT"/> 2254 <template-type-parameter name="PredicateT"/> 2255 </template><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype></parameter></signature><purpose>"Last" finder </purpose><description><para>Construct the <computeroutput>last_finder</computeroutput>. The finder searches for the last occurrence of the string in a given input. The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the match.</para><para> 2256 2257</para></description><returns><para>An instance of the <computeroutput>last_finder</computeroutput> object </para> 2258</returns></overloaded-function> 2259 2260<overloaded-function name="nth_finder"><signature><type><emphasis>unspecified</emphasis></type><template> 2261 <template-type-parameter name="RangeT"/> 2262 </template><parameter name="Search"><paramtype>const RangeT &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be find </para></description></parameter></signature><signature><type><emphasis>unspecified</emphasis></type><template> 2263 <template-type-parameter name="RangeT"/> 2264 <template-type-parameter name="PredicateT"/> 2265 </template><parameter name="Search"><paramtype>const RangeT &</paramtype></parameter><parameter name="Nth"><paramtype>int</paramtype></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype></parameter></signature><purpose>"Nth" finder </purpose><description><para>Construct the <computeroutput>nth_finder</computeroutput>. The finder searches for the n-th (zero-indexed) occurrence of the string in a given input. The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the match.</para><para> 2266 2267</para></description><returns><para>An instance of the <computeroutput>nth_finder</computeroutput> object </para> 2268</returns></overloaded-function> 2269 2270<function name="head_finder"><type><emphasis>unspecified</emphasis></type><parameter name="N"><paramtype>int</paramtype><description><para>The size of the head </para></description></parameter><purpose>"Head" finder </purpose><description><para>Construct the <computeroutput>head_finder</computeroutput>. The finder returns a head of a given input. The head is a prefix of a string up to n elements in size. If an input has less then n elements, whole input is considered a head. The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the match.</para><para> 2271 2272</para></description><returns><para>An instance of the <computeroutput>head_finder</computeroutput> object </para> 2273</returns></function> 2274<function name="tail_finder"><type><emphasis>unspecified</emphasis></type><parameter name="N"><paramtype>int</paramtype><description><para>The size of the head </para></description></parameter><purpose>"Tail" finder </purpose><description><para>Construct the <computeroutput>tail_finder</computeroutput>. The finder returns a tail of a given input. The tail is a suffix of a string up to n elements in size. If an input has less then n elements, whole input is considered a head. The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the match.</para><para> 2275 2276</para></description><returns><para>An instance of the <computeroutput>tail_finder</computeroutput> object </para> 2277</returns></function> 2278<function name="token_finder"><type><emphasis>unspecified</emphasis></type><template> 2279 <template-type-parameter name="PredicateT"/> 2280 </template><parameter name="Pred"><paramtype>PredicateT</paramtype><description><para>An element selection predicate </para></description></parameter><parameter name="eCompress"><paramtype>token_compress_mode_type</paramtype><default>token_compress_off</default><description><para>Compress flag </para></description></parameter><purpose>"Token" finder </purpose><description><para>Construct the <computeroutput>token_finder</computeroutput>. The finder searches for a token specified by a predicate. It is similar to std::find_if algorithm, with an exception that it return a range of instead of a single iterator.</para><para>If "compress token mode" is enabled, adjacent matching tokens are concatenated into one match. Thus the finder can be used to search for continuous segments of characters satisfying the given predicate.</para><para>The result is given as an <computeroutput>iterator_range</computeroutput> delimiting the match.</para><para> 2281 2282</para></description><returns><para>An instance of the <computeroutput>token_finder</computeroutput> object </para> 2283</returns></function> 2284<overloaded-function name="range_finder"><signature><type><emphasis>unspecified</emphasis></type><template> 2285 <template-type-parameter name="ForwardIteratorT"/> 2286 </template><parameter name="Begin"><paramtype>ForwardIteratorT</paramtype><description><para>Beginning of the range </para></description></parameter><parameter name="End"><paramtype>ForwardIteratorT</paramtype><description><para>End of the range </para></description></parameter></signature><signature><type><emphasis>unspecified</emphasis></type><template> 2287 <template-type-parameter name="ForwardIteratorT"/> 2288 </template><parameter name="Range"><paramtype>iterator_range< ForwardIteratorT ></paramtype></parameter></signature><purpose>"Range" finder </purpose><description><para>Construct the <computeroutput>range_finder</computeroutput>. The finder does not perform any operation. It simply returns the given range for any input.</para><para> 2289 2290</para></description><returns><para>An instance of the <computeroutput>range_finger</computeroutput> object </para> 2291</returns></overloaded-function> 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435</namespace> 2436</namespace> 2437</header> 2438<header name="boost/algorithm/string/formatter.hpp"> 2439<para>Defines Formatter generators. Formatter is a functor which formats a string according to given parameters. A Formatter works in conjunction with a Finder. A Finder can provide additional information for a specific Formatter. An example of such a cooperation is regex_finder and regex_formatter.</para><para>Formatters are used as pluggable components for replace facilities. This header contains generator functions for the Formatters provided in this library. </para><namespace name="boost"> 2440<namespace name="algorithm"> 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597<function name="const_formatter"><type><emphasis>unspecified</emphasis></type><template> 2598 <template-type-parameter name="RangeT"/> 2599 </template><parameter name="Format"><paramtype>const RangeT &</paramtype><description><para>A predefined value used as a result for formatting </para></description></parameter><purpose>Constant formatter. </purpose><description><para>Constructs a <computeroutput>const_formatter</computeroutput>. Const formatter always returns the same value, regardless of the parameter.</para><para> 2600 2601</para></description><returns><para>An instance of the <computeroutput>const_formatter</computeroutput> object. </para> 2602</returns></function> 2603<function name="identity_formatter"><type><emphasis>unspecified</emphasis></type><template> 2604 <template-type-parameter name="RangeT"/> 2605 </template><purpose>Identity formatter. </purpose><description><para>Constructs an <computeroutput>identity_formatter</computeroutput>. Identity formatter always returns the parameter.</para><para> 2606</para></description><returns><para>An instance of the <computeroutput>identity_formatter</computeroutput> object. </para> 2607</returns></function> 2608<function name="empty_formatter"><type><emphasis>unspecified</emphasis></type><template> 2609 <template-type-parameter name="RangeT"/> 2610 </template><parameter name=""><paramtype>const RangeT &</paramtype></parameter><purpose>Empty formatter. </purpose><description><para>Constructs an <computeroutput>empty_formatter</computeroutput>. Empty formatter always returns an empty sequence.</para><para> 2611 2612</para></description><returns><para>An instance of the <computeroutput>empty_formatter</computeroutput> object. </para> 2613</returns></function> 2614<function name="dissect_formatter"><type><emphasis>unspecified</emphasis></type><template> 2615 <template-type-parameter name="FinderT"/> 2616 </template><parameter name="Finder"><paramtype>const FinderT &</paramtype><description><para>a finder used to select a portion of the formatted sequence </para></description></parameter><purpose>Empty formatter. </purpose><description><para>Constructs a <computeroutput>dissect_formatter</computeroutput>. Dissect formatter uses a specified finder to extract a portion of the formatted sequence. The first finder's match is returned as a result</para><para> 2617 2618</para></description><returns><para>An instance of the <computeroutput>dissect_formatter</computeroutput> object. </para> 2619</returns></function> 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646</namespace> 2647</namespace> 2648</header> 2649<header name="boost/algorithm/string/iter_find.hpp"> 2650<para>Defines generic split algorithms. Split algorithms can be used to divide a sequence into several part according to a given criteria. Result is given as a 'container of containers' where elements are copies or references to extracted parts.</para><para>There are two algorithms provided. One iterates over matching substrings, the other one over the gaps between these matches. </para><namespace name="boost"> 2651<namespace name="algorithm"> 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732<function name="iter_find"><type>SequenceSequenceT &</type><template> 2733 <template-type-parameter name="SequenceSequenceT"/> 2734 <template-type-parameter name="RangeT"/> 2735 <template-type-parameter name="FinderT"/> 2736 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A 'container container' to contain the result of search. Both outer and inner container must have constructor taking a pair of iterators as an argument. Typical type of the result is <computeroutput>std::vector<boost::iterator_range<iterator>></computeroutput> (each element of such a vector will container a range delimiting a match). </para></description></parameter><parameter name="Input"><paramtype>RangeT &&</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Finder"><paramtype>FinderT</paramtype><description><para>A Finder object used for searching </para></description></parameter><purpose>Iter find algorithm. </purpose><description><para>This algorithm executes a given finder in iteration on the input, until the end of input is reached, or no match is found. Iteration is done using built-in <classname alt="boost::algorithm::find_iterator">find_iterator</classname>, so the real searching is performed only when needed. In each iteration new match is found and added to the result.</para><para> 2737 2738<note><para>Prior content of the result will be overwritten. </para> 2739</note> 2740</para></description><returns><para>A reference to the result</para> 2741</returns></function> 2742<function name="iter_split"><type>SequenceSequenceT &</type><template> 2743 <template-type-parameter name="SequenceSequenceT"/> 2744 <template-type-parameter name="RangeT"/> 2745 <template-type-parameter name="FinderT"/> 2746 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A 'container container' to contain the result of search. Both outer and inner container must have constructor taking a pair of iterators as an argument. Typical type of the result is <computeroutput>std::vector<boost::iterator_range<iterator>></computeroutput> (each element of such a vector will container a range delimiting a match). </para></description></parameter><parameter name="Input"><paramtype>RangeT &&</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Finder"><paramtype>FinderT</paramtype><description><para>A finder object used for searching </para></description></parameter><purpose>Split find algorithm. </purpose><description><para>This algorithm executes a given finder in iteration on the input, until the end of input is reached, or no match is found. Iteration is done using built-in <classname alt="boost::algorithm::find_iterator">find_iterator</classname>, so the real searching is performed only when needed. Each match is used as a separator of segments. These segments are then returned in the result.</para><para> 2747 2748<note><para>Prior content of the result will be overwritten. </para> 2749</note> 2750</para></description><returns><para>A reference to the result</para> 2751</returns></function> 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856</namespace> 2857</namespace> 2858</header> 2859<header name="boost/algorithm/string/join.hpp"> 2860<para>Defines join algorithm.</para><para>Join algorithm is a counterpart to split algorithms. It joins strings from a 'list' by adding user defined separator. Additionally there is a version that allows simple filtering by providing a predicate. </para><namespace name="boost"> 2861<namespace name="algorithm"> 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977<function name="join"><type>range_value< SequenceSequenceT >::type</type><template> 2978 <template-type-parameter name="SequenceSequenceT"/> 2979 <template-type-parameter name="Range1T"/> 2980 </template><parameter name="Input"><paramtype>const SequenceSequenceT &</paramtype><description><para>A container that holds the input strings. It must be a container-of-containers. </para></description></parameter><parameter name="Separator"><paramtype>const Range1T &</paramtype><description><para>A string that will separate the joined segments. </para></description></parameter><purpose>Join algorithm. </purpose><description><para>This algorithm joins all strings in a 'list' into one long string. Segments are concatenated by given separator.</para><para> 2981 2982<note><para>This function provides the strong exception-safety guarantee </para> 2983</note> 2984</para></description><returns><para>Concatenated string.</para> 2985</returns></function> 2986<function name="join_if"><type>range_value< SequenceSequenceT >::type</type><template> 2987 <template-type-parameter name="SequenceSequenceT"/> 2988 <template-type-parameter name="Range1T"/> 2989 <template-type-parameter name="PredicateT"/> 2990 </template><parameter name="Input"><paramtype>const SequenceSequenceT &</paramtype><description><para>A container that holds the input strings. It must be a container-of-containers. </para></description></parameter><parameter name="Separator"><paramtype>const Range1T &</paramtype><description><para>A string that will separate the joined segments. </para></description></parameter><parameter name="Pred"><paramtype>PredicateT</paramtype><description><para>A segment selection predicate </para></description></parameter><purpose>Conditional join algorithm. </purpose><description><para>This algorithm joins all strings in a 'list' into one long string. Segments are concatenated by given separator. Only segments that satisfy the predicate will be added to the result.</para><para> 2991 2992<note><para>This function provides the strong exception-safety guarantee </para> 2993</note> 2994</para></description><returns><para>Concatenated string.</para> 2995</returns></function> 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065</namespace> 3066</namespace> 3067</header> 3068<header name="boost/algorithm/string/predicate.hpp"> 3069<para>Defines string-related predicates. The predicates determine whether a substring is contained in the input string under various conditions: a string starts with the substring, ends with the substring, simply contains the substring or if both strings are equal. Additionaly the algorithm <computeroutput>all()</computeroutput> checks all elements of a container to satisfy a condition.</para><para>All predicates provide the strong exception guarantee. </para><namespace name="boost"> 3070<namespace name="algorithm"> 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132<overloaded-function name="starts_with"><signature><type>bool</type><template> 3133 <template-type-parameter name="Range1T"/> 3134 <template-type-parameter name="Range2T"/> 3135 <template-type-parameter name="PredicateT"/> 3136 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype><description><para>An element comparison predicate </para></description></parameter></signature><signature><type>bool</type><template> 3137 <template-type-parameter name="Range1T"/> 3138 <template-type-parameter name="Range2T"/> 3139 </template><parameter name="Input"><paramtype>const Range1T &</paramtype></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>'Starts with' predicate </purpose><description><para>This predicate holds when the test string is a prefix of the Input. In other words, if the input starts with the test. When the optional predicate is specified, it is used for character-wise comparison.</para><para> 3140 3141<note><para>This function provides the strong exception-safety guarantee </para> 3142</note> 3143</para></description><returns><para>The result of the test</para> 3144</returns></overloaded-function> 3145 3146<function name="istarts_with"><type>bool</type><template> 3147 <template-type-parameter name="Range1T"/> 3148 <template-type-parameter name="Range2T"/> 3149 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>'Starts with' predicate ( case insensitive ) </purpose><description><para>This predicate holds when the test string is a prefix of the Input. In other words, if the input starts with the test. Elements are compared case insensitively.</para><para> 3150 3151<note><para>This function provides the strong exception-safety guarantee </para> 3152</note> 3153</para></description><returns><para>The result of the test</para> 3154</returns></function> 3155<overloaded-function name="ends_with"><signature><type>bool</type><template> 3156 <template-type-parameter name="Range1T"/> 3157 <template-type-parameter name="Range2T"/> 3158 <template-type-parameter name="PredicateT"/> 3159 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype><description><para>An element comparison predicate </para></description></parameter></signature><signature><type>bool</type><template> 3160 <template-type-parameter name="Range1T"/> 3161 <template-type-parameter name="Range2T"/> 3162 </template><parameter name="Input"><paramtype>const Range1T &</paramtype></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>'Ends with' predicate </purpose><description><para>This predicate holds when the test string is a suffix of the Input. In other words, if the input ends with the test. When the optional predicate is specified, it is used for character-wise comparison.</para><para> 3163 3164<note><para>This function provides the strong exception-safety guarantee </para> 3165</note> 3166</para></description><returns><para>The result of the test</para> 3167</returns></overloaded-function> 3168 3169<function name="iends_with"><type>bool</type><template> 3170 <template-type-parameter name="Range1T"/> 3171 <template-type-parameter name="Range2T"/> 3172 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>'Ends with' predicate ( case insensitive ) </purpose><description><para>This predicate holds when the test container is a suffix of the Input. In other words, if the input ends with the test. Elements are compared case insensitively.</para><para> 3173 3174<note><para>This function provides the strong exception-safety guarantee </para> 3175</note> 3176</para></description><returns><para>The result of the test</para> 3177</returns></function> 3178<overloaded-function name="contains"><signature><type>bool</type><template> 3179 <template-type-parameter name="Range1T"/> 3180 <template-type-parameter name="Range2T"/> 3181 <template-type-parameter name="PredicateT"/> 3182 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype><description><para>An element comparison predicate </para></description></parameter></signature><signature><type>bool</type><template> 3183 <template-type-parameter name="Range1T"/> 3184 <template-type-parameter name="Range2T"/> 3185 </template><parameter name="Input"><paramtype>const Range1T &</paramtype></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>'Contains' predicate </purpose><description><para>This predicate holds when the test container is contained in the Input. When the optional predicate is specified, it is used for character-wise comparison.</para><para> 3186 3187<note><para>This function provides the strong exception-safety guarantee </para> 3188</note> 3189</para></description><returns><para>The result of the test</para> 3190</returns></overloaded-function> 3191 3192<function name="icontains"><type>bool</type><template> 3193 <template-type-parameter name="Range1T"/> 3194 <template-type-parameter name="Range2T"/> 3195 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>'Contains' predicate ( case insensitive ) </purpose><description><para>This predicate holds when the test container is contained in the Input. Elements are compared case insensitively.</para><para> 3196 3197<note><para>This function provides the strong exception-safety guarantee </para> 3198</note> 3199</para></description><returns><para>The result of the test</para> 3200</returns></function> 3201<overloaded-function name="equals"><signature><type>bool</type><template> 3202 <template-type-parameter name="Range1T"/> 3203 <template-type-parameter name="Range2T"/> 3204 <template-type-parameter name="PredicateT"/> 3205 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Comp"><paramtype>PredicateT</paramtype><description><para>An element comparison predicate </para></description></parameter></signature><signature><type>bool</type><template> 3206 <template-type-parameter name="Range1T"/> 3207 <template-type-parameter name="Range2T"/> 3208 </template><parameter name="Input"><paramtype>const Range1T &</paramtype></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>'Equals' predicate </purpose><description><para>This predicate holds when the test container is equal to the input container i.e. all elements in both containers are same. When the optional predicate is specified, it is used for character-wise comparison.</para><para> 3209 3210<note><para>This is a two-way version of <computeroutput>std::equal</computeroutput> algorithm</para> 3211</note> 3212<note><para>This function provides the strong exception-safety guarantee </para> 3213</note> 3214</para></description><returns><para>The result of the test</para> 3215</returns></overloaded-function> 3216 3217<function name="iequals"><type>bool</type><template> 3218 <template-type-parameter name="Range1T"/> 3219 <template-type-parameter name="Range2T"/> 3220 </template><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Test"><paramtype>const Range2T &</paramtype><description><para>A test sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>'Equals' predicate ( case insensitive ) </purpose><description><para>This predicate holds when the test container is equal to the input container i.e. all elements in both containers are same. Elements are compared case insensitively.</para><para> 3221 3222<note><para>This is a two-way version of <computeroutput>std::equal</computeroutput> algorithm</para> 3223</note> 3224<note><para>This function provides the strong exception-safety guarantee </para> 3225</note> 3226</para></description><returns><para>The result of the test</para> 3227</returns></function> 3228<overloaded-function name="lexicographical_compare"><signature><type>bool</type><template> 3229 <template-type-parameter name="Range1T"/> 3230 <template-type-parameter name="Range2T"/> 3231 <template-type-parameter name="PredicateT"/> 3232 </template><parameter name="Arg1"><paramtype>const Range1T &</paramtype><description><para>First argument </para></description></parameter><parameter name="Arg2"><paramtype>const Range2T &</paramtype><description><para>Second argument </para></description></parameter><parameter name="Pred"><paramtype>PredicateT</paramtype><description><para>Comparison predicate </para></description></parameter></signature><signature><type>bool</type><template> 3233 <template-type-parameter name="Range1T"/> 3234 <template-type-parameter name="Range2T"/> 3235 </template><parameter name="Arg1"><paramtype>const Range1T &</paramtype></parameter><parameter name="Arg2"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>Lexicographical compare predicate. </purpose><description><para>This predicate is an overload of std::lexicographical_compare for range arguments</para><para>It check whether the first argument is lexicographically less then the second one.</para><para>If the optional predicate is specified, it is used for character-wise comparison</para><para> 3236 3237<note><para>This function provides the strong exception-safety guarantee </para> 3238</note> 3239</para></description><returns><para>The result of the test</para> 3240</returns></overloaded-function> 3241 3242<function name="ilexicographical_compare"><type>bool</type><template> 3243 <template-type-parameter name="Range1T"/> 3244 <template-type-parameter name="Range2T"/> 3245 </template><parameter name="Arg1"><paramtype>const Range1T &</paramtype><description><para>First argument </para></description></parameter><parameter name="Arg2"><paramtype>const Range2T &</paramtype><description><para>Second argument </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Lexicographical compare predicate (case-insensitive) </purpose><description><para>This predicate is an overload of std::lexicographical_compare for range arguments. It check whether the first argument is lexicographically less then the second one. Elements are compared case insensitively</para><para> 3246 3247<note><para>This function provides the strong exception-safety guarantee </para> 3248</note> 3249</para></description><returns><para>The result of the test</para> 3250</returns></function> 3251<function name="all"><type>bool</type><template> 3252 <template-type-parameter name="RangeT"/> 3253 <template-type-parameter name="PredicateT"/> 3254 </template><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Pred"><paramtype>PredicateT</paramtype><description><para>A predicate </para></description></parameter><purpose>'All' predicate </purpose><description><para>This predicate holds it all its elements satisfy a given condition, represented by the predicate.</para><para> 3255 3256<note><para>This function provides the strong exception-safety guarantee </para> 3257</note> 3258</para></description><returns><para>The result of the test</para> 3259</returns></function> 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369</namespace> 3370</namespace> 3371</header> 3372<header name="boost/algorithm/string/regex.hpp"> 3373<para>Defines regex variants of the algorithms. </para><namespace name="boost"> 3374<namespace name="algorithm"> 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535<function name="find_regex"><type>iterator_range< typename range_iterator< RangeT >::type ></type><template> 3536 <template-type-parameter name="RangeT"/> 3537 <template-type-parameter name="CharT"/> 3538 <template-type-parameter name="RegexTraitsT"/> 3539 </template><parameter name="Input"><paramtype>RangeT &</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter><purpose>Find regex algorithm. </purpose><description><para>Search for a substring matching the given regex in the input.</para><para> 3540 3541<note><para>This function provides the strong exception-safety guarantee </para> 3542</note> 3543</para></description><returns><para>An <computeroutput>iterator_range</computeroutput> delimiting the match. Returned iterator is either <computeroutput>RangeT::iterator</computeroutput> or <computeroutput>RangeT::const_iterator</computeroutput>, depending on the constness of the input parameter.</para> 3544</returns></function> 3545<overloaded-function name="replace_regex_copy"><signature><type>OutputIteratorT</type><template> 3546 <template-type-parameter name="OutputIteratorT"/> 3547 <template-type-parameter name="RangeT"/> 3548 <template-type-parameter name="CharT"/> 3549 <template-type-parameter name="RegexTraitsT"/> 3550 <template-type-parameter name="FormatStringTraitsT"/> 3551 <template-type-parameter name="FormatStringAllocatorT"/> 3552 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Format"><paramtype>const std::basic_string< CharT, FormatStringTraitsT, FormatStringAllocatorT > &</paramtype><description><para>Regex format definition </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default|format_default</default><description><para>Regex options </para></description></parameter></signature><signature><type>SequenceT</type><template> 3553 <template-type-parameter name="SequenceT"/> 3554 <template-type-parameter name="CharT"/> 3555 <template-type-parameter name="RegexTraitsT"/> 3556 <template-type-parameter name="FormatStringTraitsT"/> 3557 <template-type-parameter name="FormatStringAllocatorT"/> 3558 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype></parameter><parameter name="Format"><paramtype>const std::basic_string< CharT, FormatStringTraitsT, FormatStringAllocatorT > &</paramtype></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default|format_default</default></parameter></signature><purpose>Replace regex algorithm. </purpose><description><para>Search for a substring matching given regex and format it with the specified format.</para><para>The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 3559 3560<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 3561</note> 3562</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 3563</returns></overloaded-function> 3564 3565<function name="replace_regex"><type>void</type><template> 3566 <template-type-parameter name="SequenceT"/> 3567 <template-type-parameter name="CharT"/> 3568 <template-type-parameter name="RegexTraitsT"/> 3569 <template-type-parameter name="FormatStringTraitsT"/> 3570 <template-type-parameter name="FormatStringAllocatorT"/> 3571 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Format"><paramtype>const std::basic_string< CharT, FormatStringTraitsT, FormatStringAllocatorT > &</paramtype><description><para>Regex format definition </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default|format_default</default><description><para>Regex options </para></description></parameter><purpose>Replace regex algorithm. </purpose><description><para>Search for a substring matching given regex and format it with the specified format. The input string is modified in-place.</para><para> 3572</para></description></function> 3573<overloaded-function name="replace_all_regex_copy"><signature><type>OutputIteratorT</type><template> 3574 <template-type-parameter name="OutputIteratorT"/> 3575 <template-type-parameter name="RangeT"/> 3576 <template-type-parameter name="CharT"/> 3577 <template-type-parameter name="RegexTraitsT"/> 3578 <template-type-parameter name="FormatStringTraitsT"/> 3579 <template-type-parameter name="FormatStringAllocatorT"/> 3580 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Format"><paramtype>const std::basic_string< CharT, FormatStringTraitsT, FormatStringAllocatorT > &</paramtype><description><para>Regex format definition </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default|format_default</default><description><para>Regex options </para></description></parameter></signature><signature><type>SequenceT</type><template> 3581 <template-type-parameter name="SequenceT"/> 3582 <template-type-parameter name="CharT"/> 3583 <template-type-parameter name="RegexTraitsT"/> 3584 <template-type-parameter name="FormatStringTraitsT"/> 3585 <template-type-parameter name="FormatStringAllocatorT"/> 3586 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype></parameter><parameter name="Format"><paramtype>const std::basic_string< CharT, FormatStringTraitsT, FormatStringAllocatorT > &</paramtype></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default|format_default</default></parameter></signature><purpose>Replace all regex algorithm. </purpose><description><para>Format all substrings, matching given regex, with the specified format. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 3587 3588<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 3589</note> 3590</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 3591</returns></overloaded-function> 3592 3593<function name="replace_all_regex"><type>void</type><template> 3594 <template-type-parameter name="SequenceT"/> 3595 <template-type-parameter name="CharT"/> 3596 <template-type-parameter name="RegexTraitsT"/> 3597 <template-type-parameter name="FormatStringTraitsT"/> 3598 <template-type-parameter name="FormatStringAllocatorT"/> 3599 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Format"><paramtype>const std::basic_string< CharT, FormatStringTraitsT, FormatStringAllocatorT > &</paramtype><description><para>Regex format definition </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default|format_default</default><description><para>Regex options </para></description></parameter><purpose>Replace all regex algorithm. </purpose><description><para>Format all substrings, matching given regex, with the specified format. The input string is modified in-place.</para><para> 3600</para></description></function> 3601<overloaded-function name="erase_regex_copy"><signature><type>OutputIteratorT</type><template> 3602 <template-type-parameter name="OutputIteratorT"/> 3603 <template-type-parameter name="RangeT"/> 3604 <template-type-parameter name="CharT"/> 3605 <template-type-parameter name="RegexTraitsT"/> 3606 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter></signature><signature><type>SequenceT</type><template> 3607 <template-type-parameter name="SequenceT"/> 3608 <template-type-parameter name="CharT"/> 3609 <template-type-parameter name="RegexTraitsT"/> 3610 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default></parameter></signature><purpose>Erase regex algorithm. </purpose><description><para>Remove a substring matching given regex from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 3611 3612<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 3613</note> 3614</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 3615</returns></overloaded-function> 3616 3617<function name="erase_regex"><type>void</type><template> 3618 <template-type-parameter name="SequenceT"/> 3619 <template-type-parameter name="CharT"/> 3620 <template-type-parameter name="RegexTraitsT"/> 3621 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter><purpose>Erase regex algorithm. </purpose><description><para>Remove a substring matching given regex from the input. The input string is modified in-place.</para><para> 3622</para></description></function> 3623<overloaded-function name="erase_all_regex_copy"><signature><type>OutputIteratorT</type><template> 3624 <template-type-parameter name="OutputIteratorT"/> 3625 <template-type-parameter name="RangeT"/> 3626 <template-type-parameter name="CharT"/> 3627 <template-type-parameter name="RegexTraitsT"/> 3628 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter></signature><signature><type>SequenceT</type><template> 3629 <template-type-parameter name="SequenceT"/> 3630 <template-type-parameter name="CharT"/> 3631 <template-type-parameter name="RegexTraitsT"/> 3632 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default></parameter></signature><purpose>Erase all regex algorithm. </purpose><description><para>Erase all substrings, matching given regex, from the input. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 3633 3634<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 3635</note> 3636</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 3637</returns></overloaded-function> 3638 3639<function name="erase_all_regex"><type>void</type><template> 3640 <template-type-parameter name="SequenceT"/> 3641 <template-type-parameter name="CharT"/> 3642 <template-type-parameter name="RegexTraitsT"/> 3643 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter><purpose>Erase all regex algorithm. </purpose><description><para>Erase all substrings, matching given regex, from the input. The input string is modified in-place.</para><para> 3644</para></description></function> 3645<function name="find_all_regex"><type>SequenceSequenceT &</type><template> 3646 <template-type-parameter name="SequenceSequenceT"/> 3647 <template-type-parameter name="RangeT"/> 3648 <template-type-parameter name="CharT"/> 3649 <template-type-parameter name="RegexTraitsT"/> 3650 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A container that can hold copies of references to the substrings. </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter><purpose>Find all regex algorithm. </purpose><description><para>This algorithm finds all substrings matching the give regex in the input.</para><para>Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <computeroutput>std::vector<std::string></computeroutput> or <computeroutput>std::list<boost::iterator_range<std::string::iterator>></computeroutput> </para><para> 3651 3652<note><para>Prior content of the result will be overwritten.</para> 3653</note> 3654<note><para>This function provides the strong exception-safety guarantee </para> 3655</note> 3656</para></description><returns><para>A reference to the result</para> 3657</returns></function> 3658<function name="split_regex"><type>SequenceSequenceT &</type><template> 3659 <template-type-parameter name="SequenceSequenceT"/> 3660 <template-type-parameter name="RangeT"/> 3661 <template-type-parameter name="CharT"/> 3662 <template-type-parameter name="RegexTraitsT"/> 3663 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A container that can hold copies of references to the substrings.</para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter><purpose>Split regex algorithm. </purpose><description><para>Tokenize expression. This function is equivalent to C strtok. Input sequence is split into tokens, separated by separators. Separator is an every match of the given regex. Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <computeroutput>std::vector<std::string></computeroutput> or <computeroutput>std::list<boost::iterator_range<std::string::iterator>></computeroutput> </para><para> 3664 3665<note><para>Prior content of the result will be overwritten.</para> 3666</note> 3667<note><para>This function provides the strong exception-safety guarantee </para> 3668</note> 3669</para></description><returns><para>A reference to the result</para> 3670</returns></function> 3671<function name="join_if"><type>range_value< SequenceSequenceT >::type</type><template> 3672 <template-type-parameter name="SequenceSequenceT"/> 3673 <template-type-parameter name="Range1T"/> 3674 <template-type-parameter name="CharT"/> 3675 <template-type-parameter name="RegexTraitsT"/> 3676 </template><parameter name="Input"><paramtype>const SequenceSequenceT &</paramtype><description><para>A container that holds the input strings. It must be a container-of-containers. </para></description></parameter><parameter name="Separator"><paramtype>const Range1T &</paramtype><description><para>A string that will separate the joined segments. </para></description></parameter><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex options </para></description></parameter><purpose>Conditional join algorithm. </purpose><description><para>This algorithm joins all strings in a 'list' into one long string. Segments are concatenated by given separator. Only segments that match the given regular expression will be added to the result</para><para>This is a specialization of join_if algorithm.</para><para> 3677 3678<note><para>This function provides the strong exception-safety guarantee </para> 3679</note> 3680</para></description><returns><para>Concatenated string.</para> 3681</returns></function> 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692</namespace> 3693</namespace> 3694</header> 3695<header name="boost/algorithm/string/regex_find_format.hpp"> 3696<para>Defines the <computeroutput>regex_finder</computeroutput> and <computeroutput>regex_formatter</computeroutput> generators. These two functors are designed to work together. <computeroutput>regex_formatter</computeroutput> uses additional information about a match contained in the regex_finder search result. </para><namespace name="boost"> 3697<namespace name="algorithm"> 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874<function name="regex_finder"><type><emphasis>unspecified</emphasis></type><template> 3875 <template-type-parameter name="CharT"/> 3876 <template-type-parameter name="RegexTraitsT"/> 3877 </template><parameter name="Rx"><paramtype>const basic_regex< CharT, RegexTraitsT > &</paramtype><description><para>A regular expression </para></description></parameter><parameter name="MatchFlags"><paramtype>match_flag_type</paramtype><default>match_default</default><description><para>Regex search options </para></description></parameter><purpose>"Regex" finder </purpose><description><para>Construct the <computeroutput>regex_finder</computeroutput>. Finder uses the regex engine to search for a match. Result is given in <computeroutput>regex_search_result</computeroutput>. This is an extension of the iterator_range. In addition it contains match results from the <computeroutput>regex_search</computeroutput> algorithm.</para><para> 3878 3879</para></description><returns><para>An instance of the <computeroutput>regex_finder</computeroutput> object </para> 3880</returns></function> 3881<function name="regex_formatter"><type><emphasis>unspecified</emphasis></type><template> 3882 <template-type-parameter name="CharT"/> 3883 <template-type-parameter name="TraitsT"/> 3884 <template-type-parameter name="AllocT"/> 3885 </template><parameter name="Format"><paramtype>const std::basic_string< CharT, TraitsT, AllocT > &</paramtype><description><para>Regex format definition </para></description></parameter><parameter name="Flags"><paramtype>match_flag_type</paramtype><default>format_default</default><description><para>Format flags </para></description></parameter><purpose>Regex formatter. </purpose><description><para>Construct the <computeroutput>regex_formatter</computeroutput>. Regex formatter uses the regex engine to format a match found by the <computeroutput>regex_finder</computeroutput>. This formatted it designed to closely cooperate with <computeroutput>regex_finder</computeroutput>.</para><para> 3886 3887</para></description><returns><para>An instance of the <computeroutput>regex_formatter</computeroutput> functor </para> 3888</returns></function> 3889 3890 3891 3892 3893 3894 3895 3896 3897</namespace> 3898</namespace> 3899</header> 3900<header name="boost/algorithm/string/replace.hpp"> 3901<para>Defines various replace algorithms. Each algorithm replaces part(s) of the input according to set of searching and replace criteria. </para><namespace name="boost"> 3902<namespace name="algorithm"> 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020<overloaded-function name="replace_range_copy"><signature><type>OutputIteratorT</type><template> 4021 <template-type-parameter name="OutputIteratorT"/> 4022 <template-type-parameter name="Range1T"/> 4023 <template-type-parameter name="Range2T"/> 4024 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="SearchRange"><paramtype>const iterator_range< typename range_const_iterator< Range1T >::type > &</paramtype><description><para>A range in the input to be substituted </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4025 <template-type-parameter name="SequenceT"/> 4026 <template-type-parameter name="RangeT"/> 4027 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="SearchRange"><paramtype>const iterator_range< typename range_const_iterator< SequenceT >::type > &</paramtype></parameter><parameter name="Format"><paramtype>const RangeT &</paramtype></parameter></signature><purpose>Replace range algorithm. </purpose><description><para>Replace the given range in the input string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4028 4029<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4030</note> 4031</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4032</returns></overloaded-function> 4033 4034<function name="replace_range"><type>void</type><template> 4035 <template-type-parameter name="SequenceT"/> 4036 <template-type-parameter name="RangeT"/> 4037 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="SearchRange"><paramtype>const iterator_range< typename range_iterator< SequenceT >::type > &</paramtype><description><para>A range in the input to be substituted </para></description></parameter><parameter name="Format"><paramtype>const RangeT &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace range algorithm. </purpose><description><para>Replace the given range in the input string. The input sequence is modified in-place.</para><para> 4038</para></description></function> 4039<overloaded-function name="replace_first_copy"><signature><type>OutputIteratorT</type><template> 4040 <template-type-parameter name="OutputIteratorT"/> 4041 <template-type-parameter name="Range1T"/> 4042 <template-type-parameter name="Range2T"/> 4043 <template-type-parameter name="Range3T"/> 4044 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4045 <template-type-parameter name="SequenceT"/> 4046 <template-type-parameter name="Range1T"/> 4047 <template-type-parameter name="Range2T"/> 4048 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>Replace first algorithm. </purpose><description><para>Replace the first match of the search substring in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4049 4050<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4051</note> 4052</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4053</returns></overloaded-function> 4054 4055<function name="replace_first"><type>void</type><template> 4056 <template-type-parameter name="SequenceT"/> 4057 <template-type-parameter name="Range1T"/> 4058 <template-type-parameter name="Range2T"/> 4059 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace first algorithm. </purpose><description><para>replace the first match of the search substring in the input with the format string. The input sequence is modified in-place.</para><para> 4060</para></description></function> 4061<overloaded-function name="ireplace_first_copy"><signature><type>OutputIteratorT</type><template> 4062 <template-type-parameter name="OutputIteratorT"/> 4063 <template-type-parameter name="Range1T"/> 4064 <template-type-parameter name="Range2T"/> 4065 <template-type-parameter name="Range3T"/> 4066 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 4067 <template-type-parameter name="SequenceT"/> 4068 <template-type-parameter name="Range2T"/> 4069 <template-type-parameter name="Range1T"/> 4070 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype></parameter><parameter name="Format"><paramtype>const Range1T &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Replace first algorithm ( case insensitive ) </purpose><description><para>Replace the first match of the search substring in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 4071 4072<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4073</note> 4074</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4075</returns></overloaded-function> 4076 4077<function name="ireplace_first"><type>void</type><template> 4078 <template-type-parameter name="SequenceT"/> 4079 <template-type-parameter name="Range1T"/> 4080 <template-type-parameter name="Range2T"/> 4081 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Replace first algorithm ( case insensitive ) </purpose><description><para>Replace the first match of the search substring in the input with the format string. Input sequence is modified in-place. Searching is case insensitive.</para><para> 4082</para></description></function> 4083<overloaded-function name="replace_last_copy"><signature><type>OutputIteratorT</type><template> 4084 <template-type-parameter name="OutputIteratorT"/> 4085 <template-type-parameter name="Range1T"/> 4086 <template-type-parameter name="Range2T"/> 4087 <template-type-parameter name="Range3T"/> 4088 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4089 <template-type-parameter name="SequenceT"/> 4090 <template-type-parameter name="Range1T"/> 4091 <template-type-parameter name="Range2T"/> 4092 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>Replace last algorithm. </purpose><description><para>Replace the last match of the search string in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4093 4094<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4095</note> 4096</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4097</returns></overloaded-function> 4098 4099<function name="replace_last"><type>void</type><template> 4100 <template-type-parameter name="SequenceT"/> 4101 <template-type-parameter name="Range1T"/> 4102 <template-type-parameter name="Range2T"/> 4103 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace last algorithm. </purpose><description><para>Replace the last match of the search string in the input with the format string. Input sequence is modified in-place.</para><para> 4104</para></description></function> 4105<overloaded-function name="ireplace_last_copy"><signature><type>OutputIteratorT</type><template> 4106 <template-type-parameter name="OutputIteratorT"/> 4107 <template-type-parameter name="Range1T"/> 4108 <template-type-parameter name="Range2T"/> 4109 <template-type-parameter name="Range3T"/> 4110 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 4111 <template-type-parameter name="SequenceT"/> 4112 <template-type-parameter name="Range1T"/> 4113 <template-type-parameter name="Range2T"/> 4114 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Replace last algorithm ( case insensitive ) </purpose><description><para>Replace the last match of the search string in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 4115 4116<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4117</note> 4118</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4119</returns></overloaded-function> 4120 4121<function name="ireplace_last"><type>void</type><template> 4122 <template-type-parameter name="SequenceT"/> 4123 <template-type-parameter name="Range1T"/> 4124 <template-type-parameter name="Range2T"/> 4125 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Replace last algorithm ( case insensitive ) </purpose><description><para>Replace the last match of the search string in the input with the format string.The input sequence is modified in-place. Searching is case insensitive.</para><para> 4126</para></description></function> 4127<overloaded-function name="replace_nth_copy"><signature><type>OutputIteratorT</type><template> 4128 <template-type-parameter name="OutputIteratorT"/> 4129 <template-type-parameter name="Range1T"/> 4130 <template-type-parameter name="Range2T"/> 4131 <template-type-parameter name="Range3T"/> 4132 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4133 <template-type-parameter name="SequenceT"/> 4134 <template-type-parameter name="Range1T"/> 4135 <template-type-parameter name="Range2T"/> 4136 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Nth"><paramtype>int</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>Replace nth algorithm. </purpose><description><para>Replace an Nth (zero-indexed) match of the search string in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4137 4138<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4139</note> 4140</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4141</returns></overloaded-function> 4142 4143<function name="replace_nth"><type>void</type><template> 4144 <template-type-parameter name="SequenceT"/> 4145 <template-type-parameter name="Range1T"/> 4146 <template-type-parameter name="Range2T"/> 4147 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace nth algorithm. </purpose><description><para>Replace an Nth (zero-indexed) match of the search string in the input with the format string. Input sequence is modified in-place.</para><para> 4148</para></description></function> 4149<overloaded-function name="ireplace_nth_copy"><signature><type>OutputIteratorT</type><template> 4150 <template-type-parameter name="OutputIteratorT"/> 4151 <template-type-parameter name="Range1T"/> 4152 <template-type-parameter name="Range2T"/> 4153 <template-type-parameter name="Range3T"/> 4154 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 4155 <template-type-parameter name="SequenceT"/> 4156 <template-type-parameter name="Range1T"/> 4157 <template-type-parameter name="Range2T"/> 4158 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Nth"><paramtype>int</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Replace nth algorithm ( case insensitive ) </purpose><description><para>Replace an Nth (zero-indexed) match of the search string in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 4159 4160<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4161</note> 4162</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4163</returns></overloaded-function> 4164 4165<function name="ireplace_nth"><type>void</type><template> 4166 <template-type-parameter name="SequenceT"/> 4167 <template-type-parameter name="Range1T"/> 4168 <template-type-parameter name="Range2T"/> 4169 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Nth"><paramtype>int</paramtype><description><para>An index of the match to be replaced. The index is 0-based. For negative N, matches are counted from the end of string. </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Replace nth algorithm ( case insensitive ) </purpose><description><para>Replace an Nth (zero-indexed) match of the search string in the input with the format string. Input sequence is modified in-place. Searching is case insensitive.</para><para> 4170</para></description></function> 4171<overloaded-function name="replace_all_copy"><signature><type>OutputIteratorT</type><template> 4172 <template-type-parameter name="OutputIteratorT"/> 4173 <template-type-parameter name="Range1T"/> 4174 <template-type-parameter name="Range2T"/> 4175 <template-type-parameter name="Range3T"/> 4176 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4177 <template-type-parameter name="SequenceT"/> 4178 <template-type-parameter name="Range1T"/> 4179 <template-type-parameter name="Range2T"/> 4180 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter></signature><purpose>Replace all algorithm. </purpose><description><para>Replace all occurrences of the search string in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4181 4182<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4183</note> 4184</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4185</returns></overloaded-function> 4186 4187<function name="replace_all"><type>void</type><template> 4188 <template-type-parameter name="SequenceT"/> 4189 <template-type-parameter name="Range1T"/> 4190 <template-type-parameter name="Range2T"/> 4191 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace all algorithm. </purpose><description><para>Replace all occurrences of the search string in the input with the format string. The input sequence is modified in-place.</para><para> 4192</para></description></function> 4193<overloaded-function name="ireplace_all_copy"><signature><type>OutputIteratorT</type><template> 4194 <template-type-parameter name="OutputIteratorT"/> 4195 <template-type-parameter name="Range1T"/> 4196 <template-type-parameter name="Range2T"/> 4197 <template-type-parameter name="Range3T"/> 4198 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range3T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter></signature><signature><type>SequenceT</type><template> 4199 <template-type-parameter name="SequenceT"/> 4200 <template-type-parameter name="Range1T"/> 4201 <template-type-parameter name="Range2T"/> 4202 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default></parameter></signature><purpose>Replace all algorithm ( case insensitive ) </purpose><description><para>Replace all occurrences of the search string in the input with the format string. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator. Searching is case insensitive.</para><para> 4203 4204<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4205</note> 4206</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4207</returns></overloaded-function> 4208 4209<function name="ireplace_all"><type>void</type><template> 4210 <template-type-parameter name="SequenceT"/> 4211 <template-type-parameter name="Range1T"/> 4212 <template-type-parameter name="Range2T"/> 4213 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="Search"><paramtype>const Range1T &</paramtype><description><para>A substring to be searched for </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Replace all algorithm ( case insensitive ) </purpose><description><para>Replace all occurrences of the search string in the input with the format string.The input sequence is modified in-place. Searching is case insensitive.</para><para> 4214</para></description></function> 4215<overloaded-function name="replace_head_copy"><signature><type>OutputIteratorT</type><template> 4216 <template-type-parameter name="OutputIteratorT"/> 4217 <template-type-parameter name="Range1T"/> 4218 <template-type-parameter name="Range2T"/> 4219 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the head. For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4220 <template-type-parameter name="SequenceT"/> 4221 <template-type-parameter name="RangeT"/> 4222 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="N"><paramtype>int</paramtype></parameter><parameter name="Format"><paramtype>const RangeT &</paramtype></parameter></signature><purpose>Replace head algorithm. </purpose><description><para>Replace the head of the input with the given format string. The head is a prefix of a string of given size. If the sequence is shorter then required, whole string if considered to be the head. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4223 4224<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4225</note> 4226</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4227</returns></overloaded-function> 4228 4229<function name="replace_head"><type>void</type><template> 4230 <template-type-parameter name="SequenceT"/> 4231 <template-type-parameter name="RangeT"/> 4232 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the head. For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter><parameter name="Format"><paramtype>const RangeT &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace head algorithm. </purpose><description><para>Replace the head of the input with the given format string. The head is a prefix of a string of given size. If the sequence is shorter then required, the whole string is considered to be the head. The input sequence is modified in-place.</para><para> 4233</para></description></function> 4234<overloaded-function name="replace_tail_copy"><signature><type>OutputIteratorT</type><template> 4235 <template-type-parameter name="OutputIteratorT"/> 4236 <template-type-parameter name="Range1T"/> 4237 <template-type-parameter name="Range2T"/> 4238 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const Range1T &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the tail. For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter><parameter name="Format"><paramtype>const Range2T &</paramtype><description><para>A substitute string </para></description></parameter></signature><signature><type>SequenceT</type><template> 4239 <template-type-parameter name="SequenceT"/> 4240 <template-type-parameter name="RangeT"/> 4241 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="N"><paramtype>int</paramtype></parameter><parameter name="Format"><paramtype>const RangeT &</paramtype></parameter></signature><purpose>Replace tail algorithm. </purpose><description><para>Replace the tail of the input with the given format string. The tail is a suffix of a string of given size. If the sequence is shorter then required, whole string is considered to be the tail. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.</para><para> 4242 4243<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4244</note> 4245</para></description><returns><para>An output iterator pointing just after the last inserted character or a modified copy of the input</para> 4246</returns></overloaded-function> 4247 4248<function name="replace_tail"><type>void</type><template> 4249 <template-type-parameter name="SequenceT"/> 4250 <template-type-parameter name="RangeT"/> 4251 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input string </para></description></parameter><parameter name="N"><paramtype>int</paramtype><description><para>Length of the tail. For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted. </para></description></parameter><parameter name="Format"><paramtype>const RangeT &</paramtype><description><para>A substitute string </para></description></parameter><purpose>Replace tail algorithm. </purpose><description><para>Replace the tail of the input with the given format sequence. The tail is a suffix of a string of given size. If the sequence is shorter then required, the whole string is considered to be the tail. The input sequence is modified in-place.</para><para> 4252</para></description></function> 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289</namespace> 4290</namespace> 4291</header> 4292<header name="boost/algorithm/string/sequence_traits.hpp"> 4293<para>Traits defined in this header are used by various algorithms to achieve better performance for specific containers. Traits provide fail-safe defaults. If a container supports some of these features, it is possible to specialize the specific trait for this container. For lacking compilers, it is possible of define an override for a specific tester function.</para><para>Due to a language restriction, it is not currently possible to define specializations for stl containers without including the corresponding header. To decrease the overhead needed by this inclusion, user can selectively include a specialization header for a specific container. They are located in boost/algorithm/string/stl directory. Alternatively she can include boost/algorithm/string/std_collection_traits.hpp header which contains specializations for all stl containers. </para><namespace name="boost"> 4294<namespace name="algorithm"> 4295<class name="has_const_time_erase"><template> 4296 <template-type-parameter name="T"/> 4297 </template><purpose>Const time erase trait. </purpose><description><para>This trait specifies that the sequence's erase method has constant time complexity. </para></description><typedef name="type"><type>mpl::bool_< <classname>has_const_time_erase</classname>< T >::value ></type></typedef> 4298<data-member name="value" specifiers="static"><type>const bool</type></data-member> 4299</class><class name="has_const_time_insert"><template> 4300 <template-type-parameter name="T"/> 4301 </template><purpose>Const time insert trait. </purpose><description><para>This trait specifies that the sequence's insert method has constant time complexity. </para></description><typedef name="type"><type>mpl::bool_< <classname>has_const_time_insert</classname>< T >::value ></type></typedef> 4302<data-member name="value" specifiers="static"><type>const bool</type></data-member> 4303</class><class name="has_native_replace"><template> 4304 <template-type-parameter name="T"/> 4305 </template><purpose>Native replace trait. </purpose><description><para>This trait specifies that the sequence has <computeroutput>std::string</computeroutput> like replace method </para></description><typedef name="type"><type>mpl::bool_< <classname>has_native_replace</classname>< T >::value ></type></typedef> 4306<data-member name="value" specifiers="static"><type>const bool</type></data-member> 4307</class><class name="has_stable_iterators"><template> 4308 <template-type-parameter name="T"/> 4309 </template><purpose>Stable iterators trait. </purpose><description><para>This trait specifies that the sequence has stable iterators. It means that operations like insert/erase/replace do not invalidate iterators. </para></description><typedef name="type"><type>mpl::bool_< <classname>has_stable_iterators</classname>< T >::value ></type></typedef> 4310<data-member name="value" specifiers="static"><type>const bool</type></data-member> 4311</class> 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497</namespace> 4498</namespace> 4499</header> 4500<header name="boost/algorithm/string/split.hpp"> 4501<para>Defines basic split algorithms. Split algorithms can be used to divide a string into several parts according to given criteria.</para><para>Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <computeroutput>std::vector<std::string></computeroutput> or <computeroutput>std::list<boost::iterator_range<std::string::iterator>></computeroutput> </para><namespace name="boost"> 4502<namespace name="algorithm"> 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580<function name="find_all"><type>SequenceSequenceT &</type><template> 4581 <template-type-parameter name="SequenceSequenceT"/> 4582 <template-type-parameter name="Range1T"/> 4583 <template-type-parameter name="Range2T"/> 4584 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A container that can hold copies of references to the substrings </para></description></parameter><parameter name="Input"><paramtype>Range1T &&</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><purpose>Find all algorithm. </purpose><description><para>This algorithm finds all occurrences of the search string in the input.</para><para>Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <computeroutput>std::vector<std::string></computeroutput> or <computeroutput>std::list<boost::iterator_range<std::string::iterator>></computeroutput> </para><para> 4585 4586<note><para>Prior content of the result will be overwritten.</para> 4587</note> 4588<note><para>This function provides the strong exception-safety guarantee </para> 4589</note> 4590</para></description><returns><para>A reference the result</para> 4591</returns></function> 4592<function name="ifind_all"><type>SequenceSequenceT &</type><template> 4593 <template-type-parameter name="SequenceSequenceT"/> 4594 <template-type-parameter name="Range1T"/> 4595 <template-type-parameter name="Range2T"/> 4596 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A container that can hold copies of references to the substrings </para></description></parameter><parameter name="Input"><paramtype>Range1T &&</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Search"><paramtype>const Range2T &</paramtype><description><para>A substring to be searched for. </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for case insensitive comparison </para></description></parameter><purpose>Find all algorithm ( case insensitive ) </purpose><description><para>This algorithm finds all occurrences of the search string in the input. Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <computeroutput>std::vector<std::string></computeroutput> or <computeroutput>std::list<boost::iterator_range<std::string::iterator>></computeroutput> </para><para>Searching is case insensitive.</para><para> 4597 4598<note><para>Prior content of the result will be overwritten.</para> 4599</note> 4600<note><para>This function provides the strong exception-safety guarantee </para> 4601</note> 4602</para></description><returns><para>A reference the result</para> 4603</returns></function> 4604<function name="split"><type>SequenceSequenceT &</type><template> 4605 <template-type-parameter name="SequenceSequenceT"/> 4606 <template-type-parameter name="RangeT"/> 4607 <template-type-parameter name="PredicateT"/> 4608 </template><parameter name="Result"><paramtype>SequenceSequenceT &</paramtype><description><para>A container that can hold copies of references to the substrings</para></description></parameter><parameter name="Input"><paramtype>RangeT &&</paramtype><description><para>A container which will be searched. </para></description></parameter><parameter name="Pred"><paramtype>PredicateT</paramtype><description><para>A predicate to identify separators. This predicate is supposed to return true if a given element is a separator. </para></description></parameter><parameter name="eCompress"><paramtype>token_compress_mode_type</paramtype><default>token_compress_off</default><description><para>If eCompress argument is set to token_compress_on, adjacent separators are merged together. Otherwise, every two separators delimit a token. </para></description></parameter><purpose>Split algorithm. </purpose><description><para>Tokenize expression. This function is equivalent to C strtok. Input sequence is split into tokens, separated by separators. Separators are given by means of the predicate.</para><para>Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <computeroutput>std::vector<std::string></computeroutput> or <computeroutput>std::list<boost::iterator_range<std::string::iterator>></computeroutput> </para><para> 4609 4610<note><para>Prior content of the result will be overwritten.</para> 4611</note> 4612<note><para>This function provides the strong exception-safety guarantee </para> 4613</note> 4614</para></description><returns><para>A reference the result</para> 4615</returns></function> 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722</namespace> 4723</namespace> 4724</header> 4725<header name="boost/algorithm/string/std_containers_traits.hpp"> 4726<para>This file includes sequence traits for stl containers. </para></header> 4727<header name="boost/algorithm/string/trim.hpp"> 4728<para>Defines trim algorithms. Trim algorithms are used to remove trailing and leading spaces from a sequence (string). Space is recognized using given locales.</para><para>Parametric (<computeroutput>_if</computeroutput>) variants use a predicate (functor) to select which characters are to be trimmed.. Functions take a selection predicate as a parameter, which is used to determine whether a character is a space. Common predicates are provided in classification.hpp header. </para><namespace name="boost"> 4729<namespace name="algorithm"> 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776<overloaded-function name="trim_left_copy_if"><signature><type>OutputIteratorT</type><template> 4777 <template-type-parameter name="OutputIteratorT"/> 4778 <template-type-parameter name="RangeT"/> 4779 <template-type-parameter name="PredicateT"/> 4780 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input range </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter></signature><signature><type>SequenceT</type><template> 4781 <template-type-parameter name="SequenceT"/> 4782 <template-type-parameter name="PredicateT"/> 4783 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype></parameter></signature><purpose>Left trim - parametric. </purpose><description><para>Remove all leading spaces from the input. The supplied predicate is used to determine which characters are considered spaces. The result is a trimmed copy of the input. It is returned as a sequence or copied to the output iterator</para><para> 4784 4785<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4786</note> 4787</para></description><returns><para>An output iterator pointing just after the last inserted character or a copy of the input</para> 4788</returns></overloaded-function> 4789 4790<function name="trim_left_copy"><type>SequenceT</type><template> 4791 <template-type-parameter name="SequenceT"/> 4792 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>a locale used for 'space' classification </para></description></parameter><purpose>Left trim - parametric. </purpose><description><para>Remove all leading spaces from the input. The result is a trimmed copy of the input.</para><para> 4793 4794<note><para>This function provides the strong exception-safety guarantee </para> 4795</note> 4796</para></description><returns><para>A trimmed copy of the input</para> 4797</returns></function> 4798<function name="trim_left_if"><type>void</type><template> 4799 <template-type-parameter name="SequenceT"/> 4800 <template-type-parameter name="PredicateT"/> 4801 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Left trim. </purpose><description><para>Remove all leading spaces from the input. The supplied predicate is used to determine which characters are considered spaces. The input sequence is modified in-place.</para><para> 4802</para></description></function> 4803<function name="trim_left"><type>void</type><template> 4804 <template-type-parameter name="SequenceT"/> 4805 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Left trim. </purpose><description><para>Remove all leading spaces from the input. The Input sequence is modified in-place.</para><para> 4806</para></description></function> 4807<overloaded-function name="trim_right_copy_if"><signature><type>OutputIteratorT</type><template> 4808 <template-type-parameter name="OutputIteratorT"/> 4809 <template-type-parameter name="RangeT"/> 4810 <template-type-parameter name="PredicateT"/> 4811 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input range </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter></signature><signature><type>SequenceT</type><template> 4812 <template-type-parameter name="SequenceT"/> 4813 <template-type-parameter name="PredicateT"/> 4814 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype></parameter></signature><purpose>Right trim - parametric. </purpose><description><para>Remove all trailing spaces from the input.</para><para>The supplied predicate is used to determine which characters are considered spaces. The result is a trimmed copy of the input. It is returned as a sequence or copied to the output iterator</para><para> 4815 4816<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4817</note> 4818</para></description><returns><para>An output iterator pointing just after the last inserted character or a copy of the input</para> 4819</returns></overloaded-function> 4820 4821<function name="trim_right_copy"><type>SequenceT</type><template> 4822 <template-type-parameter name="SequenceT"/> 4823 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Right trim. </purpose><description><para>Remove all trailing spaces from the input. The result is a trimmed copy of the input</para><para> 4824 4825<note><para>This function provides the strong exception-safety guarantee </para> 4826</note> 4827</para></description><returns><para>A trimmed copy of the input</para> 4828</returns></function> 4829<function name="trim_right_if"><type>void</type><template> 4830 <template-type-parameter name="SequenceT"/> 4831 <template-type-parameter name="PredicateT"/> 4832 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Right trim - parametric. </purpose><description><para>Remove all trailing spaces from the input. The supplied predicate is used to determine which characters are considered spaces. The input sequence is modified in-place.</para><para> 4833</para></description></function> 4834<function name="trim_right"><type>void</type><template> 4835 <template-type-parameter name="SequenceT"/> 4836 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Right trim. </purpose><description><para>Remove all trailing spaces from the input. The input sequence is modified in-place.</para><para> 4837</para></description></function> 4838<overloaded-function name="trim_copy_if"><signature><type>OutputIteratorT</type><template> 4839 <template-type-parameter name="OutputIteratorT"/> 4840 <template-type-parameter name="RangeT"/> 4841 <template-type-parameter name="PredicateT"/> 4842 </template><parameter name="Output"><paramtype>OutputIteratorT</paramtype><description><para>An output iterator to which the result will be copied </para></description></parameter><parameter name="Input"><paramtype>const RangeT &</paramtype><description><para>An input range </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter></signature><signature><type>SequenceT</type><template> 4843 <template-type-parameter name="SequenceT"/> 4844 <template-type-parameter name="PredicateT"/> 4845 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype></parameter></signature><purpose>Trim - parametric. </purpose><description><para>Remove all trailing and leading spaces from the input. The supplied predicate is used to determine which characters are considered spaces. The result is a trimmed copy of the input. It is returned as a sequence or copied to the output iterator</para><para> 4846 4847<note><para>The second variant of this function provides the strong exception-safety guarantee </para> 4848</note> 4849</para></description><returns><para>An output iterator pointing just after the last inserted character or a copy of the input</para> 4850</returns></overloaded-function> 4851 4852<function name="trim_copy"><type>SequenceT</type><template> 4853 <template-type-parameter name="SequenceT"/> 4854 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Trim. </purpose><description><para>Remove all leading and trailing spaces from the input. The result is a trimmed copy of the input</para><para> 4855 4856<note><para>This function provides the strong exception-safety guarantee </para> 4857</note> 4858</para></description><returns><para>A trimmed copy of the input</para> 4859</returns></function> 4860<function name="trim_if"><type>void</type><template> 4861 <template-type-parameter name="SequenceT"/> 4862 <template-type-parameter name="PredicateT"/> 4863 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Trim. </purpose><description><para>Remove all leading and trailing spaces from the input. The supplied predicate is used to determine which characters are considered spaces. The input sequence is modified in-place.</para><para> 4864</para></description></function> 4865<function name="trim"><type>void</type><template> 4866 <template-type-parameter name="SequenceT"/> 4867 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Trim. </purpose><description><para>Remove all leading and trailing spaces from the input. The input sequence is modified in-place.</para><para> 4868</para></description></function> 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994</namespace> 4995</namespace> 4996</header> 4997<header name="boost/algorithm/string/trim_all.hpp"> 4998<para>Defines trim_all algorithms.</para><para>Just like <computeroutput>trim</computeroutput>, <computeroutput>trim_all</computeroutput> removes all trailing and leading spaces from a sequence (string). In addition, spaces in the middle of the sequence are truncated to just one character. Space is recognized using given locales.</para><para><computeroutput>trim_fill</computeroutput> acts as trim_all, but the spaces in the middle are replaces with a user-define sequence of character.</para><para>Parametric (<computeroutput>_if</computeroutput>) variants use a predicate (functor) to select which characters are to be trimmed.. Functions take a selection predicate as a parameter, which is used to determine whether a character is a space. Common predicates are provided in classification.hpp header. </para><namespace name="boost"> 4999<namespace name="algorithm"> 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178<function name="trim_all_copy_if"><type>SequenceT</type><template> 5179 <template-type-parameter name="SequenceT"/> 5180 <template-type-parameter name="PredicateT"/> 5181 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Trim All - parametric. </purpose><description><para>Remove all leading and trailing spaces from the input and compress all other spaces to a single character. The result is a trimmed copy of the input</para><para> 5182 5183</para></description><returns><para>A trimmed copy of the input </para> 5184</returns></function> 5185<function name="trim_all_if"><type>void</type><template> 5186 <template-type-parameter name="SequenceT"/> 5187 <template-type-parameter name="PredicateT"/> 5188 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Trim All. </purpose><description><para>Remove all leading and trailing spaces from the input and compress all other spaces to a single character. The input sequence is modified in-place.</para><para> 5189</para></description></function> 5190<function name="trim_all_copy"><type>SequenceT</type><template> 5191 <template-type-parameter name="SequenceT"/> 5192 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Trim All. </purpose><description><para>Remove all leading and trailing spaces from the input and compress all other spaces to a single character. The result is a trimmed copy of the input</para><para> 5193 5194</para></description><returns><para>A trimmed copy of the input </para> 5195</returns></function> 5196<function name="trim_all"><type>void</type><template> 5197 <template-type-parameter name="SequenceT"/> 5198 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Trim All. </purpose><description><para>Remove all leading and trailing spaces from the input and compress all other spaces to a single character. The input sequence is modified in-place.</para><para> 5199 5200</para></description><returns><para>A trimmed copy of the input </para> 5201</returns></function> 5202<function name="trim_fill_copy_if"><type>SequenceT</type><template> 5203 <template-type-parameter name="SequenceT"/> 5204 <template-type-parameter name="RangeT"/> 5205 <template-type-parameter name="PredicateT"/> 5206 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Fill"><paramtype>const RangeT &</paramtype><description><para>A string used to fill the inner spaces </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Trim Fill - parametric. </purpose><description><para>Remove all leading and trailing spaces from the input and replace all every block of consecutive spaces with a fill string defined by user. The result is a trimmed copy of the input</para><para> 5207 5208</para></description><returns><para>A trimmed copy of the input </para> 5209</returns></function> 5210<function name="trim_fill_if"><type>void</type><template> 5211 <template-type-parameter name="SequenceT"/> 5212 <template-type-parameter name="RangeT"/> 5213 <template-type-parameter name="PredicateT"/> 5214 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Fill"><paramtype>const RangeT &</paramtype><description><para>A string used to fill the inner spaces </para></description></parameter><parameter name="IsSpace"><paramtype>PredicateT</paramtype><description><para>A unary predicate identifying spaces </para></description></parameter><purpose>Trim Fill. </purpose><description><para>Remove all leading and trailing spaces from the input and replace all every block of consecutive spaces with a fill string defined by user. The input sequence is modified in-place.</para><para> 5215</para></description></function> 5216<function name="trim_fill_copy"><type>SequenceT</type><template> 5217 <template-type-parameter name="SequenceT"/> 5218 <template-type-parameter name="RangeT"/> 5219 </template><parameter name="Input"><paramtype>const SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Fill"><paramtype>const RangeT &</paramtype><description><para>A string used to fill the inner spaces </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Trim Fill. </purpose><description><para>Remove all leading and trailing spaces from the input and replace all every block of consecutive spaces with a fill string defined by user. The result is a trimmed copy of the input</para><para> 5220 5221</para></description><returns><para>A trimmed copy of the input </para> 5222</returns></function> 5223<function name="trim_fill"><type>void</type><template> 5224 <template-type-parameter name="SequenceT"/> 5225 <template-type-parameter name="RangeT"/> 5226 </template><parameter name="Input"><paramtype>SequenceT &</paramtype><description><para>An input sequence </para></description></parameter><parameter name="Fill"><paramtype>const RangeT &</paramtype><description><para>A string used to fill the inner spaces </para></description></parameter><parameter name="Loc"><paramtype>const std::locale &</paramtype><default>std::locale()</default><description><para>A locale used for 'space' classification </para></description></parameter><purpose>Trim Fill. </purpose><description><para>Remove all leading and trailing spaces from the input and replace all every block of consecutive spaces with a fill string defined by user. The input sequence is modified in-place.</para><para> 5227 5228</para></description><returns><para>A trimmed copy of the input </para> 5229</returns></function> 5230</namespace> 5231</namespace> 5232</header> 5233<header name="boost/algorithm/string_regex.hpp"> 5234<para>Cumulative include for string_algo library. In addition to string.hpp contains also regex-related stuff. </para></header> 5235</library-reference>