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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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
#if ICL || defined(_WIN32)
#include <time.h>
#else
#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 TEUCHOS_LIB_DLL_EXPORT 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_