Skip to main content

std::ranges::move_backward() algorithm

// (1)
constexpr move_backward_result<I1, I2>
move_backward( I1 first, S1 last, I2 result );

// (2)
constexpr move_backward_result<ranges::borrowed_iterator_t<R>, I>
move_backward( R&& r, I result );

The type of arguments are generic and have following constraints:

  • I, I2 - std::bidirectonal_iterator
  • S - std::sentinel_for<I1>
  • (2) - R - std::ranges::bidirectional_range

Additionally, each overload has the following constraints:

  • (1) - std::indirectly_movable<I1, I2>
  • (2) - std::indirectly_movable<ranges::iterator_t<R>, I>

With the helper types defined as follows:

template< class I, class O >
using move_backward_result = ranges::in_out_result<I, O>;
  • (1) Copies the elements from the range, defined by [first; last), to another range [result - N; result), where N = ranges::distance(first, last).
    The elements are copied in reverse order (the last element is copied first), but their relative order is preserved.

    Undefined Behaviour

    The behavior is undefined if result is within the range (first; last]. In this case, ranges::move may be used instead.

  • (2) Same as (1), but uses r as the source range, as if using ranges::begin(r) as first and ranges::end(r) as last.

The elements in the moved-from range will still contain valid values of the appropriate type, but not necessarily the same values as before the move, as if using *(result - n) = ranges::iter_move(last - n) for each integer n, where 0 ≤ n < N.

The function-like entities described on this page are niebloids.

Parameters

first
last

The range of elements to move.

r

The range of elements to move.

result

The destination range.

Return value

A value of type ranges::move_backward_result initialized as follows:

{
last,
result - N
}

Where N is the size of the range to move.

Complexity

Exactly N assignments, where N is the size of the range to move.

Exceptions

(none)

Possible implementation

move_backward(1) and move_backward(2)
struct move_backward_fn
{
template<std::bidirectional_iterator I1, std::sentinel_for<I1> S1,
std::bidirectional_iterator I2>
requires std::indirectly_movable<I1, I2>
constexpr ranges::move_backward_result<I1, I2>
operator()(I1 first, S1 last, I2 result) const
{
auto i {last};
for (; i != first; *--result = ranges::iter_move(--i))
{}
return {std::move(last), std::move(result)};
}

template<ranges::bidirectional_range R, std::bidirectional_iterator I>
requires std::indirectly_movable<ranges::iterator_t<R>, I>
constexpr ranges::move_backward_result<ranges::borrowed_iterator_t<R>, I>
operator()(R&& r, I result) const
{
return (*this)(ranges::begin(r), ranges::end(r), std::move(result));
}
};

inline constexpr move_backward_fn move_backward {};

Notes

When moveing overlapping ranges, ranges::move is appropriate when moving to the left (beginning of the destination range is outside the source range),
while ranges::move_backward is appropriate when moving to the right (end of the destination range is outside the source range).

Examples

Main.cpp
#include <algorithm>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>

using Vec = std::vector<std::string>;

void print(std::string_view rem, Vec const& vec)
{
std::cout << rem << "[" << vec.size() << "]: ";
for (const std::string& s : vec)
std::cout << (s.size() ? s : std::string{"·"}) << ' ';
std::cout << '\n';
}

int main()
{
Vec a{"▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"};
Vec b(a.size());

print("Before move:\n" "a", a);
print("b", b);

std::ranges::move_backward(a, b.end());

print("\n" "Move a >> b:\n" "a", a);
print("b", b);

std::ranges::move_backward(b.begin(), b.end(), a.end());
print("\n" "Move b >> a:\n" "a", a);
print("b", b);

std::ranges::move_backward(a.begin(), a.begin()+3, a.end());
print("\n" "Overlapping move a[0, 3) >> a[5, 8):\n" "a", a);
}
Output
Before move:
a[8]: ▁ ▂ ▃ ▄ ▅ ▆ ▇ █
b[8]: · · · · · · · ·

Move a >> b:
a[8]: · · · · · · · ·
b[8]: ▁ ▂ ▃ ▄ ▅ ▆ ▇ █

Move b >> a:
a[8]: ▁ ▂ ▃ ▄ ▅ ▆ ▇ █
b[8]: · · · · · · · ·

Overlapping move a[0, 3) >> a[5, 8):
a[8]: · · · ▄ ▅ ▁ ▂ ▃
This article originates from this CppReference page. It was likely altered for improvements or editors' preference. Click "Edit this page" to see all changes made to this document.
Hover to see the original license.

std::ranges::move_backward() algorithm

