include/yaz/timing.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2012 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file timing.h
  30    \brief Timing Utilities
  31
  32  */
  33
  34 #ifndef YAZ_TIMING_H
  35 #define YAZ_TIMING_H
  36
  37 #include <yaz/yconfig.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /** \brief YAZ timing handle (opaque type)
  42  */
  43 typedef struct yaz_timing *yaz_timing_t;
  44
  45 /** \brief create timing handle
  46     \returns timing handle
  47
  48    \verbatim
  49     yaz_timing_t my = yaz_timing_create();
  50     yaz_timing_start(my);
  51     do_work();
  52     yaz_timing_stop(my);
  53
  54     printf("real=%g user=%g sys=%g\n",
  55        yaz_timing_get_real(my),
  56        yaz_timing_get_user(my),
  57        yaz_timing_get_sys(my));
  58
  59     yaz_timing_destroy(my);
  60
  61    \endverbatim
  62  */
  63 YAZ_EXPORT
  64 yaz_timing_t yaz_timing_create(void);
  65
  66 /** \brief start timer
  67     \param t timing handle
  68  */
  69 YAZ_EXPORT
  70 void yaz_timing_start(yaz_timing_t t);
  71
  72 /** \brief stop timer
  73     \param t timing handle
  74
  75     Use yaz_timing_get_real, yaz_timing_get_user and yaz_timing_get_sys
  76     to fetch timing results.
  77 */
  78 YAZ_EXPORT
  79 void yaz_timing_stop(yaz_timing_t t);
  80
  81 /** \brief returns real time in seconds
  82     \param t timing handle
  83     \returns time in seconds
  84 */
  85 YAZ_EXPORT
  86 double yaz_timing_get_real(yaz_timing_t t);
  87
  88 /** \brief returns user time in seconds
  89     \param t timing handle
  90     \returns time in seconds
  91 */
  92 YAZ_EXPORT
  93 double yaz_timing_get_user(yaz_timing_t t);
  94
  95 /** \brief returns system time in seconds
  96     \param t timing handle
  97     \returns time in seconds
  98 */
  99 YAZ_EXPORT
 100 double yaz_timing_get_sys(yaz_timing_t t);
 101
 102 /** \brief destroys timing handle
 103 */
 104 YAZ_EXPORT
 105 void yaz_timing_destroy(yaz_timing_t *tp);
 106
 107 YAZ_END_CDECL
 108
 109 #endif
 110 /*
 111  * Local variables:
 112  * c-basic-offset: 4
 113  * c-file-style: "Stroustrup"
 114  * indent-tabs-mode: nil
 115  * End:
 116  * vim: shiftwidth=4 tabstop=8 expandtab
 117  */
 118