Spec-Zone.ru › C++

std::shift_left, std::shift_right

Определено в заголовочном файле <algorithm>
template< class ForwardIt >
constexpr ForwardIt shift_left( ForwardIt first, ForwardIt last,
                                typename std::iterator_traits<ForwardIt>::
                                    difference_type n );
(1) (начиная с C++20)
template< class ExecutionPolicy, class ForwardIt >
ForwardIt shift_left( ExecutionPolicy&& policy,
                      ForwardIt first, ForwardIt last,
                      typename std::iterator_traits<ForwardIt>::
                          difference_type n );
(2) (начиная с C++20)
template< class ForwardIt >
constexpr ForwardIt shift_right( ForwardIt first, ForwardIt last,
                                 typename std::iterator_traits<ForwardIt>::
                                     difference_type n );
(3) (начиная с C++20)
template< class ExecutionPolicy, class ForwardIt >
ForwardIt shift_right( ExecutionPolicy&& policy,
                       ForwardIt first, ForwardIt last,
                       typename std::iterator_traits<ForwardIt>::
                           difference_type n );
(4) (начиная с C++20)

Сдвигает элементы в диапазоне [first, last) на n позиций.

1) Сдвигает элементы к началу диапазона.
  • Если n == 0 || n >= last - first, эффект отсутствует.
  • В противном случае для каждого целого числа i в [0, last - first - n) перемещает элемент, изначально находившийся в позиции first + n + i, в позицию first + i.
Перемещения выполняются в порядке возрастания i, начиная с 0.
3) Сдвигает элементы к концу диапазона.
  • Если n == 0 || n >= last - first, эффект отсутствует.
  • В противном случае для каждого целого числа i в [0, last - first - n) перемещает элемент, изначально находившийся в позиции first + i, в позицию first + n + i.
Если ForwardIt удовлетворяет требованиям LegacyBidirectionalIterator, перемещения выполняются в порядке убывания i, начиная с last - first - n - 1.
2,4) То же, что (1) и (3) соответственно, но выполняется в соответствии с policy, при этом перемещения могут выполняться в любом порядке.
Эти перегрузки участвуют в разрешении перегрузки только в том случае, если std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> является true.

Элементы, входящие в исходный диапазон, но не входящие в новый диапазон, остаются в допустимом, но неуказанном состоянии.

Поведение не определено, если выполняется любое из следующих условий:

  • n >= 0 не является true.
  • Тип *first не удовлетворяет требованиям MoveAssignable.
  • Для shift_right, ForwardIt не является ни LegacyBidirectionalIterator, ни ValueSwappable.

Параметры

first, last - пара итераторов, задающая диапазон элементов для сдвига
n - количество позиций для сдвига
policy - используемая политика выполнения
Требования к типам
-ForwardIt должен удовлетворять требованиям LegacyForwardIterator.

Возвращаемое значение

1,2) Конец результирующего диапазона.
  • Если n меньше std::distance(first, last), возвращает итератор, равный std::next(first, (std::distance(first, last) - n)).
  • В противном случае возвращает first.
3,4) Начало результирующего диапазона.
  • Если n меньше std::distance(first, last), возвращает итератор, равный std::next(first, n).
  • В противном случае возвращает last.

Сложность

1,2) Не более std::distance(first, last) - n операций присваивания.
3,4) Не более std::distance(first, last) - n операций присваивания или обмена.

Исключения

Перегрузки с параметром шаблона с именем ExecutionPolicy сообщают об ошибках следующим образом:

  • Если выполнение функции, вызванной в рамках алгоритма, генерирует исключение и ExecutionPolicy является одной из стандартных политик, вызывается std::terminate. Для любого другого значения ExecutionPolicy поведение определяется реализацией.
  • Если алгоритму не удаётся выделить память, генерируется std::bad_alloc.

Примечания

Макрос проверки функциональности Значение Стандарт Функциональность
__cpp_lib_shift 201806L (C++20) std::shift_left и std::shift_right

Пример

#include <algorithm>
#include <iostream>
#include <string>
#include <type_traits>
#include <vector>

struct S
{
    int value{0};
    bool specified_state{true};
   
    S(int v = 0) : value{v} {}
    S(S const& rhs) = default;
    S(S&& rhs) { *this = std::move(rhs); }
    S& operator=(S const& rhs) = default;
    S& operator=(S&& rhs)
    {
        if (this != &rhs)
        {
            value = rhs.value;
            specified_state = rhs.specified_state;
            rhs.specified_state = false;
        }
        return *this;
    }
};

template<typename T>
std::ostream& operator<<(std::ostream& os, std::vector<T> const& v)
{
    for (const auto& s : v)
    {
        if constexpr (std::is_same_v<T, S>)
            s.specified_state ? os << s.value << ' ' : os << ". ";
        else if constexpr (std::is_same_v<T, std::string>)
            os << (s.empty() ? "." : s) << ' ';
        else
            os << s << ' ';
    }
    return os;
}

int main()
{
    std::cout << std::left;
    
    std::vector<S>           a{1, 2, 3, 4, 5, 6, 7};
    std::vector<int>         b{1, 2, 3, 4, 5, 6, 7};
    std::vector<std::string> c{"α", "β", "γ", "δ", "ε", "ζ", "η"};
    
    std::cout << "vector<S> \tvector<int> \tvector<string>\n";
    std::cout << a << "  " << b << "  " << c << '\n';
    
    std::shift_left(begin(a), end(a), 3);
    std::shift_left(begin(b), end(b), 3);
    std::shift_left(begin(c), end(c), 3);
    std::cout << a << "  " << b << "  " << c << '\n';
    
    std::shift_right(begin(a), end(a), 2);
    std::shift_right(begin(b), end(b), 2);
    std::shift_right(begin(c), end(c), 2);
    std::cout << a << "  " << b << "  " << c << '\n';
    
    std::shift_left(begin(a), end(a), 8); // has no effect: n >= last - first
    std::shift_left(begin(b), end(b), 8); // ditto
    std::shift_left(begin(c), end(c), 8); // ditto
    std::cout << a << "  " << b << "  " << c << '\n';

//  std::shift_left(begin(a), end(a), -3); // UB, e.g. segfault
}

Возможный результат:

vector<S>       vector<int>     vector<string>
1 2 3 4 5 6 7   1 2 3 4 5 6 7   α β γ δ ε ζ η
4 5 6 7 . . .   4 5 6 7 5 6 7   δ ε ζ η . . .
. . 4 5 6 7 .   4 5 4 5 6 7 5   . . δ ε ζ η .
. . 4 5 6 7 .   4 5 4 5 6 7 5   . . δ ε ζ η .

См. также

move
(C++11)
перемещает диапазон элементов в новое место
(шаблон функции и функциональный объект алгоритма)
ranges::move
(C++20)
move_backward
(C++11)
перемещает диапазон элементов в новое место в обратном порядке
(шаблон функции и функциональный объект алгоритма)
ranges::move_backward
(C++20)
rotate
циклически изменяет порядок элементов в диапазоне
(шаблон функции и функциональный объект алгоритма)
ranges::rotate
(C++20)
ranges::shift_leftranges::shift_right
(C++23)(C++23)
сдвигает элементы в диапазоне
(функциональный объект алгоритма)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/algorithm/shift

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API