drwnCodeProfiler.h

/*****************************************************************************
** DARWIN: A FRAMEWORK FOR MACHINE LEARNING RESEARCH AND DEVELOPMENT
** Distributed under the terms of the BSD license (see the LICENSE file)
** Copyright (c) 2007-2017, Stephen Gould
** All rights reserved.
**
******************************************************************************
** FILENAME:    drwnCodeProfiler.h
** AUTHOR(S):   Stephen Gould <stephen.gould@anu.edu.au>
**
*****************************************************************************/

#pragma once

#include <ctime>
#include <vector>
#include <map>
#include <string>
#include <iostream>

// macro for function tic/toc
#define DRWN_FCN_TIC static int __drwn_fcn_handle__ = drwnCodeProfiler::getHandle(__PRETTY_FUNCTION__); drwnCodeProfiler::tic(__drwn_fcn_handle__);
#define DRWN_FCN_TOC drwnCodeProfiler::toc(__drwn_fcn_handle__);

class drwnCodeProfiler {
public:
    static bool enabled;  

private:
    //@cond
    class drwnCodeProfilerEntry {
    public:
        clock_t startClock;
    time_t startTime;
    unsigned long totalClock;
        double totalTime;
        int totalCalls;

        drwnCodeProfilerEntry() { clear(); };
        ~drwnCodeProfilerEntry() { /* do nothing */ };

        inline void clear() {
            startClock = clock();
            totalClock = 0L;

        startTime = std::time(NULL);
        totalTime = 0L;

            totalCalls = 0;
        }
        inline void tic() {
            startClock = clock();
        startTime = std::time(NULL);
        }
        inline void toc() {
            clock_t endClock = clock();
        time_t endTime;
        endTime = std::time(NULL);

        if (endClock >= startClock) {
        totalClock += (endClock - startClock);      
        } else {
        totalClock += ((clock_t)(-1) - startClock) + endClock;
        }
            startClock = endClock;
 
        totalTime += difftime(endTime, startTime);
        
            totalCalls += 1;
        }
    };
    //@endcond

    static std::vector<drwnCodeProfilerEntry> _entries;
    static std::map<std::string, int> _names;

public:
    drwnCodeProfiler() { /* do nothing */ }
    ~drwnCodeProfiler() { /* do nothing */ }

    static int getHandle(const char *name);

    static inline void clear() {
        if (enabled) {
            for (std::vector<drwnCodeProfilerEntry>::iterator it = _entries.begin(); it != _entries.end(); ++it) {
                it->clear();
            }
        }
    }
    static inline void clear(int handle) {
        if (enabled) _entries[handle].clear();
    }
    static inline void tic(int handle) {
        if (enabled) _entries[handle].tic();
    }
    static inline void toc(int handle) {
        if (enabled) _entries[handle].toc();
    }
    static inline double walltime(int handle) {
        if (!enabled) return -1.0;
    return _entries[handle].totalTime;
    }
    static inline double time(int handle) {
    if (!enabled) return -1.0;
    return (double)_entries[handle].totalClock / (double)CLOCKS_PER_SEC;
    }
    static inline int calls(int handle) {
    if (!enabled) return -1;
    return _entries[handle].totalCalls;
    }

    static void print();
};