summaryrefslogtreecommitdiffhomepage
path: root/dev/misc/BenchKit/Chronometer.h
blob: 1ed687aa35a1d47aac09e4da3149d9bfa1e1818c (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
/* -------------------------------------------

Copyright (C) 2025, Amlal El Mahrouss, licensed under the Apache 2.0 license.

------------------------------------------- */

#ifndef BENCHKIT_CHRONO_H
#define BENCHKIT_CHRONO_H

#include <CompilerKit/CompilerKit.h>
#include <NeKit/Defines.h>

/// @author Amlal El Mahrouss
/// @brief BenchKit Chrono contract.

#define BENCHKIT_INTERFACE : public ::Kernel::ChronoInterface

namespace Kernel {
class ChronoInterface;

/// @brief a Chronometer interface used for benchmarking.
class ChronoInterface {
 public:
  ChronoInterface()          = default;
  virtual ~ChronoInterface() = default;

  NE_COPY_DEFAULT(ChronoInterface)

  virtual Void   Start()                = 0;
  virtual Void   Stop()                 = 0;
  virtual Void   Reset()                = 0;
  virtual UInt64 GetElapsedTime() const = 0;
};
}  // namespace Kernel

namespace BenchKit {
using namespace Kernel;
}

#endif  // BENCHKIT_CHRONO_H