boostorg/algorithm
1
0
Fork 1
mirror of https://github.com/boostorg/algorithm.git synced 2025-07-06 09:16:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Grouping documentation for overloaded functions

Browse Source 
[SVN r23385]
This commit is contained in:
Pavol Droba
2004-07-06 21:28:01 +00:00
parent 8242b4ba5a
commit 22b59d1848
3 changed files with 56 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
include/boost/algorithm/string/case_conv.hpp
View File

@ -31,12 +31,15 @@ namespace boost {
//! Convert to lower case
/*!
Each element of the input sequence is converted to lower
case. The result is copied to the given output iterator.
case. The result is a copy of the input converted to lower case.
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 collection
\param Loc A locale used for conversion
\return An output iterator pointing just after last inserted character
\return
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT>
inline OutputIteratorT
@ -55,12 +58,7 @@ namespace boost {
//! Convert to lower case
/*!
Each element of the input sequence is converted to lower
case. The result is a copy of the input converted to lower case.
\param Input An input sequence
\param Loc a locale used for conversion
\return A copy of the input converted to lower case
\overload
*/
template<typename SequenceT>
inline SequenceT to_lower_copy(
@ -104,12 +102,15 @@ namespace boost {
//! Convert to upper case
/*!
Each element of the input sequence is converted to upper
case. The result is copied to the given output iterator.
case. The result is a copy of the input converted to upper case.
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 collection
\param Loc a locale used for conversion
\return An output iterator pointing just after last inserted character
\param Loc A locale used for conversion
\return
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT>
inline OutputIteratorT
@ -128,12 +129,7 @@ namespace boost {
//! Convert to upper case
/*!
Each element of the input sequence is converted to upper
case. The result is a copy if the input converted to upper case.
\param Input An input sequence
\param Loc a locale used for conversion
\return A copy of the input converted to upper case
\overload
*/
template<typename SequenceT>
inline SequenceT to_upper_copy(

40
include/boost/algorithm/string/predicate.hpp
View File

@ -34,6 +34,8 @@ namespace boost {
/*!
This predicate holds when the test collection is a prefix of the Input.
In other word, if the input starts with the test.
When optional predicate is specified, it is used for character-wise
comparison.
\param Input An input sequence
\param Test A test sequence
@ -69,12 +71,7 @@ namespace boost {
//! 'Starts with' predicate
/*!
This predicate holds when the test container is a prefix of the Input.
In other words, if the input starts with the test.
\param Input An input sequence
\param Test A test sequence
\return A result of the test
\overload
*/
template<typename Collection1T, typename Collection2T>
inline bool starts_with(
@ -111,6 +108,9 @@ namespace boost {
/*!
This predicate holds when the test container is a suffix of the Input.
In other word, if the input ends with the test.
When optional predicate is specified, it is used for character-wise
comparison.
\param Input An input sequence
\param Test A test sequence
@ -141,12 +141,7 @@ namespace boost {
//! 'Ends with' predicate
/*!
This predicate holds when the test container is a suffix of the Input.
In other word, if the input ends with the test.
\param Input An input sequence
\param Test A test sequence
\return A result of the test
\overload
*/
template<typename Collection1T, typename Collection2T>
inline bool ends_with(
@ -181,6 +176,8 @@ namespace boost {
//! 'Contains' predicate
/*!
This predicate holds when the test container is contained in the Input.
When optional predicate is specified, it is used for character-wise
comparison.
\param Input An input sequence
\param Test A test sequence
@ -204,11 +201,7 @@ namespace boost {
//! 'Contains' predicate
/*!
This predicate holds when the test container is contained in the Input.
\param Input An input sequence
\param Test A test sequence
\return A result of the test
\overload
*/
template<typename Collection1T, typename Collection2T>
inline bool contains(
@ -243,11 +236,15 @@ namespace boost {
/*!
This predicate holds when the test container is equal to the
input container i.e. all elements in both containers are same.
When optional predicate is specified, it is used for character-wise
comparison.
\param Input An input sequence
\param Test A test sequence
\param Comp An element comparison predicate
\return A result of the test
\note This is two-way version of \c std::equal algorithm
*/
template<typename Collection1T, typename Collection2T, typename PredicateT>
inline bool equals(
@ -278,14 +275,7 @@ namespace boost {
//! 'Equals' predicate
/*!
This predicate holds when the test container is equal to the
input container i.e. all elements in both containers are same.
\param Input An input sequence
\param Test A test sequence
\return A result of the test
\note This is two-way version of \c std::equal algorithm
\overload
*/
template<typename Collection1T, typename Collection2T>
inline bool equals(

47
include/boost/algorithm/string/trim.hpp
View File

@ -38,12 +38,15 @@ namespace boost {
/*!
Remove all leading spaces from the input. Supplied predicate
is used to determine which character is a space.
The result is copied to the given output iterator.
The result is a trimmed copy if 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 collection
\param IsSpace An unary predicate identifying spaces
\return An output iterator pointing just after last inserted character
\return
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_left_copy_if(
@ -64,13 +67,7 @@ namespace boost {
//! Left trim - parametric
/*!
Remove all leading spaces from the input. Supplied predicate
is used to determine which character is a space.
The result is a trimmed copy if the input
\param Input An input sequence
\param IsSpace An unary predicate identifying spaces
\return A trimmed copy if the input
\overload
*/
template<typename SequenceT, typename PredicateT>
inline SequenceT trim_left_copy_if(const SequenceT& Input, PredicateT IsSpace)
@ -86,7 +83,7 @@ namespace boost {
//! Left trim - parametric
/*!
Remove all leading spaces from the input.
The result is a trimmed copy if the input
The result is a trimmed copy if the input.
\param Input An input sequence
\param Loc a locale used for 'space' classification
@ -143,12 +140,15 @@ namespace boost {
/*!
Remove all trailing spaces from the input. Supplied predicate
is used to determine which character is a space.
The result is copied to the given output iterator.
The result is a trimmed copy if 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 collection
\param IsSpace An unary predicate identifying spaces
\return An output iterator pointing just after last inserted character
\return
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_right_copy_if(
@ -169,13 +169,7 @@ namespace boost {
//! Right trim - parametric
/*!
Remove all trailing spaces from the input. Supplied predicate
is used to determine which character is a space.
The result is a trimmed copy if the input
\param Input An input Sequence
\param IsSpace An unary predicate identifying spaces
\return A trimmed copy if the input
\overload
*/
template<typename SequenceT, typename PredicateT>
inline SequenceT trim_right_copy_if(const SequenceT& Input, PredicateT IsSpace)
@ -252,12 +246,15 @@ namespace boost {
/*!
Remove all trailing and leading spaces from the input.
Supplied predicate is used to determine which character is a space.
The result is copied to the given output iterator.
The result is a trimmed copy if 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 collection
\param IsSpace An unary predicate identifying spaces
\return An output iterator pointing just after last inserted character
\return
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_copy_if(
@ -284,13 +281,7 @@ namespace boost {
//! Trim - parametric
/*!
Remove all leading and trailing spaces from the input.
Supplied predicate is used to determine which character is a space.
The result is a trimmed copy if the input
\param Input An input sequence
\param IsSpace An unary predicate identifying spaces
\return A trimmed copy if the input
\overload
*/
template<typename SequenceT, typename PredicateT>
inline SequenceT trim_copy_if(const SequenceT& Input, PredicateT IsSpace)