INGOR
ytTimer.h
1/*
2 util/ytTimer.{h,c} : Timer functions
3 Copyright (C) 2016 Yoshinori Tamada <tamada A T ytlab.jp>
4 All rights reserved.
5
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions
8 are met:
9
10 * Redistributions of source code must retain the above copyright
11 notice, this list of conditions and the following disclaimer.
12
13 * Redistributions in binary form must reproduce the above copyright
14 notice, this list of conditions and the following disclaimer in
15 the documentation and/or other materials provided with the
16 distribution.
17
18 * Neither the name of The University of Tokyo nor the names of its
19 contributors may be used to endorse or promote products derived
20 from this software without specific prior written permission.
21
22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 POSSIBILITY OF SUCH DAMAGE.
34*/
35
36#ifndef __YTLIB_TIMER_H
37#define __YTLIB_TIMER_H
38
39#ifndef _WIN64
40#include <sys/time.h>
41#else
42#include "win/systime.h"
43#endif
44#include <time.h>
45#include <stdio.h>
46
50typedef enum {
56
57typedef struct ytTimer_t ytTimer;
58
60void ytTimer_delete(ytTimer * timer);
61void ytTimer_enableSector(ytTimer * this);
62void ytTimer_set_type(ytTimer * timer, ytTimer_type type);
64 ytTimer_get_type(const ytTimer * timer);
65
66void ytTimer_start(ytTimer * timer);
67void ytTimer_start_type(ytTimer * timer, ytTimer_type type);
68void ytTimer_stop(ytTimer * timer);
69void ytTimer_stopLap(ytTimer * this);
70void ytTimer_clear(ytTimer * timer);
71void ytTimer_clearStart(ytTimer * timer);
72
73double ytTimer_get(const ytTimer * timer);
74double ytTimer_lap(ytTimer * timer);
75void ytTimer_sector(ytTimer * this);
76double ytTimer_get_avg_lap(const ytTimer * timer);
77double ytTimer_getTime();
78void ytTimer_printDDHHMMSS(ytTimer * timer, FILE * fp);
79void ytTimer_printDDHHMMSSsec(FILE * fp, double seconds);
80void ytTimer_printDDHHMMSSSSSsec(FILE * fp, double seconds);
81void ytTimer_printDDHHMMSSSSS(const ytTimer * timer, FILE * fp);
82void ytTimer_print(const ytTimer * this, FILE * fp);
83
84#endif /* __YTLIB_TIMER_H */
85
86/* End of file. */
Structure for Timer functions.
ytTimer * ytTimer_new()
Constructs the ytTimer instance.
Definition: ytTimer.c:97
void ytTimer_printDDHHMMSS(ytTimer *timer, FILE *fp)
Prints the current timer in day, hour, min, sec format.
Definition: ytTimer.c:449
double ytTimer_getTime()
Returns the absolute time (seconds from Jan. 1, 1970).
Definition: ytTimer.c:422
void ytTimer_start_type(ytTimer *timer, ytTimer_type type)
Start to measure the time with a timer type.
Definition: ytTimer.c:176
void ytTimer_printDDHHMMSSSSS(const ytTimer *timer, FILE *fp)
Prints the current timer in day, hour, min, sec and milli-sec.
Definition: ytTimer.c:475
void ytTimer_delete(ytTimer *this)
Deletes the ytTimer instance.
Definition: ytTimer.c:114
ytTimer_type
Timer types.
Definition: ytTimer.h:50
@ ytTimer_NORMAL
Definition: ytTimer.h:52
@ ytTimer_CLOCK
timer based on CPU clocks
Definition: ytTimer.h:54