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 が
MoveAssignable でない。*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); // 効果なし: n >= last - first
    std::shift_left(begin(b), end(b), 8); // 同上
    std::shift_left(begin(c), end(c), 8); // 同上
    std::cout << a << "  " << b << "  " << c << '\n';
//  std::shift_left(begin(a), end(a), -3); // UB, 例: セグフォルト
}

出力例:

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   . . δ ε ζ η .

コンパイラサポート
フリースタンディングとホスト環境
言語
標準ライブラリ
標準ライブラリヘッダ
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
範囲ライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行処理サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
技術仕様書
シンボル索引
外部ライブラリ

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)	範囲内の要素をシフトする (アルゴリズム関数オブジェクト)

ja.cppreference.net

Namespaces

Variants

std::shift_left、std::shift_right

目次

パラメータ

戻り値

計算量

例外

注記

例

関連項目