tlx
erase_all.hpp
Go to the documentation of this file.
1 /*******************************************************************************
2  * tlx/string/erase_all.hpp
3  *
4  * Part of tlx - http://panthema.net/tlx
5  *
6  * Copyright (C) 2007-2017 Timo Bingmann <tb@panthema.net>
7  *
8  * All rights reserved. Published under the Boost Software License, Version 1.0
9  ******************************************************************************/
10 
11 #ifndef TLX_STRING_ERASE_ALL_HEADER
12 #define TLX_STRING_ERASE_ALL_HEADER
13 
14 #include <string>
15 
16 namespace tlx {
17 
18 //! \addtogroup tlx_string
19 //! \{
20 
21 /******************************************************************************/
22 // erase_all() in-place
23 
24 /*!
25  * Remove all occurrences of the given character in-place.
26  *
27  * \param str string to process
28  * \param drop remove this character
29  * \return reference to the modified string
30  */
31 std::string& erase_all(std::string* str, char drop = ' ');
32 
33 /*!
34  * Remove all occurrences of the given characters in-place.
35  *
36  * \param str string to process
37  * \param drop remove these characters
38  * \return reference to the modified string
39  */
40 std::string& erase_all(std::string* str, const char* drop);
41 
42 /*!
43  * Remove all occurrences of the given characters in-place.
44  *
45  * \param str string to process
46  * \param drop remove these characters
47  * \return reference to the modified string
48  */
49 std::string& erase_all(std::string* str, const std::string& drop);
50 
51 /******************************************************************************/
52 // erase_all() copy
53 
54 /*!
55  * Remove all occurrences of the given character, return copy of string.
56  *
57  * \param str string to process
58  * \param drop remove this character
59  * \return copy of string possibly with less characters
60  */
61 std::string erase_all(const std::string& str, char drop = ' ');
62 
63 /*!
64  * Remove all occurrences of the given characters, return copy of string.
65  *
66  * \param str string to process
67  * \param drop remove these characters
68  * \return copy of string possibly with less characters
69  */
70 std::string erase_all(const std::string& str, const char* drop);
71 
72 /*!
73  * Remove all occurrences of the given characters, return copy of string.
74  *
75  * \param str string to process
76  * \param drop remove these characters
77  * \return copy of string possibly with less characters
78  */
79 std::string erase_all(const std::string& str, const std::string& drop);
80 
81 //! \}
82 
83 } // namespace tlx
84 
85 #endif // !TLX_STRING_ERASE_ALL_HEADER
86 
87 /******************************************************************************/
tlx::erase_all
std::string & erase_all(std::string *str, char drop)
Remove all occurrences of the given character in-place.
Definition: erase_all.cpp:18