timing.h

Go to the documentation of this file.

#ifndef _TIMING_H_
#define _TIMING_H_

#include <iostream>
#include <fstream>
#include <string>

/** Logging utility */
class Log {
private:
    std::ofstream fout;

public:
    Log(std::string filename) {
        if (!filename.empty()) {
            fout.open(filename);
        }
    }

    template<typename T>
    std::ostream& operator<<(T x) {
        if (fout.is_open()) {
            fout << x;
            return fout;
        } else {
            std::cerr << x;
            return std::cerr;
        }
    }
};

/** Compute the throughput in Gibipixels = 2^30 pixels
 * \param runtime running time in milliseconds
 * \param pixels number of pixels
 * \returns throughput in MiP/s
 */
float throughput(float runtime, int pixels);

/**
 * Millisecond-precision timer function
 * \return Clock value in milliseconds
 *
 * This routine implements a timer with millisecond precision.  In order to
 * obtain timing at high resolution, platform-specific functions are needed:
 *
 *    - On Windows systems, the GetSystemTime function is used.
 *    - On Mac and POSIX systems, the gettimeofday function is used.
 *
 * Preprocessor symbols are checked in attempt to detect whether the platform
 * is POSIX or Windows or Mac and defines millisecond_timer() accordingly.
 */
unsigned long millisecond_timer(void);

#endif // _TIMING_H_