Both logger and timer can be disabled. Useful when linking to host programs

Roberto Di Remigio · Roberto Di Remigio · commit eadf8707cda6 · 2015-07-22T09:15:49.000+02:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -23,7 +23,8 @@ option(ENABLE_EIGEN_MKL        "Enable Eigen3 automatic fallback to some of Inte
 option(ENABLE_64BIT_INTEGERS   "Enable 64-bit integers"                                           OFF)
 option(ENABLE_CXX11_SUPPORT    "Enable C++11 compiler support"                                    ON)
 # Developers only options
-option(ENABLE_LOGGER           "Enables logger: needs C++11 support"                              ON)
+option(ENABLE_LOGGER           "Enable logger: needs C++11 support"                               ON)
+option(ENABLE_TIMER            "Enable timer"                                                     ON)
 #
 #  CMake modules
 #
diff --git a/cmake/ConfigBoost.cmake b/cmake/ConfigBoost.cmake
@@ -1,8 +1,8 @@
 # Just change the Boost version number here
 # The version of the Boost archive we ship
-set(BOOSTVER 1.54.0) 
+set(BOOSTVER 1.54.0)
 # The minimum required version of Boost
-set(BOOSTVERMIN 1.54.0) 
+set(BOOSTVERMIN 1.54.0)
 if (NOT DEFINED BUILD_CUSTOM_BOOST)
     set(BUILD_CUSTOM_BOOST FALSE)
 endif()
@@ -34,10 +34,10 @@ if(NOT Boost_FOUND)
    set(Boost_LIBRARIES "")
    # Read documentation in FindBoost.cmake for the difference between the singular and plural forms
    set(Boost_INCLUDE_DIR  ${CUSTOM_BOOST_LOCATION}/include)
-   set(Boost_INCLUDE_DIRS ${CUSTOM_BOOST_LOCATION}/include) 
+   set(Boost_INCLUDE_DIRS ${CUSTOM_BOOST_LOCATION}/include)
    set(Boost_LIBRARY_DIR  ${CUSTOM_BOOST_LOCATION}/lib)
    set(Boost_LIBRARY_DIRS ${CUSTOM_BOOST_LOCATION}/lib)
-   # We will link statically, so just set the Boost_<C>_LIBRARY for the static library 
+   # We will link statically, so just set the Boost_<C>_LIBRARY for the static library
    foreach(_component ${needed_components})
       string(TOUPPER ${_component} _COMP)
       set(Boost_${_COMP}_FOUND TRUE)
diff --git a/src/cavity/GePolCavity.cpp b/src/cavity/GePolCavity.cpp
@@ -2,22 +2,22 @@
 /*
  *     PCMSolver, an API for the Polarizable Continuum Model
  *     Copyright (C) 2013 Roberto Di Remigio, Luca Frediani and contributors
- *     
+ *
  *     This file is part of PCMSolver.
- *     
- *     PCMSolver is free software: you can redistribute it and/or modify       
+ *
+ *     PCMSolver 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 3 of the License, or
  *     (at your option) any later version.
- *     
+ *
  *     PCMSolver 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 PCMSolver.  If not, see <http://www.gnu.org/licenses/>.
- *     
+ *
  *     For information on the complete list of contributors to the
  *     PCMSolver API, see: <http://pcmsolver.github.io/pcmsolver-doc>
  */
@@ -37,6 +37,7 @@
 
 #include "Sphere.hpp"
 #include "Symmetry.hpp"
+#include "TimerInterface.hpp"
 
 extern "C" void generatecavity_cpp(int * maxts, int * maxsph, int * maxvert,
                                    double * xtscor, double * ytscor, double * ztscor, double * ar,
@@ -97,7 +98,7 @@ void GePolCavity::build(int maxts, int maxsph, int maxvert)
     double * ze = zv.data();
 
     double * rin = radii_scratch.data();
-    double * mass = new double[molecule_.nAtoms()]; 
+    double * mass = new double[molecule_.nAtoms()];
     for (int i = 0; i < molecule_.nAtoms(); ++i) {
 	    mass[i] = molecule_.masses(i);
     }
@@ -110,14 +111,14 @@ void GePolCavity::build(int maxts, int maxsph, int maxvert)
     int gen3 = molecule_.pointGroup().generators(2);
 
     // Go PEDRA, Go!
-    timerON("GePolCavity::generatecavity_cpp");
+    TIMER_ON("GePolCavity::generatecavity_cpp");
     generatecavity_cpp(&maxts, &maxsph, &maxvert,
                        xtscor, ytscor, ztscor, ar, xsphcor, ysphcor, zsphcor, rsph,
                        &nts, &ntsirr, &nSpheres_, &addedSpheres,
                        xe, ye, ze, rin, mass,
 		       &averageArea, &probeRadius, &minimalRadius,
                        &nr_gen, &gen1, &gen2, &gen3);
-    timerOFF("GePolCavity::generatecavity_cpp");
+    TIMER_OFF("GePolCavity::generatecavity_cpp");
 
     // The "intensive" part of updating the spheres related class data members will be of course
     // executed iff addedSpheres != 0
diff --git a/src/cavity/GePolCavity.hpp b/src/cavity/GePolCavity.hpp
@@ -2,22 +2,22 @@
 /*
  *     PCMSolver, an API for the Polarizable Continuum Model
  *     Copyright (C) 2013 Roberto Di Remigio, Luca Frediani and contributors
- *     
+ *
  *     This file is part of PCMSolver.
- *     
- *     PCMSolver is free software: you can redistribute it and/or modify       
+ *
+ *     PCMSolver 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 3 of the License, or
  *     (at your option) any later version.
- *     
+ *
  *     PCMSolver 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 PCMSolver.  If not, see <http://www.gnu.org/licenses/>.
- *     
+ *
  *     For information on the complete list of contributors to the
  *     PCMSolver API, see: <http://pcmsolver.github.io/pcmsolver-doc>
  */
@@ -37,7 +37,7 @@
 #include "Cavity.hpp"
 #include "CavityData.hpp"
 #include "CavityFactory.hpp"
-#include "Timer.hpp"
+#include "TimerInterface.hpp"
 
 /*! \file GePolCavity.hpp
  *  \class GePolCavity
@@ -54,20 +54,20 @@ class GePolCavity : public Cavity
 public:
     GePolCavity() {}
     GePolCavity(const Molecule & molec, double a, double pr, double minR) :
-        Cavity(molec), averageArea(a), probeRadius(pr), minimalRadius(minR) 
-	{ 
+        Cavity(molec), averageArea(a), probeRadius(pr), minimalRadius(minR)
+	{
 	  std::string checkpointName = "GePolCavity::build";
-	  timerON(checkpointName);
-	  build(10000, 200, 25000); 
-	  timerOFF(checkpointName);
+	  TIMER_ON(checkpointName);
+	  build(10000, 200, 25000);
+	  TIMER_OFF(checkpointName);
 	}
     GePolCavity(const std::vector<Sphere> & sph, double a, double pr, double minR) :
 	Cavity(sph), averageArea(a), probeRadius(pr), minimalRadius(minR)
-	{ 
+	{
 	  std::string checkpointName = "GePolCavity::build";
-	  timerON(checkpointName);
-	  build(10000, 200, 25000); 
-	  timerOFF(checkpointName);
+	  TIMER_ON(checkpointName);
+	  build(10000, 200, 25000);
+	  TIMER_OFF(checkpointName);
 	}
     virtual ~GePolCavity() {}
     friend std::ostream & operator<<(std::ostream & os, GePolCavity & cavity) {
diff --git a/src/interface/Interface.cpp b/src/interface/Interface.cpp
@@ -109,7 +109,7 @@ extern "C" void tear_down_pcm()
 extern "C" void write_timings()
 {
     // Print out timings to pcmsolver.timer.dat
-    timerDONE("pcmsolver.timer.dat");
+    TIMER_DONE("pcmsolver.timer.dat");
 }
 
 extern "C" void compute_asc(char * potString, char * chgString, int * irrep)
diff --git a/src/utils/CMakeLists.txt b/src/utils/CMakeLists.txt
@@ -8,7 +8,7 @@ list(SORT headers_list)
 set(to_includer "${headers_list}")
 # Write headers to Includer.hpp
 file(APPEND "${PROJECT_BINARY_DIR}/include/Includer.hpp" "// Helper classes\n")
-list(REMOVE_ITEM to_includer "BuildInfo.hpp" "cnpy.hpp" "Logger.hpp" "LoggerImpl.hpp" "LoggerInterface.hpp" "TestingMolecules.hpp")
+list(REMOVE_ITEM to_includer "BuildInfo.hpp" "cnpy.hpp" "Logger.hpp" "LoggerImpl.hpp" "LoggerInterface.hpp" "TestingMolecules.hpp" "Timer.hpp")
 write_to_Includer("${to_includer}")
 
 set(sources_list "")
diff --git a/src/utils/LoggerInterface.hpp b/src/utils/LoggerInterface.hpp
@@ -1,7 +1,7 @@
 #ifndef LOGGERINTERFACE_HPP
 #define LOGGERINTERFACE_HPP
 
-#ifdef HAS_CXX11
+#ifdef ENABLE_LOGGER
 
 #include "Logger.hpp"
 #include "Timer.hpp"
@@ -11,15 +11,15 @@ static logging::logger<logging::FileLogPolicy> loggerInstance("pcmsolver.executi
 #define LOG loggerInstance.print<logging::printLevel::coarse>
 #define LOG_FINE loggerInstance.print<logging::printLevel::fine>
 #define LOG_ALL loggerInstance.print<logging::printLevel::everything>
-#define LOG_TIME loggerInstance.print<logging::printLevel::timings>(Timer::TheTimer());
+#define LOG_TIME loggerInstance.print<logging::printLevel::timings>(timer::Timer::TheTimer());
 
-#else // HAS_CXX11
+#else // ENABLE_LOGGER
 
 #define LOG(...)
 #define LOG_FINE(...)
 #define LOG_ALL(...)
 #define LOG_TIME
 
-#endif // HAS_CXX11
+#endif // ENABLE_LOGGER
 
 #endif // LOGGERINTERFACE_HPP
diff --git a/src/utils/Timer.hpp b/src/utils/Timer.hpp
@@ -36,6 +36,7 @@
 #include <boost/foreach.hpp>
 #include <boost/timer/timer.hpp>
 
+namespace timer {
 typedef std::map<std::string, boost::timer::cpu_timer> timersMap;
 typedef std::pair<std::string, boost::timer::cpu_timer> timersPair;
 
@@ -48,13 +49,6 @@ typedef std::pair<std::string, boost::timer::cpu_times> timingsPair;
  *  \author Roberto Di Remigio
  *  \date 2014
  *
- *  To time a code snippet:
- *  \code{.cpp}
- *  timerON("code-snippet");
- *  // code-snippet
- *  timerOFF("code-snippet");
- *  \endcode
- *  The timings are printed out by a call to the timerDONE function.
  */
 
 class Timer
@@ -163,5 +157,6 @@ inline void timerDONE(const std::string & fname)
     timing_report << Timer::TheTimer() << std::endl;
     timing_report.close();
 }
+} // namespace timer
 
 #endif // TIMER_HPP
