boostorg/algorithm
1
0
Fork 1
mirror of https://github.com/boostorg/algorithm.git synced 2025-07-12 03:56:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Comments cleanup

Browse Source 
[SVN r23447]
This commit is contained in:
Pavol Droba
2004-07-11 22:07:00 +00:00
parent 22b59d1848
commit 029851b0ce
14 changed files with 493 additions and 624 deletions
Download Patch File Download Diff File Expand all files Collapse all files

263
include/boost/algorithm/string/erase.hpp
View File

@ -29,13 +29,14 @@ namespace boost {
//! Erase range algorithm
/*!
Remove the given range from the input sequence.
The result is copied to the given output iterator.
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 an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param SearchRange A range in the input to be substituted
\return An output iterator pointing just after last inserted character
\param SearchRange A range in the input to be removed
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<typename OutputIteratorT, typename CollectionT>
inline OutputIteratorT erase_range_copy(
@ -54,12 +55,7 @@ namespace boost {
//! Erase range algorithm
/*!
Remove the given range from the input sequence.
The result is a modified copy of the input.
\param Input An input sequence
\param SearchRange A range in the input to be substituted
\return A modified copy of the input
\overload
*/
template<typename SequenceT>
inline SequenceT erase_range_copy(
@ -76,11 +72,11 @@ namespace boost {
//! Erase range algorithm
/*!
Remove the given range from the input sequence.
Remove the given range from the input.
The input sequence is modified in-place.
\param Input An input sequence
\param SearchRange A range in the input to be substituted
\param SearchRange A range in the input to be removed
*/
template<typename SequenceT>
inline void erase_range(
@ -99,13 +95,15 @@ namespace boost {
//! Erase first algorithm
/*!
Remove the first match of the search sequence from the input.
The result is copied to the given output iterator.
Remove the first match of the string from the input.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
H \param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\return An output iterator pointing just after last inserted character
\param Output A output iterator to which the result will be copied
\param Input An input string
\param Search A string to be searched for
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -125,12 +123,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase first algorithm
/*!
Remove the first match of the search sequence from the input.
The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT erase_first_copy(
@ -145,10 +138,10 @@ H \param Output A output iterator to which the result will be copied
//! Erase first algorithm
/*!
Remove the first match of the search sequence from the input.
Remove the first match of the string from the input.
The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param Search A string to be searched for.
*/
template<typename SequenceT, typename CollectionT>
@ -166,14 +159,17 @@ H \param Output A output iterator to which the result will be copied
//! Erase first algorithm ( case insensitive )
/*!
Remove the first match of the search sequence from the input.
The result is copied to the given output iterator. Searching is case insensitive.
Remove the first match of the string from the input.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -194,13 +190,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase first algorithm ( case insensitive )
/*!
Remove the first match of the search sequence from the input.
The result is a modified copy of the input. Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT ierase_first_copy(
@ -216,11 +206,11 @@ H \param Output A output iterator to which the result will be copied
//! Erase first algorithm ( case insensitive )
/*!
Remove the first match of the search sequence from the input.
Remove the first match of the string from the input.
The input sequence is modified in-place. Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Loc a locale used for case insensitive comparison
*/
template<typename SequenceT, typename CollectionT>
@ -239,13 +229,15 @@ H \param Output A output iterator to which the result will be copied
//! Erase last algorithm
/*!
Remove the last match of the search sequence from the input.
The result is copied to the given output iterator.
Remove the last match of the string from the input.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\return An output iterator pointing just after last inserted character
\param Input An input string
\param Search A string to be searched for.
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -265,12 +257,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase last algorithm
/*!
Remove the last match of the search sequence from the input.
The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT erase_last_copy(
@ -285,11 +272,11 @@ H \param Output A output iterator to which the result will be copied
//! Erase last algorithm
/*!
Remove the last match of the search sequence from the input.
Remove the last match of the string from the input.
The input sequence is modified in-place.
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
*/
template<typename SequenceT, typename CollectionT>
inline void erase_last(
@ -306,14 +293,17 @@ H \param Output A output iterator to which the result will be copied
//! Erase last algorithm ( case insensitive )
/*!
Remove the last match of the search sequence from the input.
The result is copied to the given output iterator. Searching is case insensitive.
Remove the last match of the string from the input.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -334,13 +324,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase last algorithm ( case insensitive )
/*!
Remove the last match of the search sequence from the input.
The result is a modified copy of the input. Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT ierase_last_copy(
@ -356,11 +340,11 @@ H \param Output A output iterator to which the result will be copied
//! Erase last algorithm ( case insensitive )
/*!
Remove the last match of the search sequence from the input.
Remove the last match of the string from the input.
The input sequence is modified in-place. Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Loc a locale used for case insensitive comparison
*/
template<typename SequenceT, typename CollectionT>
@ -379,14 +363,17 @@ H \param Output A output iterator to which the result will be copied
//! Erase nth algorithm
/*!
Remove the Nth match of the search sequence in the input.
The result is copied to the given output iterator.
Remove the Nth match of the string in the input.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Nth An index of the match to be replaced. The index is 0-based.
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -407,13 +394,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase nth algorithm
/*!
Remove the Nth match of the search sequence in the input.
The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT erase_nth_copy(
@ -429,10 +410,10 @@ H \param Output A output iterator to which the result will be copied
//! Erase nth algorithm
/*!
Remove the Nth match of the search sequence in the input.
Remove the Nth match of the string in the input.
The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
*/
@ -452,15 +433,18 @@ H \param Output A output iterator to which the result will be copied
//! Erase nth algorithm ( case insensitive )
/*!
Remove the Nth match of the search sequence in the input.
The result is copied to the given output iterator. Searching is case insensitive.
Remove the Nth match of the string in the input.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -482,14 +466,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase nth algorithm
/*!
Remove the Nth match of the search sequence in the input.
The result is a modified copy of the input. Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT ierase_nth_copy(
@ -506,10 +483,10 @@ H \param Output A output iterator to which the result will be copied
//! Erase nth algorithm
/*!
Remove the Nth match of the search sequence in the input.
Remove the Nth match of the string in the input.
The input sequence is modified in-place. Searching is case insensitive.
\param Input An input sequence
\param Input An input string
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
\param Loc a locale used for case insensitive comparison
@ -532,13 +509,17 @@ H \param Output A output iterator to which the result will be copied
//! Erase all algorithm
/*!
Remove all the occurrences of the search sequence from the input.
The result is copied to the given output iterator.
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 an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -558,12 +539,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase all algorithm
/*!
Remove all the occurrences of the search sequence from the input.
The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT erase_all_copy(
@ -578,10 +554,10 @@ H \param Output A output iterator to which the result will be copied
//! Erase all algorithm
/*!
Remove all the occurrences of the search sequence from the input.
Remove all the occurrences of the string from the input.
The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param Search A string to be searched for.
*/
template<typename SequenceT, typename CollectionT>
@ -599,14 +575,18 @@ H \param Output A output iterator to which the result will be copied
//! Erase all algorithm ( case insensitive )
/*!
Remove all the occurrences of the search sequence from the input.
The result is copied to the given output iterator. Searching is case insensitive.
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 an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -627,13 +607,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase all algorithm ( case insensitive )
/*!
Remove all the occurrences of the search sequence from the input.
The result is a modified copy of the input. Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT ierase_all_copy(
@ -649,10 +623,10 @@ H \param Output A output iterator to which the result will be copied
//! Erase all algorithm ( case insensitive )
/*!
Remove all the occurrences of the search sequence from the input.
Remove all the occurrences of the string from the input.
The input sequence is modified in-place. Searching is case insensitive.
\param Input An input sequence
\param Input An input string
\param Search A string to be searched for.
\param Loc a locale used for case insensitive comparison
*/
@ -674,12 +648,15 @@ H \param Output A output iterator to which the result will be copied
/*!
Remove the head from the input. Head is a prefix of a seqence of given size.
If the sequence is shorter then required, whole sequence if
considered to be the head. The result is copied to the given output iterator.
considered to be the head. The result is a modified copy of the input.
It is returned as a sequence or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Input An input string
\param N A length of the head
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -698,13 +675,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase head algorithm
/*!
Remove the head from the input. Head is a prefix of a seqence of given size.
If the sequence is shorter then required, whole sequence if
considered to be the head. The result is a modified copy of the input.
\param Input An input sequence
\param N A length of the head
\return A modified copy of the input
\overload
*/
template<typename SequenceT>
inline SequenceT erase_head_copy(
@ -723,7 +694,7 @@ H \param Output A output iterator to which the result will be copied
If the sequence is shorter then required, whole sequence if
considered to be the head. The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param N A length of the head
*/
template<typename SequenceT>
@ -743,12 +714,16 @@ H \param Output A output iterator to which the result will be copied
/*!
Remove the tail from the input. Tail is a suffix of a seqence of given size.
If the sequence is shorter then required, whole sequence if
considered to be the tail. The result is copied to the given output iterator.
considered to be the tail.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Input An input string
\param N A length of the head
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -767,13 +742,7 @@ H \param Output A output iterator to which the result will be copied
//! Erase tail algorithm
/*!
Remove the tail from the input. Tail is a suffix of a seqence of given size.
If the sequence is shorter then required, whole sequence is
considered to be the tail. The result is a modified copy of the input.
\param Input An input sequence
\param N A length of the head
\return A modified copy of the input
\overload
*/
template<typename SequenceT>
inline SequenceT erase_tail_copy(
@ -792,7 +761,7 @@ H \param Output A output iterator to which the result will be copied
If the sequence is shorter then required, whole sequence is
considered to be the tail. The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param N A length of the head
*/
template<typename SequenceT>