File: Timer.tex

package info (click to toggle)
waili 19990723-5
  • links: PTS
  • area: main
  • in suites: woody
  • size: 1,196 kB
  • ctags: 916
  • sloc: cpp: 9,681; ansic: 210; makefile: 199; sh: 78
file content (98 lines) | stat: -rw-r--r-- 2,982 bytes parent folder | download | duplicates (9)
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
88
89
90
91
92
93
94
95
96
97
98
%
%	Timer Class
%
%   $Id: Timer.tex,v 4.1.2.1.2.1 1999/07/20 16:16:16 geert Exp $
% 
%   Copyright (C) 1996-1999 Department of Computer Science, K.U.Leuven, Belgium
% 
%   This program is free software; you can redistribute it and/or modify
%   it under the terms of the GNU General Public License as published by
%   the Free Software Foundation; either version 2 of the License, or
%   (at your option) any later version.
% 
%   This program is distributed in the hope that it will be useful,
%   but WITHOUT ANY WARRANTY; without even the implied warranty of
%   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%   GNU General Public License for more details.
% 
%   You should have received a copy of the GNU General Public License
%   along with this program; if not, write to the Free Software
%   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
%

\begin{manpage}{\libtitle}{Timer}{$ $Revision: 4.1.2.1.2.1 $ $}

\subtitle{Name}
    Timer --- Measurement of execution times

% -----------------------------------------------------------------------------

\subtitle{Description}
    This is a simple class for the measurement of execution times.

% -----------------------------------------------------------------------------

\subtitle{Declaration}
    \needsinclude{Timer.h}

\function{Timer()}
    Create a timer.

\function{Timer(const~Timer\& t)}
    Create a timer by copying timer \name{t}.

% -----------------------------------------------------------------------------

\subtitle{Public \\ Operations}

\function{void Start(void)}
    Start the timer.

\function{void Stop(void)}
    Stop the timer.

\function{void Reset(void)}
    Reset the timer to zero.

\function{f32 GetReal(void)\ const}
    Get the \name{Real} part of the run time.

\function{f32 GetUser(void)\ const}
    Get the \name{User} part of the run time.

\function{f32 GetSystem(void)\ const}
    Get the \name{System} part of the run time.

\function{Timer GetStamp(void)\ const}
    Get a time stamp copy of the timer.

\function{int IsRunning(void)\ const}
    Check whether the timer is running.

\function{void Tic(void)}
    Reset and start the timer.

\function{void Toc(void)}
    Dump the current \name{Real}, \name{User} and \name{System} run time to
    \name{stderr}.

\function{Timer operator$+$(const~Timer\& t)}
\function{Timer operator$-$(const~Timer\& t)}
    Add or subtract two timers and return a sum or difference timer.

\function{void operator$+=$(const~Timer\& t)}
\function{void operator$-=$(const~Timer\& t)}
    Add or subtract a timer to or from the current timer.

% -----------------------------------------------------------------------------

\subtitle{See Also}
    The \name{times} function.

% -----------------------------------------------------------------------------

\subtitle{Revision}
     \rev{Timer.C,v 4.0 1997/05/05 09:42:23 geert Exp}
     \rev{Timer.h,v 4.0 1997/05/05 09:47:07 geert Exp}

\end{manpage}