cgal/Packages/Timer/include/CGAL/Real_timer.h

// ======================================================================
//
// Copyright (c) 1997 The CGAL Consortium
//
// This software and related documentation is part of an INTERNAL release
// of the Computational Geometry Algorithms Library (CGAL). It is not
// intended for general use.
//
// ----------------------------------------------------------------------
//
// release       : $CGAL_Revision: CGAL-2.4-I-18 $
// release_date  : $CGAL_Date: 2001/10/16 $
//
// file          : include/CGAL/Real_timer.h
// package       : Timer (2.1.1)
// maintainer    : Matthias Baesken <baesken@informatik.uni-trier.de>
// revision      : 2.1.1
// revision_date : 10 December 2001 
// author(s)     : Lutz Kettner  <kettner@inf.ethz.ch>
//                 Matthias Baesken <baesken@informatik.uni-halle.de>
// coordinator   : INRIA, Sophia Antipolis
//
// A timer class to measure real-time.
// ======================================================================

#ifndef CGAL_REAL_TIMER_H
#define CGAL_REAL_TIMER_H 1

#ifndef CGAL_BASIC_H
#include <CGAL/basic.h>
#endif

#if defined (_MSC_VER)
#define CGAL_PROTECT_SYS_TIME_H
#include <sys/timeb.h>
#include <sys/types.h>
#endif

#if defined (__BORLANDC__)
#define CGAL_PROTECT_SYS_TIME_H
#include <sys/timeb>
#include <ctype> 
#endif
#if defined (__MWERKS__)
#define CGAL_PROTECT_SYS_TIME_H
#include <ctime>
#endif

// used for gettimeofday()
#ifndef CGAL_PROTECT_SYS_TIME_H
#include <sys/time.h>
#define CGAL_PROTECT_SYS_TIME_H
#endif // CGAL_PROTECT_SYS_TIME_H

CGAL_BEGIN_NAMESPACE

// SECTION: A Timer Measuring Real-Time
// ========================================================================
// 
// DEFINITION
// 
// A timer `t' of type Real_timer is an object with a state. It is
// either running or it is stopped. The state is controlled with
// `t.start()' and `t.stop()' . The timer counts the time elapsed since
// its creation or last reset. It counts only the time where it is in the
// running state. The time information is given in seconds.

class Real_timer {
private:

#if !defined (_MSC_VER) && !defined(__BORLANDC__) && !defined(__MWERKS__)
    typedef struct timeval  Timetype;
#endif
#if defined (_MSC_VER)
    typedef struct _timeb   Timetype; //MSC
#endif
#if defined (__BORLANDC__)
    typedef struct timeb    Timetype; //Borland
#endif

#if defined(__MWERKS__)
  typedef struct std::tm         Timetype; // Metrowekrs CodeWarrior
#endif


    inline  int get_time(Timetype* t) const;
    inline  void report_err() const;
    inline  double recalc_time(const Timetype& t) const;
    
    double          elapsed;
    Timetype        started;
    int             interv;
    bool            running;
    double          eps;

public:
    Real_timer() : elapsed(0), interv(0), running(false) {}

    void     start();
    void     stop ();
    void     reset();
    bool     is_running() const { return running; }

    double   time()       const;
    int      intervals()  const { return interv; }
    double   precision()  const 
    { 
      return -1;
	  // change it ...
    }
    double   max() const        { return double(INT_MAX);}
};


/*****************************************************************************/

// private member functions.
// all the platform-specific functions are encapsulated here.

inline int Real_timer::get_time(Timetype* t) const {
#if !defined(_MSC_VER) && !defined(__BORLANDC__) && !defined(__MWERKS__)
  return gettimeofday( t, NULL);
#endif
#if defined (_MSC_VER)
    _ftime(t);  
#endif
#if defined (__BORLANDC__)
    ftime(t);  
#endif
#if defined (__MWERKS__)
    CGAL_CLIB_STD::time_t tt;
    CGAL_CLIB_STD::time(&tt);
    Timetype* lt = CGAL_CLIB_STD::localtime(&tt);
    *t = *lt;
#endif
  return 0;
 
}

inline void Real_timer::report_err() const {
 #if !defined (_MSC_VER) && !defined(__BORLANDC__)
  std::cerr << "Real_timer error: gettimeofday() returned -1.\n"
	    << std::endl;
  CGAL_CLIB_STD::abort();
#else
  std::cout << "Real_timer error!.\n" << std::endl;
#endif
}

inline double Real_timer::recalc_time(const Timetype& t) const {
#if !defined(_MSC_VER) && !defined(__BORLANDC__) && !defined(__MWERKS__)
  return double(t.tv_sec  - started.tv_sec) 
    + double(t.tv_usec - started.tv_usec) / 1000000;
#else
#if defined (__MWERKS__)
  /// we copy them because mktime can modify
  Timetype tt1 = t;
  Timetype tt2 = started;
  CGAL_CLIB_STD::time_t t1 = CGAL_CLIB_STD::mktime(&tt1);
  CGAL_CLIB_STD::time_t t2 = CGAL_CLIB_STD::mktime(&tt2);

  return CGAL_CLIB_STD::difftime(t1, t2);
#else // _MSC_VER || __BORLANDC__
  return ((double)(t.time - started.time)) 
    + ((double)(t.millitm - started.millitm))/1000.0;
#endif
#endif
}

// Member functions Real_timer
// ================================

inline void Real_timer::start() {
    CGAL_assertion( ! running);
    int res=0;
    res = get_time(&started);
    if ( res < 0) report_err();
    running = true;
    ++ interv;
}

inline void Real_timer::stop() {
    CGAL_assertion(running);
    Timetype t;
    int res=0;
    res = get_time(&t);
    if ( res < 0) report_err();
    elapsed += recalc_time(t);
    running  = false;
}

inline void Real_timer::reset() {
    interv = 0;
    elapsed = 0;
    if (running) {
	int res = 0;
        res = get_time(&started);
	if ( res < 0)  report_err();
	++ interv;
    }
}

inline double Real_timer::time() const {
  if (running) {
    Timetype t;
    int res = 0;
    res = get_time(&t);
    if ( res < 0) report_err();
    return elapsed + recalc_time(t);
  }
  return elapsed;
}

CGAL_END_NAMESPACE

#endif // CGAL_REAL_TIMER_H //
// EOF //