feedc0de/boost_algorithm
1
0
Fork 0
forked from boostorg/algorithm
Code Pull Requests Activity

added comments about negative indexes in _nth, _tail and _head algorithms

Browse Source 
[SVN r33255]
This commit is contained in:
Pavol Droba
2006-03-07 13:09:36 +00:00
parent 603223fd3d
commit 24b55c67f7
4 changed files with 39 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/boost/algorithm/string/find.hpp
View File

@ -176,6 +176,7 @@ namespace boost {
\param Input A string which will be searched.
\param Search A substring to be searched for.
\param Nth An index (zero-indexed) of the match to be found.
For negative N, the matches are counted from the end of string.
\return
An \c iterator_range delimiting the match.
Returned iterator is either \c Range1T::iterator or
@ -196,12 +197,13 @@ namespace boost {
//! Find n-th algorithm ( case insensitive ).
/*!
Search for the n-th (zero-indexed) occurence of the substring in the
Search for the n-th (zero-indexed) occurrence of the substring in the
input. Searching is case insensitive.
\param Input A string which will be searched.
\param Search A substring to be searched for.
\param Nth An index (zero-indexed) of the match to be found.
\param Nth An index (zero-indexed) of the match to be found.
For negative N, the matches are counted from the end of string.
\param Loc A locale used for case insensitive comparison
\return
An \c iterator_range delimiting the match.
@ -235,6 +237,8 @@ namespace boost {
\param Input An input string
\param N Length of the head
For N>=0, at most N characters are extracted.
For N<0, size(Input)-|N| characters are extracted.
\return
An \c iterator_range delimiting the match.
Returned iterator is either \c Range1T::iterator or
@ -263,7 +267,9 @@ namespace boost {
to be the tail.
\param Input An input string
\param N Length of the tail
\param N Length of the tail.
For N>=0, at most N characters are extracted.
For N<0, size(Input)-|N| characters are extracted.
\return
An \c iterator_range delimiting the match.
Returned iterator is either \c RangeT::iterator or