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 to view this page for the latest version.

remove(ConvertibleOrRange const &)

Remove value corresponding to an object convertible to it or a range of values from the container.

Description

In contrast to the std::set or std::map erase() method it removes values equal to these passed as a range. Furthermore, this method removes only one value for each one passed in the range, not all equal values.

Synopsis

template<typename ConvertibleOrRange>
size_type remove(ConvertibleOrRange const & conv_or_rng)

Parameter(s)

Type	Name	Description
`ConvertibleOrRange const &`	`conv_or_rng`	The object of type convertible to value_type or a range of values.

Returns

The number of removed values.

Throws

If Value copy constructor or copy assignment throws.
If allocation throws or returns invalid value.

	Warning
	This operation only guarantees that there will be no memory leaks. After an exception is thrown the R-tree may be left in an inconsistent state, elements must not be inserted or removed. Other operations are allowed however some of them may return invalid data.