// (1)
constexpr move_backward_result<I1, I2>
move_backward( I1 first, S1 last, I2 result );

// (2)
constexpr move_backward_result<ranges::borrowed_iterator_t<R>, I>
move_backward( R&& r, I result );

The type of arguments are generic and have following constraints:

  • I, I2 - std::bidirectonal_iterator
  • S - std::sentinel_for<I1>
  • (2) - R - std::ranges::bidirectional_range

Additionally, each overload has the following constraints:

  • (1) - std::indirectly_movable<I1, I2>
  • (2) - std::indirectly_movable<ranges::iterator_t<R>, I>

With the helper types defined as follows:

template< class I, class O >
using move_backward_result = ranges::in_out_result<I, O>;
  • (1) Copies the elements from the range, defined by [first; last), to another range [result - N; result), where N = ranges::distance(first, last).
    The elements are copied in reverse order (the last element is copied first), but their relative order is preserved.

    Undefined Behaviour

    The behavior is undefined if result is within the range (first; last]. In this case, ranges::move may be used instead.

  • (2) Same as (1), but uses r as the source range, as if using ranges::begin(r) as first and ranges::end(r) as last.

The elements in the moved-from range will still contain valid values of the appropriate type, but not necessarily the same values as before the move, as if using *(result - n) = ranges::iter_move(last - n) for each integer n, where 0 ≤ n < N.

The function-like entities described on this page are niebloids.

Parameters

first
last

The range of elements to move.

r

The range of elements to move.

result

The destination range.

Return value

A value of type ranges::move_backward_result initialized as follows:

{
last,
result - N
}

Where N is the size of the range to move.

Complexity

Exactly N assignments, where N is the size of the range to move.

Exceptions

(none)

Possible implementation

move_backward(1) and move_backward(2)
struct move_backward_fn
{
template<std::bidirectional_iterator I1, std::sentinel_for<I1> S1,
std::bidirectional_iterator I2>
requires std::indirectly_movable<I1, I2>
constexpr ranges::move_backward_result<I1, I2>
operator()(I1 first, S1 last, I2 result) const
{
auto i {last};
for (; i != first; *--result = ranges::iter_move(--i))
{}
return {std::move(last), std::move(result)};
}

template<ranges::bidirectional_range R, std::bidirectional_iterator I>
requires std::indirectly_movable<ranges::iterator_t<R>, I>
constexpr ranges::move_backward_result<ranges::borrowed_iterator_t<R>, I>
operator()(R&& r, I result) const
{
return (*this)(ranges::begin(r), ranges::end(r), std::move(result));
}
};

inline constexpr move_backward_fn move_backward {};

Notes

When moveing overlapping ranges, ranges::move is appropriate when moving to the left (beginning of the destination range is outside the source range),
while ranges::move_backward is appropriate when moving to the right (end of the destination range is outside the source range).

Examples

Main.cpp
#include <algorithm>
#include <iostream>
#include <string>
#include <string_view>
#include <vector>

using Vec = std::vector<std::string>;

void print(std::string_view rem, Vec const& vec)
{
std::cout << rem << "[" << vec.size() << "]: ";
for (const std::string& s : vec)
std::cout << (s.size() ? s : std::string{"·"}) << ' ';
std::cout << '\n';
}

int main()
{
Vec a{"▁", "▂", "▃", "▄", "▅", "▆", "▇", "█"};
Vec b(a.size());

print("Before move:\n" "a", a);
print("b", b);

std::ranges::move_backward(a, b.end());

print("\n" "Move a >> b:\n" "a", a);
print("b", b);

std::ranges::move_backward(b.begin(), b.end(), a.end());
print("\n" "Move b >> a:\n" "a", a);
print("b", b);

std::ranges::move_backward(a.begin(), a.begin()+3, a.end());
print("\n" "Overlapping move a[0, 3) >> a[5, 8):\n" "a", a);
}
Output
Before move:
a[8]: ▁ ▂ ▃ ▄ ▅ ▆ ▇ █
b[8]: · · · · · · · ·

Move a >> b:
a[8]: · · · · · · · ·
b[8]: ▁ ▂ ▃ ▄ ▅ ▆ ▇ █

Move b >> a:
a[8]: ▁ ▂ ▃ ▄ ▅ ▆ ▇ █
b[8]: · · · · · · · ·

Overlapping move a[0, 3) >> a[5, 8):
a[8]: · · · ▄ ▅ ▁ ▂ ▃
This article originates from this CppReference page. It was likely altered for improvements or editors' preference. Click "Edit this page" to see all changes made to this document.
Hover to see the original license.