| Home | Libraries | People | FAQ | More

## Function template split

boost::algorithm::split — Split algorithm.

## Synopsis

    template<typename SequenceSequenceT, typename RangeT, typename PredicateT>
      SequenceSequenceT &
      split(SequenceSequenceT & Result, RangeT & Input, PredicateT Pred,
            token_compress_mode_type eCompress = token_compress_off);

## Description

Tokenize expression. This function is equivalent to C strtok. Input sequence is split into tokens, separated by separators. Separators are given by means of the predicate.

Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are `std::vector<std::string>` or `std::list<boost::iterator_range<std::string::iterator>>`

Parameters: |
`Input` | A container which will be searched.
`Pred` | A predicate to identify separators. This predicate is supposed to return true if a given element is a separator.
`Result` | A container that can hold copies of references to the substrings
`eCompress` | If eCompress argument is set to token_compress_on, adjacent separators are merged together. Otherwise, every two separators delimit a token.
Returns: | A reference the result
Notes: | Prior content of the result will be overwritten. This function provides the strong exception-safety guarantee