Teuchos_Time.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library 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
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

// Kris
// 07.08.03 -- Move into Teuchos package/namespace

#ifndef _TEUCHOS_TIME_HPP_
#define _TEUCHOS_TIME_HPP_

#include "Teuchos_ConfigDefs.hpp"

#include <ctime>
#ifdef HAVE_MPI
#include "mpi.h"
#else
#ifndef ICL
#include <sys/time.h>
#ifndef MINGW
#include <sys/resource.h>
#endif
#endif
#endif

namespace Teuchos 
{

  /* ADDITIONAL COMMENTS:
   * Initial version by Mike Heroux and Kris Kampshoff. 
   * Modified as follows by Kevin Long, 9/29/03:
   * <ul>
   * <li> There is no need to define explicit copy ctor and dtor for this class.
   * <li> The wallTime() method returns the same value for every instance of this class, so
   * it would be best to make it a static method.
   * <li> Removed the communicator data member. Cross-processor comparisons of timings
   * can be done by the TimeMonitor.
   * </ul>
   */ 

  class Time
  {

  public:
    Time(const std::string& name, bool start = false);
  
    static double wallTime();
  
    void start(bool reset = false);

    double stop();

    double totalElapsedTime(bool readCurrentTime = false) const;

    void reset() {totalTime_ = 0; numCalls_ = 0;}

    bool isRunning() const {return isRunning_;}

    const std::string& name() const {return name_;}

    void incrementNumCalls() {numCalls_++;}

    int numCalls() const {return numCalls_;}

  private:
    double startTime_;

    double totalTime_;

    bool isRunning_;

    std::string name_;

    int numCalls_;
  };

} // namespace Teuchos

#endif // TEUCHOS_TIME_HPP_

---