summaryrefslogtreecommitdiff
path: root/libs/misc/include/misc/benchmark.h
blob: fe5b97585d4ede7fdf6fb98e5b44018f7cbbb0d3 (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
/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @file benchmark.h
 * @ingroup COM_AI_RUNTIME
 * @brief This file contains nnfw::misc::benchmark::Accumulator class
 */
#ifndef __NNFW_MISC_BENCHMARK_H__
#define __NNFW_MISC_BENCHMARK_H__

#include <chrono>

namespace nnfw
{
namespace misc
{
// Benckmark support
namespace benchmark
{

/**
 * @brief Class to accumulate time during benchmark
 */
template <typename T> class Accumulator
{
public:
  /**
   * @brief Construct a new Accumulator object
   * @param[in] ref   Object to keep time duration
   */
  Accumulator(T &ref) : _ref(ref)
  {
    // DO NOTHING
  }

public:
  /**
   * @brief Return the reference of @c ref passed to constructor
   * @return Reference of @c ref
   */
  T &operator()(void) { return _ref; }

private:
  T &_ref;
};

/**
 * @brief Run passed function and returns accumulated time
 * @tparam T            Period used by @c std::chrono::duration_cast
 * @tparam Callable     Function type to benchmark
 * @param[in] acc       Accumulated time after running @cb
 * @param[in] cb        Function to run and benchmark
 * @return Accumulated time
 */
template <typename T, typename Callable>
Accumulator<T> &operator<<(Accumulator<T> &&acc, Callable cb)
{
  auto begin = std::chrono::steady_clock::now();
  cb();
  auto end = std::chrono::steady_clock::now();

  acc() += std::chrono::duration_cast<T>(end - begin);

  return acc;
}

template <typename T> Accumulator<T> measure(T &out) { return Accumulator<T>(out); }

} // namespace benchmark
} // namespace misc
} // namespace nnfw

#endif // __NNFW_MISC_BENCHMARK_H__