[#BloombergLP-bslalg-DequePrimitives-01-erase-0f]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslalg.adoc[bslalg]::xref:BloombergLP/bslalg/DequePrimitives-01.adoc[DequePrimitives]::erase
:relfileprefix: ../../../
:mrdocs:

Erase a range of elements from a deque and close the gap.

== Synopsis

Declared in `<bslalg_dequeprimitives.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class ALLOCATOR>
static
xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[DequePrimitives<VALUE_TYPE, BLOCK_LENGTH>::Iterator]
erase(
    xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[Iterator]* toBegin,
    xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[Iterator]* toEnd,
    xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[Iterator] fromBegin,
    xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[Iterator] first,
    xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[Iterator] last,
    xref:BloombergLP/bslalg/DequePrimitives-01/Iterator.adoc[Iterator] fromEnd,
    ALLOCATOR allocator);
----

== Description

Call the destructor on each of the elements of a deque of parameterized `VALUE_TYPE` in the specified range `[first .. last)]`. Shift the elements to fill up the empty space after the erasure, using the smaller of the range defined by `[fromBegin .. first)]` and `[last .. fromEnd)]` after the erasure. Load in the specified `toBegin` and `toEnd` the new boundaries of the deque after erasure and return an iterator pointing to the element immediately following the removed elements. The behavior is undefined unless `fromBegin <= first <= last <= fromEnd`.

== Return Value

iterator to the element immediately following the removed elements

== Parameters

[cols="1,4"]
|===
| Name| Description
| *toBegin*
| loads the new beginning iterator of the deque
| *toEnd*
| loads the new end iterator of the deque
| *fromBegin*
| current beginning of the deque
| *first*
| beginning of the range to erase
| *last*
| end of the range to erase (one past the last)
| *fromEnd*
| current end of the deque
| *allocator*
| allocator used to destroy elements
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#