adjacent_view.md

adjacent_view

• ranges[meta header]
• std::ranges[meta namespace]
• class template[meta id-type]
• cpp23[meta cpp]
• adjacent,pairwise[meta alias]

namespace std::ranges {
  template<forward_range V, size_t N>
    requires view<V> && (N > 0)
  class adjacent_view : public view_interface<adjacent_view<V, N>> { …… }; // (1)

  namespace views {
    template<std::size_t N>
    inline constexpr /*unspecified*/ adjacent = /*unspecified*/;      // (2)

    inline constexpr auto pairwise = adjacent<2>;                     // (3)
  }
}

概要

adjacent_viewは各要素とそれに隣接する要素をコンパイル時指定の個数ずつ取り出したtupleを要素とするview。

adjacent_viewの要素を1つ取得するごとに、V の要素を N 個取得する。

N が元となるRangeの要素数より大きい場合、このviewは空である。

• (1): adjacent_viewのクラス定義
• (2): adjacent_viewを生成するカスタマイゼーションポイントオブジェクト(変数テンプレート)
• (3): adjacent<2> の別名

Rangeコンセプト

borrowed	sized	output	input	forward	bidirectional	random_access	contiguous	common	viewable	view
	(1)	〇	〇	(1)	(1)	(1)		(1)	○	○

• (1): 元となるRangeに従う

効果

• (2): 式views::adjacent<N>(E)の効果は次の通り
  • N > 0 のとき、adjacent_view<views::all_t<decltype((E))>, N>(E) と等しい
  • N = 0 のとき、auto((void)E, views::empty<tuple<>>) と等しい

メンバ関数

名前	説明	対応バージョン
(constructor)	コンストラクタ	C++23
base	Vの参照を取得する	C++23
begin	先頭を指すイテレータを取得する	C++23
end	番兵を取得する	C++23
size	要素数を取得する	C++23

継承しているメンバ関数

名前	説明	対応バージョン
empty	Rangeが空かどうかを判定する	C++20
operator bool	Rangeが空でないかどうかを判定する	C++20
front	先頭要素への参照を取得する	C++20
back	末尾要素への参照を取得する	C++20
cbegin	定数イテレータを取得する	C++23
cend	定数イテレータ（番兵）を取得する	C++23
operator[]	要素へアクセスする	C++20

推論補助

名前	説明	対応バージョン
(deduction_guide)	クラステンプレートの推論補助	C++23

例

#include <ranges>
#include <vector>
#include <print>

int main() {
  std::vector v = {1, 2, 3, 4, 5, 6};
  std::println("{}", v | std::views::adjacent<0>);
  std::println("{}", v | std::views::adjacent<1>);
  std::println("{}", v | std::views::adjacent<3>);
  std::println("{}", v | std::views::adjacent<6>);
  std::println("{}", v | std::views::adjacent<7>);
}

• std::views::adjacent[color ff0000]

出力

[]
[(1), (2), (3), (4), (5), (6)]
[(1, 2, 3), (2, 3, 4), (3, 4, 5), (4, 5, 6)]
[(1, 2, 3, 4, 5, 6)]
[]

バージョン

言語

• C++23

処理系

• Clang: 19 [mark verified]
• GCC: 13 [mark verified]
• Visual C++: 2022 Update 7 [mark verified]

関連項目

• adjacent_transform_view: adjacent_view と同じように要素を取得して関数を適用する
• slide_view: adjacent_view と同じように要素を取得するが、個数を実行時に指定する。内側はtupleではなくviewとなる

参照

• N4950 26 Ranges library
• P2321R2 zip