diff --git a/src/utils/TimerInterface.hpp b/src/utils/TimerInterface.hpp
@@ -0,0 +1,28 @@
+#ifndef TIMERINTERFACE_HPP
+#define TIMERINTERFACE_HPP
+
+/*  To time a code snippet:
+ *  \code{.cpp}
+ *  TIMER_ON("code-snippet");
+ *  // code-snippet
+ *  TIMER_OFF("code-snippet");
+ *  \endcode
+ *  The timings are printed out by a call to the TIMER_DONE function.
+ */
+#ifdef ENABLE_TIMER
+
+#include "Timer.hpp"
+
+#define TIMER_ON timer::timerON
+#define TIMER_OFF timer::timerOFF
+#define TIMER_DONE timer::timerDONE
+
+#else // ENABLE_TIMER
+
+#define TIMER_ON(...)
+#define TIMER_OFF(...)
+#define TIMER_DONE(...)
+
+#endif // ENABLE_TIMER
+
+#endif // TIMERINTERFACE_HPP

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@ option(ENABLE_EIGEN_MKL "Enable Eigen3 automatic fallback to some of Inte`
`23`	`23`	`option(ENABLE_64BIT_INTEGERS "Enable 64-bit integers" OFF)`
`24`	`24`	`option(ENABLE_CXX11_SUPPORT "Enable C++11 compiler support" ON)`
`25`	`25`	`# Developers only options`
`26`		`-option(ENABLE_LOGGER "Enables logger: needs C++11 support" ON)`
	`26`	`+option(ENABLE_LOGGER "Enable logger: needs C++11 support" ON)`
	`27`	`+option(ENABLE_TIMER "Enable timer" ON)`
`27`	`28`	`#`
`28`	`29`	`# CMake modules`
`29`	`30`	`#`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ extern "C" void tear_down_pcm()`
`109`	`109`	`extern "C" void write_timings()`
`110`	`110`	`{`
`111`	`111`	`// Print out timings to pcmsolver.timer.dat`
`112`		`- timerDONE("pcmsolver.timer.dat");`
	`112`	`+ TIMER_DONE("pcmsolver.timer.dat");`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`extern "C" void compute_asc(char * potString, char * chgString, int * irrep)`