From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/classarmnn_1_1_wall_clock_timer.xhtml | 446 ++++++++++++++++++++++++++++ 1 file changed, 446 insertions(+) create mode 100644 21.02/classarmnn_1_1_wall_clock_timer.xhtml (limited to '21.02/classarmnn_1_1_wall_clock_timer.xhtml') diff --git a/21.02/classarmnn_1_1_wall_clock_timer.xhtml b/21.02/classarmnn_1_1_wall_clock_timer.xhtml new file mode 100644 index 0000000000..80972b0687 --- /dev/null +++ b/21.02/classarmnn_1_1_wall_clock_timer.xhtml @@ -0,0 +1,446 @@ + + + + + + + + + + + + + +ArmNN: WallClockTimer Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Attributes | +List of all members
+
+
WallClockTimer Class Reference
+
+
+ +

#include <WallClockTimer.hpp>

+
+Inheritance diagram for WallClockTimer:
+
+
+ + +Instrument + +
+ + + + +

+Public Types

using clock = std::chrono::steady_clock
 
+ + + + + + + + + + + + + + + + +

+Public Member Functions

 WallClockTimer ()=default
 
 ~WallClockTimer ()=default
 
void Start () override
 
void Stop () override
 
const char * GetName () const override
 
std::vector< Measurement > GetMeasurements () const override
 
- Public Member Functions inherited from Instrument
virtual ~Instrument ()
 
+ + + + + + + +

+Static Public Attributes

static const std::string WALL_CLOCK_TIME
 
static const std::string WALL_CLOCK_TIME_START
 
static const std::string WALL_CLOCK_TIME_STOP
 
+

Detailed Description

+
+

Definition at line 38 of file WallClockTimer.hpp.

+

Member Typedef Documentation

+ +

◆ clock

+ +
+
+ + + + +
using clock = std::chrono::steady_clock
+
+ +

Definition at line 60 of file WallClockTimer.hpp.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ WallClockTimer()

+ +
+
+ + + + + +
+ + + + + + + +
WallClockTimer ()
+ 		+default
+
+ +
+
+ +

◆ ~WallClockTimer()

+ +
+
+ + + + + +
+ + + + + + + +
~WallClockTimer ()
+ 		+default
+
+ +
+
+

Member Function Documentation

+ +

◆ GetMeasurements()

+ +
+
+ + + + + +
+ + + + + + + +
std::vector< Measurement > GetMeasurements () const
+ 		+overridevirtual
+
+ +

Implements Instrument.

+ +

Definition at line 30 of file WallClockTimer.cpp.

+ +

References WallClockTimer::WALL_CLOCK_TIME, WallClockTimer::WALL_CLOCK_TIME_START, and WallClockTimer::WALL_CLOCK_TIME_STOP.

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
31 {
32  const auto delta = std::chrono::duration<double, std::micro>(m_Stop - m_Start);
33  const auto startTimeMs = std::chrono::duration<double, std::micro>(m_Start.time_since_epoch());
34  const auto stopTimeMs = std::chrono::duration<double, std::micro>(m_Stop.time_since_epoch());
35 
36  return { { WALL_CLOCK_TIME, delta.count(), Measurement::Unit::TIME_US },
37  { WALL_CLOCK_TIME_START, startTimeMs.count(), Measurement::Unit::TIME_US },
38  { WALL_CLOCK_TIME_STOP, stopTimeMs.count(), Measurement::Unit::TIME_US } };
39 }
armnn::WallClockTimer::WALL_CLOCK_TIME_STOP
static const std::string WALL_CLOCK_TIME_STOP
Definition: WallClockTimer.hpp:65
+
armnn::WallClockTimer::WALL_CLOCK_TIME_START
static const std::string WALL_CLOCK_TIME_START
Definition: WallClockTimer.hpp:64
+
armnn::WallClockTimer::WALL_CLOCK_TIME
static const std::string WALL_CLOCK_TIME
Definition: WallClockTimer.hpp:63
+
+
+
+ +

◆ GetName()

+ +
+
+ + + + + +
+ + + + + + + +
const char * GetName () const
+ 		+overridevirtual
+
+ +

Implements Instrument.

+ +

Definition at line 15 of file WallClockTimer.cpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
16 {
17  return "WallClockTimer";
18 }
+
+
+ +

◆ Start()

+ +
+
+ + + + + +
+ + + + + + + +
void Start ()
+ 		+overridevirtual
+
+ +

Implements Instrument.

+ +

Definition at line 20 of file WallClockTimer.cpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
21 {
22  m_Start = clock::now();
23 }
+
+
+ +

◆ Stop()

+ +
+
+ + + + + +
+ + + + + + + +
void Stop ()
+ 		+overridevirtual
+
+ +

Implements Instrument.

+ +

Definition at line 25 of file WallClockTimer.cpp.

+ +

Referenced by BOOST_AUTO_TEST_CASE().

+
26 {
27  m_Stop = clock::now();
28 }
+
+
+

Member Data Documentation

+ +

◆ WALL_CLOCK_TIME

+ +
+
+ + + + + +
+ + + + +
const std::string WALL_CLOCK_TIME
+ 		+static
+
+ +

Definition at line 63 of file WallClockTimer.hpp.

+ +

Referenced by ProfilerImpl::AnalyzeEventSequenceAndWriteResults(), BOOST_AUTO_TEST_CASE(), ProfilerImpl::CalculateProfilingEventStats(), and WallClockTimer::GetMeasurements().

+ +
+
+ +

◆ WALL_CLOCK_TIME_START

+ +
+
+ + + + + +
+ + + + +
const std::string WALL_CLOCK_TIME_START
+ 		+static
+
+ +

Definition at line 64 of file WallClockTimer.hpp.

+ +

Referenced by ProfilerImpl::AnalyzeEventSequenceAndWriteResults(), and WallClockTimer::GetMeasurements().

+ +
+
+ +

◆ WALL_CLOCK_TIME_STOP

+ +
+
+ + + + + +
+ + + + +
const std::string WALL_CLOCK_TIME_STOP
+ 		+static
+
+ +

Definition at line 65 of file WallClockTimer.hpp.

+ +

Referenced by ProfilerImpl::AnalyzeEventSequenceAndWriteResults(), and WallClockTimer::GetMeasurements().

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1