Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/id999800-bb.html @ 46

Last change on this file since 46 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 4.8 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Function template join_if</title>
5<link rel="stylesheet" href="boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7<link rel="start" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8<link rel="up" href="string_algo/reference.html#header.boost.algorithm.string.regex.hpp" title="Header &lt;boost/algorithm/string/regex.hpp&gt;">
9<link rel="prev" href="boost/algorithm/split_regex.html" title="Function template split_regex">
10<link rel="next" href="boost/algorithm/regex_finder.html" title="Function template regex_finder">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../boost.png"></td>
15<td align="center"><a href="../../index.htm">Home</a></td>
16<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../people/people.htm">People</a></td>
18<td align="center"><a href="../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="boost/algorithm/split_regex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#header.boost.algorithm.string.regex.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="boost/algorithm/regex_finder.html"><img src="images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="id999800-bb"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template join_if</span></h2>
29<p>boost::algorithm::join_if &#8212; Conditional join algorithm. </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">
33<span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> SequenceSequenceT, <span class="bold"><strong>typename</strong></span> Range1T, <span class="bold"><strong>typename</strong></span> CharT,
34         <span class="bold"><strong>typename</strong></span> RegexTraitsT&gt; 
35  <span class="type">range_value&lt; SequenceSequenceT &gt;::type</span> 
36  join_if(<span class="bold"><strong>const</strong></span> SequenceSequenceT &amp; Input, Range1T &amp; Separator,
37          <span class="bold"><strong>const</strong></span> basic_regex&lt; CharT, RegexTraitsT &gt; &amp; Rx,
38          match_flag_type Flags = match_default);</pre></div>
39<div class="refsect1" lang="en">
40<a name="id1699737"></a><h2>Description</h2>
41<p>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</p>
42<p>This is a specialization of join_if algorithm.</p>
43<p>
44
45
46</p>
47<div class="variablelist"><table border="0">
48<col align="left" valign="top">
49<tbody>
50<tr>
51<td>
52<span class="term">Parameters:</span></td>
53<td><div class="variablelist"><table border="0">
54<col align="left" valign="top">
55<tbody>
56<tr>
57<td>
58<span class="term"><code class="computeroutput">Flags</code></span></td>
59<td><p>Regex options </p></td>
60</tr>
61<tr>
62<td>
63<span class="term"><code class="computeroutput">Input</code></span></td>
64<td><p>A container that holds the input strings. It must be a container-of-containers. </p></td>
65</tr>
66<tr>
67<td>
68<span class="term"><code class="computeroutput">Rx</code></span></td>
69<td><p>A regular expression </p></td>
70</tr>
71<tr>
72<td>
73<span class="term"><code class="computeroutput">Separator</code></span></td>
74<td><p>A string that will separate the joined segments. </p></td>
75</tr>
76</tbody>
77</table></div></td>
78</tr>
79<tr>
80<td>
81<span class="term">Returns:</span></td>
82<td><p>Concatenated string.</p></td>
83</tr>
84<tr>
85<td>
86<span class="term">Notes:</span></td>
87<td><p>This function provides the strong exception-safety guarantee </p></td>
88</tr>
89</tbody>
90</table></div>
91</div>
92</div>
93<table width="100%"><tr>
94<td align="left"></td>
95<td align="right"><small>Copyright © 2002-2004 Pavol Droba</small></td>
96</tr></table>
97<hr>
98<div class="spirit-nav">
99<a accesskey="p" href="boost/algorithm/split_regex.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="string_algo/reference.html#header.boost.algorithm.string.regex.hpp"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="boost/algorithm/regex_finder.html"><img src="images/next.png" alt="Next"></a>
100</div>
101</body>
102</html>
Note: See TracBrowser for help on using the repository browser.