Namespaces
Variants
Views
Actions

std::list<T,Allocator>::insert_range

From cppreference.com
< cpp‎ | container‎ | list
Revision as of 15:14, 27 July 2023 by Space Mission (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
 
 
 
 
template< container-compatible-range<T> R >
iterator insert_range( const_iterator pos, R&& rg );
(since C++23)

Inserts, in non-reversing order, copies of elements in rg before pos.

No iterators or references are invalidated.

Each iterator in the range rg is dereferenced exactly once.

rg must not overlap with the container. Otherwise, the behavior is undefined.

Contents

[edit] Parameters

pos - iterator before which the content will be inserted (pos may be the end() iterator)
rg - a container compatible range, that is, an input_range whose elements are convertible to T
Type requirements
-
T must be EmplaceConstructible into list from *ranges::begin(rg). Otherwise, the behavior is undefined.

[edit] Return value

An iterator that points at the copy of the first element inserted into list or at pos if rg is empty.

Notes

Feature-test macro Value Std Feature
__cpp_lib_containers_ranges 202202L (C++23) Ranges-aware construction and insertion

[edit] Example

#include <algorithm>
#include <cassert>
#include <iterator>
#include <list>
#include <vector>
 
int main()
{
    auto container = std::list{1, 2, 3, 4};
    auto pos = std::next(container.begin(), 2);
    assert(*pos == 3);
    const auto rg = std::vector{-1, -2, -3};
 
#ifdef __cpp_lib_containers_ranges
    container.insert_range(pos, rg);
#else
    container.insert(pos, rg.cbegin(), rg.cend());
#endif
    assert(std::ranges::equal(container, std::list{1, 2, -1, -2, -3, 3, 4}));
}

[edit] See also

inserts elements
(public member function)
adds a range of elements to the beginning
(public member function)
adds a range of elements to the end
(public member function)