src/LoggingFunction.h

Go to the documentation of this file.

//
// C++ Interface: LoggingFunction.h
//
// Description:
//
//
// Author: Roman Geus <roman.geus@psi.ch>, (C) 2005
//
// Copyright: See COPYING file that comes with this distribution
//
//

#ifndef LoggingFunction_h
#define LoggingFunction_h

template <typename FunctionType, typename ScalarType>
class LoggingFunction {
public:
    LoggingFunction(FunctionType f)
            : function_(f), 
              plot_enabled_(false) 
    {
        // Initialise member variables
        reset();
    }
    ~LoggingFunction() {
        // Call reset() to close file
        reset();
    }
    ScalarType operator() (ScalarType x) {
        ScalarType y = function_(x);
        ++ num_eval_;
        if (y < y_min_)
            y_min_ = y;
        if (y > y_max_)
            y_max_ = y;
        if (plot_enabled_)
            of_ << x << " " << y << std::endl;
        return y;
    }
    void reset() {
        y_min_ = std::numeric_limits<ScalarType>::max();
        y_max_ = -y_min_;
        num_eval_ = 0;
        if (plot_enabled_)
            of_.close();
        plot_enabled_ = false;
    }
    void enable_plot(std::string filename) {
        if (plot_enabled_)
            of_.close();
        of_.open(filename.c_str());
        plot_enabled_ = true;
    }
    ScalarType get_y_min() const {
        return y_min_;
    }
    ScalarType get_y_max() const {
        return y_max_;
    }
    int get_num_eval() const {
        return num_eval_;
    }
private:
    ScalarType y_min_;
    ScalarType y_max_;
    int num_eval_;
    FunctionType function_;
    bool plot_enabled_;
    std::ofstream of_;
};

#endif

---