Front Page / Algorithms / Transformation Algorithms / remove

# remove

### Synopsis

    template<
          typename Sequence
        , typename T
        , typename In = unspecified
        >
    struct remove
    {
        typedef unspecified type;
    };

### Description

Returns a new sequence that contains all elements from [`begin<Sequence>::type`, `end<Sequence>::type`) range except those that are identical to `T`.

[Note: This wording applies to a no-inserter version(s) of the algorithm. See the Expression semantics subsection for a precise specification of the algorithm's details in all cases — end note]

### Header

    #include <boost/mpl/remove.hpp>

### Model of

Reversible Algorithm

### Parameters

Parameter | Requirement | Description
--- | --- | ---
`Sequence` | Forward Sequence | An original sequence.
`T` | Any type | A type to be removed.
`In` | Inserter | An inserter.

### Expression semantics

The semantics of an expression are defined only where they differ from, or are not defined in Reversible Algorithm.

For any Forward Sequence `s`, an Inserter `in`, and arbitrary type `x`:

    typedef remove<s,x,in>::type r;

Return type: | A type.
Semantics: | Equivalent to
    typedef remove_if< s,is_same<_,x>,in >::type r;

### Complexity

Linear. Performs exactly `size<s>::value` comparisons for equality, and at most `size<s>::value` insertions.

### Example

    typedef vector<int,float,char,float,float,double>::type types;
    typedef remove< types,float >::type result;

    BOOST_MPL_ASSERT(( equal< result, vector<int,char,double> > ));

### See also

Transformation Algorithms, Reversible Algorithm, `reverse_remove`, `remove_if`, `copy`, `replace`