/usr/include/trilinos/Teuchos_TimeMonitor.hpp is in libtrilinos-dev 10.4.0.dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | // @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
#ifndef TEUCHOS_TIMEMONITOR_HPP
#define TEUCHOS_TIMEMONITOR_HPP
/*! \file Teuchos_TimeMonitor.hpp
*
* \brief Timer class that starts when constructed and stops when the
* destructor is called
*/
/** \example TimeMonitor/cxx_main.cpp
*
* This is an example of how to use the Teuchos::TimeMonitor class.
*/
#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_PerformanceMonitorBase.hpp"
#include "Teuchos_Time.hpp"
/** \brief Defines a static non-member function that returns a time monitor.
*/
#define TEUCHOS_TIMER(funcName, strName) \
static Teuchos::Time& funcName() \
{static Teuchos::RCP<Time> rtn = \
Teuchos::TimeMonitor::getNewCounter(strName); return *rtn;}
/** \brief Defines a timer for a specific function (with differentiator).
*
* Same as TEUCHOS_FUNC_TIME_MONITOR(...) except required when used more than
* once in the same function (like a block of code).
*/
#define TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, DIFF ) \
static Teuchos::RCP<Teuchos::Time> DIFF ## blabla_localTimer; \
if(!DIFF ## blabla_localTimer.get()) { \
std::ostringstream oss; \
oss << FUNCNAME; \
DIFF ## blabla_localTimer = Teuchos::TimeMonitor::getNewCounter(oss.str()); \
} \
Teuchos::TimeMonitor DIFF ## blabla_localTimeMonitor(*DIFF ## blabla_localTimer)
/** \brief Defines a timer for a specific function.
*
* Note that the name of the timer can be formated with stream inserts.
* For example, we can define a time monitor for a function as follows:
\code
template<typename Scalar>
void foo()
{
TEUCHOS_FUNC_TIME_MONITOR(
"foo<"<<Teuchos::ScalarTraits<Scalar>::name()<<">()"
);
...
}
\endcode
* The timer can then be printed at the end of the program using
\code
Teuchos::TimeMonitor::summarize(std::cout);
\endcode
*/
#define TEUCHOS_FUNC_TIME_MONITOR( FUNCNAME ) \
TEUCHOS_FUNC_TIME_MONITOR_DIFF( FUNCNAME, main )
namespace Teuchos {
/** \brief A timer class that starts when constructed and stops when the
* destructor is called.
*
* Termination upon destruction lets this timer behave
* correctly even if scope is exited because of an std::exception.
*
* NOTE: It is critical that this class only be used to time functions that
* are called only within the main program and not at pre-program setup or
* post-program teardown!
*
* \note Teuchos::TimeMonitor uses the Teuchos::Time class internally.
*/
class TEUCHOS_LIB_DLL_EXPORT TimeMonitor : public PerformanceMonitorBase<Time>
{
public:
/** \name Constructor/Destructor */
//@{
/** \brief Constructor starts timer */
TimeMonitor(Time& timer, bool reset=false)
: PerformanceMonitorBase<Time>(timer, reset)
{
if (!isRecursiveCall()) counter().start(reset);
}
/** \brief Destructor causes timer to stop */
~TimeMonitor()
{
if (!isRecursiveCall()) counter().stop();
}
//@}
/** \name Static functions */
//@{
/** \brief Wrapping of getNewCounter() for backwards compatibiity with old
* code.
*/
static Teuchos::RCP<Time> getNewTimer(const std::string& name)
{return getNewCounter(name);}
/** \brief Reset the global timers to zero.
*
* <b>Preconditions:</b><ul>
* <li>None of the timers must currently be running!
* </ul>
*/
static void zeroOutTimers();
/** \brief Print summary statistics for a group of timers.
*
* Timings are gathered from all processors
*
* \note This method <b>must</b> be called by all processors */
static void summarize(
std::ostream &out=std::cout,
const bool alwaysWriteLocal=false,
const bool writeGlobalStats=true,
const bool writeZeroTimers=true
);
//@}
};
} // namespace Teuchos
#endif // TEUCHOS_TIMEMONITOR_H
|