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 the documentation for an old version of boost. Click here for the latest Boost documentation.
PrevUpHomeNext

Function replace_head_copy

boost::algorithm::replace_head_copy — Replace head algorithm.

Synopsis

template<typename OutputIteratorT, typename Range1T, typename Range2T> 
  OutputIteratorT 
  replace_head_copy(OutputIteratorT Output, const Range1T & Input, 
                    unsigned int N, const Range2T & Format);
template<typename SequenceT, typename RangeT> 
  SequenceT replace_head_copy(const SequenceT & Input, unsigned int N, 
                              const RangeT & Format);

Description

Replace the head of the input with the given format string. The head is a prefix of a string of given size. If the sequence is shorter then required, whole string if considered to be the head. The result is a modified copy of the input. It is returned as a sequence or copied to the output iterator.

Parameters

Format

A substitute string

Input

An input string

N

Length of the head

Output

An output iterator to which the result will be copied

Returns: An output iterator pointing just after the last inserted character or a modified copy of the input
Notes: The second variant of this function provides the strong exception-safety guarantee

Copyright © 2002-2004 Pavol Droba
PrevUpHomeNext