MercuryTime.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * 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.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE MERCURYDPM DEVELOPERS TEAM 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.
 
#ifndef TIME_H
#define TIME_H
 
#include <ctime>
#include <ctime>
#include <cstring>
#include <sstream>
#include <chrono>
#include <cmath>
#include "GeneralDefine.h"
#include "Logger.h"
 
class Time
{
public:
    
    Time () {
        tic();
        start = 0;
        finish = 0;
    }
    
    void tic()
    {
        start = clock(); //clock tics
        wallClockStart = std::chrono::high_resolution_clock::now();
    }
    
    Mdouble toc()
    {
        finish = clock();
        wallClockFinish = std::chrono::high_resolution_clock::now();
        return getWallTime();
    }
    
    Mdouble getCPUTime() const
    {
        return (Mdouble(finish) - Mdouble(start)) / CLOCKS_PER_SEC;
    }
    
    Mdouble getWallTime()
    {
        return std::chrono::duration<double>(wallClockFinish-wallClockStart).count();
    }
 
    Mdouble toctic()
    {
        Mdouble tocTime = toc();
        start = finish;
        return tocTime;
    }
    
private:
    clock_t start;
    std::chrono::time_point<std::chrono::high_resolution_clock> wallClockStart;
    
    clock_t finish;
    std::chrono::time_point<std::chrono::high_resolution_clock> wallClockFinish;
};
 
class Time2Finish
{
public:
    
    Time2Finish(Mdouble t, Mdouble tMax)
    {
        startTime_ = clock();
        time_ = t;
        timeMax_ = tMax;
    }
    
    Mdouble getTime2Finish(Mdouble t)
    {
        clock_t finish = clock();
        Mdouble elapsedTime = (Mdouble(finish) - Mdouble(startTime_)) / CLOCKS_PER_SEC;
        
        if (fabs(time_ - t) < 1.e-9)
        {
            logger(WARN, "Choose an other value for t");
            return 0;
        }
        else
        {
            Mdouble time2Finish = elapsedTime * (timeMax_ - time_) / (t - time_);
            startTime_ = finish;
            time_ = t;
            return time2Finish;
        }
    }
    
    std::string getFinishTime(Mdouble t)
    {
        // gets the estimated time left to finish.
        Mdouble time2Finish = getTime2Finish(t);
        
        // adds to the estimated time to current time and also type-casting Mdouble to time_t.
        time_t finish = time(nullptr) + time2Finish;
        
        std::stringstream ss;
        
        //write estimated end time
        ss << ctime(&finish);
        
        //decrement put pointer by one to avoid line break
        ss.seekp((long) ss.tellp() - 1);
        
        //write time to finish
        ss << " (" << time2Finish / 3600 << "h)";
        return ss.str();
    }
 
private:
    clock_t startTime_;
    
    Mdouble time_;
    
    Mdouble timeMax_;
    
};
 
#endif