CepsProfiler.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS 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 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "common/core/CepsTypes.hpp"
 
class Profiler
{
 
  public:
 
    Profiler();
    Profiler(const Profiler&) = delete;
  
    Profiler&
    operator=(const Profiler&) = delete;
  
    ~Profiler();
  
    void
    start(CepsString lbl, CepsString dspl = "");
  
    void
    restart(CepsString lbl);
  
    void
    stop(CepsString lbl);
  
    void
    display(const CepsString& lbl, std::ostream& os) const;
  
    void
    display(const CepsString& lbl) const;
  
    void
    display(std::ostream&) const;
  
    void
    display() const;
  
    void
    logMemoryUsage(const CepsString& xtic);
  
    void
    logMemoryUsageIf(CepsBool ifexpr, const CepsString& xtic);
  
    size_t
    localMemoryUsage();
  
    size_t
    globalMemoryUsage();
 
 
  private:
 
    CepsMap<CepsString,CepsReal>   m_seconds;   
    CepsMap<CepsString,clock_t>    m_tmpTimes;  
    CepsMap<CepsString,CepsString> m_dsplStrs;  
    CepsUInt                       m_maxLen;    
 
};