Boost C++ Libraries 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.

Function replace_head_copy

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


template<typename OutputIteratorT, typename Collection1T, 
typename Collection2T> 
replace_head_copy(OutputIteratorT Output, const Collection1T & Input, 
unsigned int N, const Collection2T & Format);
template<typename SequenceT, typename CollectionT> 
SequenceT replace_head_copy(const SequenceT & Input, unsigned int N, 
const CollectionT & Format);


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.



A substitute string


An input string


Length of the head


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