[#BloombergLP-bdlc-CompactedArray-remove-0d]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlc.adoc[bdlc]::xref:BloombergLP/bdlc/CompactedArray.adoc[CompactedArray]::remove
:relfileprefix: ../../../
:mrdocs:

Remove the half‐open range `[dstFirst, dstLast)]` from this array.

== Synopsis

Declared in `<bdlc_compactedarray.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlc/CompactedArray/const_iterator.adoc[CompactedArray<TYPE>::const_iterator]
remove(
    xref:BloombergLP/bdlc/CompactedArray/const_iterator.adoc[const_iterator] dstFirst,
    xref:BloombergLP/bdlc/CompactedArray/const_iterator.adoc[const_iterator] dstLast);
----

== Description

Remove from this array the elements starting at the specified `dstFirst` iterator up to, but not including, the specified `dstLast` iterator. Each element at or above `dstLast` before the removal is shifted down by `dstLast ‐ dstFirst` index positions. Return an iterator to the new position of the element that was referred to by `dstLast`, or `end()` if `dstLast == end()`. The behavior is undefined unless `dstFirst` and `dstLast` are iterators over this array, and `dstFirst <= dstLast`.

== Return Value

iterator to the new position of the former `dstLast` element, or `end()` if `dstLast == end()`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *dstFirst*
| iterator to the first element to remove
| *dstLast*
| iterator one past the last element to remove
|===


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