chomp::homology::timeused Class Reference

A class that stores the time at which it was initialized and then returns or displays the time used since the initialization. More...

#include <timeused.h>

Public Member Functions
	timeused (const char *msg=NULL)
	The default constructor. More...
	timeused (std::ostream &out, const char *msg=NULL)
	~timeused ()
	The destructor. More...
timeused &	operator= (std::ostream &out)
	Defines an output stream for displaying program's running time at program's termination. More...
timeused &	operator= (outputstream &out)
	Defines an output stream for displaying program's running time at program's termination to a pair of streams. More...
timeused &	operator= (int n)
	Turns off writing program's running time at program's termination by assigning 0 to an object of this class. More...
timeused &	operator= (const char *msg)
	Changes the message displayed at program's termination. More...
timeused &	reset ()
	Reset the timer to the current moment. More...
	operator double ()
	Returns the time from the initialization measured in seconds. More...
void	show (std::ostream &out, const char *message=NULL) const
	Shows the time used from the beginning up to the current point. More...
void	show (const char *message=NULL) const
	Shows the time used from the beginning up to the current point to the standard output stream. More...

Protected Attributes
double	cpu0
	CPU usage start time (in seconds). More...
std::time_t	t0
	Start time (in seconds). More...
std::ostream *	outstream1
	Output stream 1 (0 for no output). More...
std::ostream *	outstream2
	Output stream 2 (0 for no output). More...
const char *	message
	A message to display instead of "Used time" (if not 0). More...
int	display
	Should the destructor display the time? Note: -1 makes the destructor display times only > 1 sec. More...

Friends
std::ostream &	operator<< (std::ostream &out, const timeused &t)
	Shows the time elapsed up to this point. More...

Detailed Description

A class that stores the time at which it was initialized and then returns or displays the time used since the initialization.

It displays this time when the destructor is invoked, e.g., at the end of program run. This class is used in most of the CHomP programs to measure the time used for the computations.

Definition at line 66 of file timeused.h.

Constructor & Destructor Documentation

timeused() [1/2]

chomp::homology::timeused::timeused ( const char *  msg = NULL )

inline

The default constructor.

It may be given a message to be displayed when the destructor is called.

Definition at line 137 of file timeused.h.

{
        reset ();
        outstream1 = NULL;
        outstream2 = NULL;
        message = msg;
        display = -1;
        return;
} /* timeused::timeused */

References display, message, outstream1, outstream2, and reset().

timeused() [2/2]

chomp::homology::timeused::timeused ( std::ostream &  out, const char *  msg = NULL  )

inline

Definition at line 147 of file timeused.h.

{
        reset ();
        outstream1 = &out;
        outstream2 = NULL;
        message = msg;
        display = -1;
        return;
} /* timeused::timeused */

References display, message, outstream1, outstream2, and reset().

~timeused()

chomp::homology::timeused::~timeused ( )

inline

The destructor.

Definition at line 169 of file timeused.h.

{
        if (!display || (!outstream1 && !outstream2))
                return;
        if ((display > 0) || (double (*this) > 1))
        {
                if (outstream1)
                        show (*outstream1);
                if (outstream2)
                        show (*outstream2);
        }
        return;
} /* timeused::~timeused */

References display, outstream1, outstream2, and show().

Member Function Documentation

operator double()

chomp::homology::timeused::operator double

(

)

Returns the time from the initialization measured in seconds.

operator=() [1/4]

timeused & chomp::homology::timeused::operator= ( const char *  msg )

inline

Changes the message displayed at program's termination.

Definition at line 211 of file timeused.h.

{
        message = msg;
        return *this;
} /* timeused::operator = */

References message.

operator=() [2/4]

timeused & chomp::homology::timeused::operator= ( int  n )

inline

Turns off writing program's running time at program's termination by assigning 0 to an object of this class.

Definition at line 205 of file timeused.h.

{
        display = n;
        return *this;
} /* timeused::operator = */

References display.

operator=() [3/4]

timeused & chomp::homology::timeused::operator= ( outputstream &  out )

inline

Defines an output stream for displaying program's running time at program's termination to a pair of streams.

Definition at line 191 of file timeused.h.

{
        if (out. show)
                outstream1 = &(out. out);
        else
                outstream1 = NULL;
        if (out. log)
                outstream2 = out. getlogstream ();
        else
                outstream2 = NULL;
        return *this;
} /* operator = */

References outstream1, outstream2, and show().

operator=() [4/4]

timeused & chomp::homology::timeused::operator= ( std::ostream &  out )

inline

Defines an output stream for displaying program's running time at program's termination.

Definition at line 183 of file timeused.h.

{
        outstream1 = &out;
        outstream2 = NULL;
        return *this;
} /* timeused::operator = */

References outstream1, and outstream2.

reset()

timeused & chomp::homology::timeused::reset

(

)

Reset the timer to the current moment.

Referenced by timeused().

show() [1/2]

void chomp::homology::timeused::show ( const char *  message = NULL ) const

inline

Shows the time used from the beginning up to the current point to the standard output stream.

The time is preceded with the message (default: "Time used").

Definition at line 217 of file timeused.h.

{
        if (outstream1)
                show (*outstream1, msg);
        if (outstream2)
                show (*outstream2, msg);
        return;
} /* timeused::show */

References outstream1, outstream2, and show().

show() [2/2]

void chomp::homology::timeused::show ( std::ostream &  out, const char *  message = NULL  ) const

inline

Shows the time used from the beginning up to the current point.

The time is preceded with the message (default: "Time used").

Definition at line 157 of file timeused.h.

{
        if (!msg)
                msg = message;
        if (!msg)
                msg = "Time used:";
 
        out << msg << ' ' << *this << '.' << std::endl;
 
        return;
} /* timeused::show */

References message.

Referenced by operator=(), show(), and ~timeused().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  out, const timeused &  t  )

friend

Shows the time elapsed up to this point.

Member Data Documentation

cpu0

double chomp::homology::timeused::cpu0

protected

CPU usage start time (in seconds).

Definition at line 115 of file timeused.h.

display

int chomp::homology::timeused::display

protected

Should the destructor display the time? Note: -1 makes the destructor display times only > 1 sec.

Definition at line 131 of file timeused.h.

Referenced by operator=(), timeused(), and ~timeused().

message

const char* chomp::homology::timeused::message

protected

A message to display instead of "Used time" (if not 0).

Definition at line 127 of file timeused.h.

Referenced by operator=(), show(), and timeused().

outstream1

std::ostream* chomp::homology::timeused::outstream1

protected

Output stream 1 (0 for no output).

Definition at line 121 of file timeused.h.

Referenced by operator=(), show(), timeused(), and ~timeused().

outstream2

std::ostream* chomp::homology::timeused::outstream2

protected

Output stream 2 (0 for no output).

Definition at line 124 of file timeused.h.

Referenced by operator=(), show(), timeused(), and ~timeused().

t0

std::time_t chomp::homology::timeused::t0

protected

Start time (in seconds).

Definition at line 118 of file timeused.h.

---

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

• chomp/system/timeused.h