aboutsummaryrefslogtreecommitdiff
path: root/libcxx/test/benchmarks/algorithms/nonmodifying/find_end.bench.cpp
blob: f1ad8a65c3235d1decced31a09e2fbcc6627b6be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

// UNSUPPORTED: c++03, c++11, c++14, c++17

#include <algorithm>
#include <cassert>
#include <cstddef>
#include <deque>
#include <forward_list>
#include <list>
#include <string>
#include <vector>

#include <benchmark/benchmark.h>
#include "../../GenerateInput.h"

int main(int argc, char** argv) {
  auto std_find_end = [](auto first1, auto last1, auto first2, auto last2) {
    return std::find_end(first1, last1, first2, last2);
  };
  auto std_find_end_pred = [](auto first1, auto last1, auto first2, auto last2) {
    return std::find_end(first1, last1, first2, last2, [](auto x, auto y) {
      benchmark::DoNotOptimize(x);
      benchmark::DoNotOptimize(y);
      return x == y;
    });
  };
  auto ranges_find_end_pred = [](auto first1, auto last1, auto first2, auto last2) {
    return std::ranges::find_end(first1, last1, first2, last2, [](auto x, auto y) {
      benchmark::DoNotOptimize(x);
      benchmark::DoNotOptimize(y);
      return x == y;
    });
  };

  auto register_benchmarks = [&](auto bm, std::string comment) {
    // {std,ranges}::find_end(it1, it1, it2, it2)
    bm.template operator()<std::vector<int>>("std::find_end(vector<int>) (" + comment + ")", std_find_end);
    bm.template operator()<std::deque<int>>("std::find_end(deque<int>) (" + comment + ")", std_find_end);
    bm.template operator()<std::list<int>>("std::find_end(list<int>) (" + comment + ")", std_find_end);
    bm.template operator()<std::forward_list<int>>("std::find_end(forward_list<int>) (" + comment + ")", std_find_end);
    bm.template operator()<std::vector<int>>("rng::find_end(vector<int>) (" + comment + ")", std::ranges::find_end);
    bm.template operator()<std::deque<int>>("rng::find_end(deque<int>) (" + comment + ")", std::ranges::find_end);
    bm.template operator()<std::list<int>>("rng::find_end(list<int>) (" + comment + ")", std::ranges::find_end);
    bm.template operator()<std::forward_list<int>>(
        "rng::find_end(forward_list<int>) (" + comment + ")", std::ranges::find_end);

    // {std,ranges}::find_end(it1, it1, it2, it2, pred)
    bm.template operator()<std::vector<int>>("std::find_end(vector<int>, pred) (" + comment + ")", std_find_end_pred);
    bm.template operator()<std::deque<int>>("std::find_end(deque<int>, pred) (" + comment + ")", std_find_end_pred);
    bm.template operator()<std::list<int>>("std::find_end(list<int>, pred) (" + comment + ")", std_find_end_pred);
    bm.template operator()<std::forward_list<int>>(
        "std::find_end(forward_list<int>, pred) (" + comment + ")", std_find_end_pred);
    bm.template operator()<std::vector<int>>(
        "rng::find_end(vector<int>, pred) (" + comment + ")", ranges_find_end_pred);
    bm.template operator()<std::deque<int>>("rng::find_end(deque<int>, pred) (" + comment + ")", ranges_find_end_pred);
    bm.template operator()<std::list<int>>("rng::find_end(list<int>, pred) (" + comment + ")", ranges_find_end_pred);
    bm.template operator()<std::forward_list<int>>(
        "rng::find_end(forward_list<int>, pred) (" + comment + ")", ranges_find_end_pred);
  };

  // Benchmark {std,ranges}::find_end where we never find the needle, which is the
  // worst case.
  {
    auto bm = []<class Container>(std::string name, auto find_end) {
      benchmark::RegisterBenchmark(
          name,
          [find_end](auto& st) {
            std::size_t const size = st.range(0);
            using ValueType        = typename Container::value_type;
            ValueType x            = Generate<ValueType>::random();
            ValueType y            = random_different_from({x});
            Container haystack(size, x);
            std::size_t n = size / 10; // needle size is 10% of the haystack, but we'll never find it
            assert(n > 0);
            Container needle(n, y);

            for ([[maybe_unused]] auto _ : st) {
              benchmark::DoNotOptimize(haystack);
              benchmark::DoNotOptimize(needle);
              auto result = find_end(haystack.begin(), haystack.end(), needle.begin(), needle.end());
              benchmark::DoNotOptimize(result);
            }
          })
          ->Arg(1000) // non power-of-two
          ->Arg(1024)
          ->Arg(8192)
          ->Arg(1 << 20);
    };
    register_benchmarks(bm, "process all");
  }

  // Benchmark {std,ranges}::find_end where we intersperse "near matches" inside the haystack.
  {
    auto bm = []<class Container>(std::string name, auto find_end) {
      benchmark::RegisterBenchmark(
          name,
          [find_end](auto& st) {
            std::size_t const size = st.range(0);
            using ValueType        = typename Container::value_type;
            ValueType x            = Generate<ValueType>::random();
            ValueType y            = random_different_from({x});
            Container haystack(size, x);
            std::size_t n = size / 10; // needle size is 10% of the haystack
            assert(n > 0);
            Container needle(n, y);

            // intersperse near-matches inside the haystack
            {
              auto first = haystack.begin();
              for (int i = 0; i != 10; ++i) {
                first = std::copy_n(needle.begin(), n - 1, first);
                ++first; // this causes the subsequence not to match because it has length n-1
              }
            }

            for ([[maybe_unused]] auto _ : st) {
              benchmark::DoNotOptimize(haystack);
              benchmark::DoNotOptimize(needle);
              auto result = find_end(haystack.begin(), haystack.end(), needle.begin(), needle.end());
              benchmark::DoNotOptimize(result);
            }
          })
          ->Arg(1000) // non power-of-two
          ->Arg(1024)
          ->Arg(8192);
    };
    register_benchmarks(bm, "near matches");
  }

  // Special case: the two ranges are the same length (and they are equal, which is the worst case).
  {
    auto bm = []<class Container>(std::string name, auto find_end) {
      benchmark::RegisterBenchmark(
          name,
          [find_end](auto& st) {
            std::size_t const size = st.range(0);
            using ValueType        = typename Container::value_type;
            ValueType x            = Generate<ValueType>::random();
            Container haystack(size, x);
            Container needle(size, x);

            for ([[maybe_unused]] auto _ : st) {
              benchmark::DoNotOptimize(haystack);
              benchmark::DoNotOptimize(needle);
              auto result = find_end(haystack.begin(), haystack.end(), needle.begin(), needle.end());
              benchmark::DoNotOptimize(result);
            }
          })
          ->Arg(1000) // non power-of-two
          ->Arg(1024)
          ->Arg(8192);
    };
    register_benchmarks(bm, "same length");
  }

  // Special case: the needle contains a single element (which we never find, i.e. the worst case).
  {
    auto bm = []<class Container>(std::string name, auto find_end) {
      benchmark::RegisterBenchmark(
          name,
          [find_end](auto& st) {
            std::size_t const size = st.range(0);
            using ValueType        = typename Container::value_type;
            ValueType x            = Generate<ValueType>::random();
            ValueType y            = random_different_from({x});
            Container haystack(size, x);
            Container needle(1, y);

            for ([[maybe_unused]] auto _ : st) {
              benchmark::DoNotOptimize(haystack);
              benchmark::DoNotOptimize(needle);
              auto result = find_end(haystack.begin(), haystack.end(), needle.begin(), needle.end());
              benchmark::DoNotOptimize(result);
            }
          })
          ->Arg(1000) // non power-of-two
          ->Arg(1024)
          ->Arg(8192);
    };
    register_benchmarks(bm, "single element");
  }

  // Special case: we have a match close to the end of the haystack (ideal case if we start searching from the end).
  {
    auto bm = []<class Container>(std::string name, auto find_end) {
      benchmark::RegisterBenchmark(
          name,
          [find_end](auto& st) {
            std::size_t const size = st.range(0);
            using ValueType        = typename Container::value_type;
            ValueType x            = Generate<ValueType>::random();
            ValueType y            = random_different_from({x});
            Container haystack(size, x);
            std::size_t n = size / 10; // needle size is 10% of the haystack
            assert(n > 0);
            Container needle(n, y);

            // put the needle at 90% of the haystack
            std::ranges::copy(needle, std::next(haystack.begin(), (9 * size) / 10));

            for ([[maybe_unused]] auto _ : st) {
              benchmark::DoNotOptimize(haystack);
              benchmark::DoNotOptimize(needle);
              auto result = find_end(haystack.begin(), haystack.end(), needle.begin(), needle.end());
              benchmark::DoNotOptimize(result);
            }
          })
          ->Arg(1000) // non power-of-two
          ->Arg(1024)
          ->Arg(8192);
    };
    register_benchmarks(bm, "match near end");
  }

  benchmark::Initialize(&argc, argv);
  benchmark::RunSpecifiedBenchmarks();
  benchmark::Shutdown();
  return 0;
}