std::ranges::search_n(C++20)

namespace std::ranges {
  template <forward_iterator I,
            sentinel_for<I> S,
            class T,
            class Pred = ranges::equal_to,
            class Proj = identity>
    requires indirectly_comparable<I, const T*, Pred, Proj>
  constexpr subrange<I>
    search_n(I first,
             S last,
             iter_difference_t<I> count,
             const T& value,
             Pred pred = {},
             Proj proj = {}); // (1) C++20
  template <forward_iterator I,
            sentinel_for<I> S,
            class Pred = ranges::equal_to,
            class Proj = identity,
            class T = projected_value_t<I, Proj>>
    requires indirectly_comparable<I, const T*, Pred, Proj>
  constexpr subrange<I>
    search_n(I first,
             S last,
             iter_difference_t<I> count,
             const T& value,
             Pred pred = {},
             Proj proj = {}); // (1) C++26

  template <forward_range R,
            class T,
            class Pred = ranges::equal_to,
            class Proj = identity>
    requires indirectly_comparable<iterator_t<R>, const T*, Pred, Proj>
  constexpr borrowed_subrange_t<R>
    search_n(R&& r,
             range_difference_t<R> count,
             const T& value,
             Pred pred = {},
             Proj proj = {}); // (2) C++20
  template <forward_range R,
            class Pred = ranges::equal_to,
            class Proj = identity,
            class T = projected_value_t<iterator_t<R>, Proj>>
    requires indirectly_comparable<iterator_t<R>, const T*, Pred, Proj>
  constexpr borrowed_subrange_t<R>
    search_n(R&& r,
             range_difference_t<R> count,
             const T& value,
             Pred pred = {},
             Proj proj = {}); // (2) C++26
}

概要

あるシーケンスの中から、指定の要素が連続するサブシーケンスを探す。

(1): イテレータ範囲を指定する
(2): Rangeを直接指定する

戻り値

[first,last-count) 内のイテレータ i があるとき、0 以上 count 未満の整数 n について、それぞれ invoke(pred,invoke(proj, *(i + n)), value) であるようなサブシーケンスを探し、見つかった最初のサブシーケンスを返す。

そのようなイテレータが見つからない場合は {last, last} を返す。

計算量

最大で last - first 回の対応する比較もしくは述語が適用される。

備考

(1), (2) :
- C++26 : パラメータvalueとして波カッコ初期化{}を受け付ける
```
std::vector<T> v;
auto sr = std::ranges::search_n(v, 3, {a, b});
```

例

基本的な使い方

#include <algorithm>
#include <iostream>
#include <vector>

int main() {
  std::vector<int> v = { 1,2,3,2,1,3,3,2,3,3,1 };

  // 3 が 2 つ連続している最初のシーケンスを探す
  std::ranges::subrange sr1 = std::ranges::search_n(v, 2, 3);
  // v[5] の位置を指すイテレータが見つかる。
  if (sr1.empty()) {
    std::cout << "not found" << std::endl;
  } else {
    std::cout << "found: index==" << std::distance(v.begin(), sr1.begin()) << std::endl;
  }

  // 3 未満が 2 つ連続している最初のシーケンスを探す
  auto sr2 = std::ranges::search_n(v, 2, 3, [](int x, int y) { return x < y; });
  // v[0] の位置を指すイテレータが見つかる。
  if (sr2.empty()) {
    std::cout << "not found" << std::endl;
  } else {
    std::cout << "found: index==" << std::distance(v.begin(), sr2.begin()) << std::endl;
  }
}

出力

found: index==5
found: index==0

波カッコ初期化を入力として使用する (C++26)

#include <algorithm>
#include <iostream>
#include <vector>

struct Point {
  int x;
  int y;

  bool operator==(const Point& other) const = default;
};

int main() {
  std::vector<Point> v = {
    {1, 2},
    {3, 4},
    {3, 4},
    {5, 6},
  };

  // 値が {3, 4} が2回連続している場所を探す
  std::ranges::subrange sr = std::ranges::search_n(v, 2, {3, 4});
  if (!sr.empty()) {
    int index = std::distance(v.begin(), sr.begin());
    std::cout << "found: index==" << index << std::endl;
  }
}

出力

found: index==1

実装例

struct search_n_impl {
  template<forward_iterator I, sentinel_for<I> S, class T, class Pred = ranges::equal_to, class Proj = identity>
    requires indirectly_comparable<I, const T*, Pred, Proj>
  constexpr subrange<I> operator()(I first, S last, iter_difference_t<I> count, const T& value, Pred pred = {}, Proj proj = {}) const {
    if (first == last || count <= 0)
      return first;

    while (first != last) {
      if (*first == value) {
        I it = first;
        ++it;
        iter_difference_t<I> i = 1;
        for (; i < count && it != last && invoke(pred, invoke(proj, *it), value); ++i, ++it)
          ;
        if (i == count)
          return {first, i};
        else if (it == last)
          return {last, last};
        else
          first = it;
      }
      ++first;
    }
  }

  template<forward_range R, class T, class Pred = ranges::equal_to, class Proj = identity>
    requires indirectly_comparable<iterator_t<R>, const T*, Pred, Proj>
  constexpr borrowed_subrange_t<R> operator()(R&& r, range_difference_t<R> count, const T& value, Pred pred = {}, Proj proj = {}) const {
    return (*this)(begin(r1), end(r1), count, value, ref(pred), ref(proj));
  }
};

inline constexpr search_n_impl search_n;

バージョン

言語

C++20

処理系

Clang: ??
GCC: 10.1.0 ✅
ICC: ??
Visual C++: 2019 Update 10 ✅

参照

N4861 25 Algorithms library
P2248R8 Enabling list-initialization for algorithms
- C++26で波カッコ初期化 (リスト初期化) に対応した