timer.hh

Go to the documentation of this file.

// timer.hh: this file is part of the Vaucanson project.
//
// Vaucanson, a generic library for finite state machines.
//
// Copyright (C) 2006, 2007 The Vaucanson Group.
//
// 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.
//
// The complete GNU General Public Licence Notice can be found as the
// `COPYING' file in the root directory.
//
// The Vaucanson Group consists of people listed in the `AUTHORS' file.
//

#ifndef VCSN_MISC_TIMER_HH
# define VCSN_MISC_TIMER_HH

# include <stack>
# include <map>
# include <list>
# include <string>
# include <iosfwd>

# define VAUCANSON 1

# if defined VAUCANSON
#  define NAMESPACE_VCSN_BEGIN namespace vcsn {
#  define NAMESPACE_VCSN_END   } // namespace vcsn
#  include <vaucanson/misc/contract.hh>
# else
#  define NAMESPACE_VCSN_BEGIN
#  define NAMESPACE_VCSN_END
#  include <cassert>
#  define precondition(C) assert(C)
# endif

NAMESPACE_VCSN_BEGIN

namespace misc
{

  class Timer
  {
  public:
    friend class Bencher;

    class TimeVar;
    typedef std::map<const std::string, TimeVar> task_map_type;

    Timer ();
    Timer (const Timer& rhs);
    ~Timer ();

    Timer operator= (const Timer& rhs);

    void push (const std::string& name);

    void push (const int i);

    void pop (const std::string& task_name);

    void pop (const int i);

    void pop ();

    std::ostream& print (std::ostream& o, const bool) const;

    void print_on_destruction (std::ostream& out);

    void name (int i, const std::string& name);

    void start ();

    void stop ();

    Timer& operator<< (const Timer& rhs);

    Timer& operator+= (const Timer& rhs);

    Timer& operator/= (unsigned rhs);

    Timer operator/ (unsigned rhs) const;

    bool operator< (const Timer& rhs) const;

    void clear();

    TimeVar& operator[] (const std::string& s);

  public :
    class Time
    {
      friend class Bencher;
      friend class Timer;
      friend class Timer::TimeVar;
    public:
      Time ();
      void set_to_now ();
      static Time now ();

      void clear ();

      operator bool () const;
      bool operator ! () const;

      Time& operator += (const Time& rhs);
      Time operator + (const Time& rhs) const;

      Time& operator -= (const Time& rhs);
      Time operator - (const Time& rhs) const;

      Time& operator/= (unsigned n);
      Time operator/ (unsigned n) const;

      bool operator< (const Time& rhs) const;

    private:
      long user;
      long sys;
      long wall;
    };

    class TimeVar
    {
    public:
      friend class Timer;
      friend class Bencher;

      TimeVar ();
      void start ();
      void start_child ();
      void stop_child ();
      void stop ();

      void clear ();

      operator bool () const;
      bool operator ! () const;

      TimeVar operator+= (const TimeVar& rhs);
      TimeVar operator+ (const TimeVar& rhs) const;
      TimeVar operator/= (unsigned n);
      TimeVar operator/ (unsigned n) const;

      bool operator< (const TimeVar& rhs) const;


    private:
      Time lap ();

      Time begin;

      Time elapsed;

      Time cumulated;
    };

    std::ostream& print_time (long t, long total, std::ostream& o) const;
    std::ostream& print_time (std::string s,
                              const Time& t, const Time& tot,
                              std::ostream& o,
                              const bool tree_mode) const;


  private:
    task_map_type tasksmap;

    std::map<std::string, std::string> tab_to_disp;

    // Store tasks in order of creation
    std::list<std::string> task_ordered;

    std::stack<TimeVar*> tasks;

    std::map<int, std::string> intmap;

    TimeVar total;

    std::ostream* dump_stream;

    const long clocks_per_sec;
  };

  std::ostream& operator<< (std::ostream& o, const Timer& t);

  class ScopedTimer
  {
  public:
    ScopedTimer (Timer& timer, const std::string& key);
    ~ScopedTimer ();
  private:
    Timer& timer_;
    const std::string key_;
  };

} // namespace misc

NAMESPACE_VCSN_END

# if !defined VCSN_USE_INTERFACE_ONLY || defined VCSN_USE_LIB
#  include <vaucanson/misc/timer.hxx>
#  if defined VAUCANSON
#   include <vaucanson/misc/timer.cc>
#  endif
# endif // !VCSN_USE_INTERFACE_ONLY

#endif // !VCSN_MISC_TIMER_HH

---