std::ranges::swap_ranges() algorithm
- od C++20
- Simplified
- Detailed
// (1)
constexpr swap_ranges_result<I1, I2>
swap_ranges( I1 first1, S1 last1, I2 first2, S2 last2 );
// (2)
constexpr swap_ranges_result<ranges::borrowed_iterator_t<R1>,
ranges::borrowed_iterator_t<R2>>
swap_ranges( R1&& r1, R2&& r2 );
The type of arguments are generic and have the following constraints:
I1
,I2
-std::input_iterator
S1
,S2
-std::sentinel_for<I1>
,std::sentinel_for<I2>
R1
,R2
-std::ranges::input_range
Additionally, each overload has the following constraints:
- (1) -
std::indirectly_swappable<I1, I2>
- (2) -
std::indirectly_swappable<ranges::iterator_t<R1>, ranges::iterator_t<R2>>
// (1)
template<
std::input_iterator I1,
std::sentinel_for<I1> S1,
std::input_iterator I2,
std::sentinel_for<I2> S2
>
requires std::indirectly_swappable<I1, I2>
constexpr swap_ranges_result<I1, I2>
swap_ranges( I1 first1, S1 last1, I2 first2, S2 last2 );
// (2)
template<
ranges::input_range R1,
ranges::input_range R2
>
requires std::indirectly_swappable<ranges::iterator_t<R1>, ranges::iterator_t<R2>>
constexpr swap_ranges_result<ranges::borrowed_iterator_t<R1>,
ranges::borrowed_iterator_t<R2>>
swap_ranges( R1&& r1, R2&& r2 );
With the helper types defined as follows:
template< class I1, class I2 >
using swap_ranges_result = ranges::in_in_result<I1, I2>;
-
(1) Given M as
ranges::min(ranges::distance(first1, last1), ranges::distance(first2, last2))
:Exchanges elements between first range [
first1
;first1 + M
) and second range [first2
;first2 + M
) viaranges::iter_swap(first1 + i, first2 + i)
.The ranges [
first1
;last1
) and [first2
;last2
) must not overlap. -
(2) Same as (1), but uses
r1
as the first range, as if usingranges::begin(r1)
asfirst1
andranges::end(r1)
aslast1
, and similarly forr2
.
The function-like entities described on this page are niebloids.
Parameters
first1 last1 | The first range of elements to swap. |
first2 last2 | The second range of elements to swap. |
r1 | The first range of elements to swap. |
r2 | The second range of elements to swap. |
Return value
An value of type ranges::swap_ranges_result
initialized as follows:
{
first1 + M,
first2 + M
}
Where M is the smaller size out of both ranges (ranges::min(ranges::distance(first1, last1), ranges::distance(first2, last2))
).
Complexity
Exactly M swaps.
Exceptions
(none)
Possible implementation
swap_ranges(1)
struct swap_ranges_fn
{
template<std::input_iterator I1, std::sentinel_for<I1> S1,
std::input_iterator I2, std::sentinel_for<I2> S2>
requires std::indirectly_swappable<I1, I2>
constexpr ranges::swap_ranges_result<I1, I2>
operator()(I1 first1, S1 last1, I2 first2, S2 last2) const
{
for (; !(first1 == last1 or first2 == last2); ++first1, ++first2)
ranges::iter_swap(first1, first2);
return {std::move(first1), std::move(first2)};
}
template<ranges::input_range R1, ranges::input_range R2>
requires std::indirectly_swappable<ranges::iterator_t<R1>, ranges::iterator_t<R2>>
constexpr ranges::swap_ranges_result<ranges::borrowed_iterator_t<R1>,
ranges::borrowed_iterator_t<R2>>
operator()(R1&& r1, R2&& r2) const
{
return (*this)(ranges::begin(r1), ranges::end(r1),
ranges::begin(r2), ranges::end(r2));
}
};
inline constexpr swap_ranges_fn swap_ranges {};
Notes
Implementations (e.g. MSVC STL) may enable vectorization when the iterator type models contiguous_iterator
and swapping its value type calls neither non-trivial special member function nor ADL-found swap.
Examples
#include <algorithm>
#include <iostream>
#include <list>
#include <string_view>
#include <vector>
auto print(std::string_view name, auto const& seq, std::string_view term = "\n")
{
std::cout << name << " : ";
for (const auto& elem : seq)
std::cout << elem << ' ';
std::cout << term;
}
int main()
{
std::vector<char> p {'A', 'B', 'C', 'D', 'E'};
std::list<char> q {'1', '2', '3', '4', '5', '6'};
print("p", p);
print("q", q, "\n\n");
// swap p[0, 2) and q[1, 3):
std::ranges::swap_ranges(p.begin(),
p.begin() + 4,
std::ranges::next(q.begin(), 1),
std::ranges::next(q.begin(), 3));
print("p", p);
print("q", q, "\n\n");
// swap p[0, 5) and q[0, 5):
std::ranges::swap_ranges(p, q);
print("p", p);
print("q", q);
}
p : A B C D E
q : 1 2 3 4 5 6
p : 2 3 C D E
q : 1 A B 4 5 6
p : 1 A B 4 5
q : 2 3 C D E 6
Hover to see the original license.