Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is an old version of boost. Click here for the latest version's documentation home page.
PrevUpHomeNext

Function template find_nth

boost::algorithm::find_nth — Find n-th algorithm.

Synopsis

template<typename Range1T, typename Range2T> 
  iterator_range< typename range_iterator< Range1T >::type > 
  find_nth(Range1T & Input, const Range2T & Search, int Nth);

Description

Search for the n-th (zero-indexed) occurrence of the substring in the input.

Parameters:

Input

A string which will be searched.

Nth

An index (zero-indexed) of the match to be found. For negative N, the matches are counted from the end of string.

Search

A substring to be searched for.

Returns:

An iterator_range delimiting the match. Returned iterator is either Range1T::iterator or Range1T::const_iterator, depending on the constness of the input parameter.


PrevUpHomeNext