JLANG::JClock Class Reference

Auxiliary class for CPU timing. More...

#include <JClock.hh>

Inheritance diagram for JLANG::JClock:

Classes
struct	sentry
	Auxiliary data structure for scoped timing. More...

Public Member Functions
	JClock ()
	Default constructor.
	JClock (const JTitle &title)
	Constructor.
	~JClock ()
	Destructor.
void	reset ()
	Reset clock.
void	start ()
	Start clock.
void	stop ()
	Stop clock.
size_t	operator() () const
	Get elapsed time.
void	print (std::ostream &out) const
	Print clock data.
const std::string &	getTitle () const
	Get title.
void	setTitle (const std::string &title)
	Set title.

Static Public Member Functions
static void	sets (std::ostream &out)
	Set output stream.

Static Protected Member Functions
static std::ostream *&	gets ()
	Get output stream.

Protected Attributes
std::chrono::high_resolution_clock::time_point	t0
std::chrono::high_resolution_clock::time_point	t1
std::chrono::high_resolution_clock::duration	ts
size_t	count
std::string	title

Friends
std::ostream &	operator<< (std::ostream &out, const JClock &clock)
	Print clock data.

Detailed Description

Auxiliary class for CPU timing.

Definition at line 23 of file JClock.hh.

Constructor & Destructor Documentation

JClock() [1/2]

JLANG::JClock::JClock ( )

inline

Default constructor.

Definition at line 30 of file JClock.hh.

             :
      JTitle(),
      ts(0),
      count(0)
    {}

JClock() [2/2]

JLANG::JClock::JClock ( const JTitle & title )

inline

Constructor.

Parameters

title

title

Definition at line 42 of file JClock.hh.

                                :
      JTitle(title),
      ts(0),
      count(0)
    {}

~JClock()

JLANG::JClock::~JClock ( )

inline

Destructor.

The clock data will optionally be printed to the set output stream.

Definition at line 54 of file JClock.hh.

    {
      if (gets() != NULL && count != 0) {
        *gets() << (*this) << std::endl;
      }
    }

Member Function Documentation

reset()

void JLANG::JClock::reset ( )

inline

Reset clock.

Definition at line 93 of file JClock.hh.

    {
      ts    = std::chrono::high_resolution_clock::duration(0);
      count = 0;
    }

start()

void JLANG::JClock::start ( )

inline

Start clock.

Definition at line 103 of file JClock.hh.

    {
      t0 = std::chrono::high_resolution_clock::now();
    }

stop()

void JLANG::JClock::stop ( )

inline

Stop clock.

Definition at line 112 of file JClock.hh.

    {
      t1 = std::chrono::high_resolution_clock::now();
 
      ts += (t1 - t0);
 
      ++count;
    }

operator()()

size_t JLANG::JClock::operator() ( ) const

inline

Get elapsed time.

Returns

elapsed time [ns]

Definition at line 127 of file JClock.hh.

    {
      return ts / std::chrono::nanoseconds(1);
    }

print()

void JLANG::JClock::print ( std::ostream & out ) const

inline

Print clock data.

Parameters

out	output stream

Definition at line 138 of file JClock.hh.

    {
      using namespace std;
 
      out << setw(16) << left  << getTitle() << ' '
          << setw(12) << right << count      << ' '
          << setw(12) << ts / std::chrono::milliseconds(1) << " [ms]";
    }

sets()

static void JLANG::JClock::sets ( std::ostream & out )

inlinestatic

Set output stream.

Parameters

out	output stream

Definition at line 168 of file JClock.hh.

    {
      gets() = &out;
    }

gets()

static std::ostream *& JLANG::JClock::gets ( )

inlinestaticprotected

Get output stream.

Returns

output stream

Definition at line 186 of file JClock.hh.

    {
      static std::ostream* out = NULL;
 
      return out;
    }

getTitle()

const std::string & JLANG::JTitle::getTitle ( ) const

inlineinherited

Get title.

Returns

title

Definition at line 55 of file JTitle.hh.

    {
      return this->title;
    }

setTitle()

void JLANG::JTitle::setTitle ( const std::string & title )

inlineinherited

Set title.

Parameters

title

title

Definition at line 66 of file JTitle.hh.

    {
      this->title = title;
    }

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & out, const JClock & clock )

friend

Print clock data.

Parameters

out	output stream
clock	clock

Returns

output stream

Definition at line 155 of file JClock.hh.

    {
      clock.print(out);
 
      return out;
    }

Member Data Documentation

t0

std::chrono::high_resolution_clock::time_point JLANG::JClock::t0

protected

Definition at line 176 of file JClock.hh.

t1

std::chrono::high_resolution_clock::time_point JLANG::JClock::t1

protected

Definition at line 177 of file JClock.hh.

ts

std::chrono::high_resolution_clock::duration JLANG::JClock::ts

protected

Definition at line 178 of file JClock.hh.

count

size_t JLANG::JClock::count

protected

Definition at line 179 of file JClock.hh.

title

std::string JLANG::JTitle::title

protectedinherited

Definition at line 73 of file JTitle.hh.

---

The documentation for this class was generated from the following file:

• JClock.hh