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

Function template erase_head
PrevUpHomeNext

Function template erase_head

boost::erase_head — Erase head algorithm.

Synopsis

// In header: <boost/algorithm/string/erase.hpp>


template<typename SequenceT> void erase_head(SequenceT & Input, int N);

Description

Remove the head from the input. The head is a prefix of a sequence of given size. If the sequence is shorter then required, the whole string is considered to be the head. The input sequence is modified in-place.

Parameters:

Input

An input string

N

Length of the head For N>=0, at most N characters are extracted. For N<0, size(Input)-|N| characters are extracted.

Copyright © 2002-2004 Pavol Droba

Use, modification and distribution is subject to the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

PrevUpHomeNext