/home/rex/ebltrunk/core/libeblearn/include/ebl_logger.h

/***************************************************************************
 *   Copyright (C) 2008 by Yann LeCun and Pierre Sermanet *
 *   yann@cs.nyu.edu, pierre.sermanet@gmail.com *
 *
 * 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.
 *     * Redistribution under a license not approved by the Open Source
 *       Initiative (http://www.opensource.org) must display the
 *       following acknowledgement in all advertising material:
 *        This product includes software developed at the Courant
 *        Institute of Mathematical Sciences (http://cims.nyu.edu).
 *     * The names of the authors may not be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``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 AUTHORS 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 EBL_LOGGER_H_
#define EBL_LOGGER_H_

#include "ebl_defines.h"
#include "libidx.h"
#include "ebl_states.h"

#ifndef __NOSTL__
#include <vector>
#endif

namespace ebl {


  class class_state {
  public:
    ubyte output_class;
    float confidence;
    idx<ubyte> *sorted_classes;
    idx<float> *sorted_scores;

    class_state(ubyte n);
    ~class_state();
    void resize(ubyte n);
  };


  // TODO: allow definition of different comparison functions.
  class EXPORT classifier_meter {
  public:
    // TODO: allow passing of comparison function
    classifier_meter();

    ~classifier_meter();

    void init(uint nclasses);
    
    int correctp(ubyte co, ubyte cd);

    void clear();
    void resize(intg sz);

    char update(intg a, class_state *co, ubyte cd, double energy);
    void update(intg age_, bool correct, double energy);
    // TODO: clean up design
    // TODO: add confusion matrix computation
    void update(intg age, uint desired, uint infered, double energy);

    void test(class_state *co, ubyte cd, double energy);

    double class_normalized_average_error(idx<int> &confu);

    double overall_average_error(idx<int> &confu);

    double class_normalized_average_success(idx<int> &confu);

    int get_class_samples(idx<int> &confu, intg classid);

    int get_class_errors(idx<int> &confu, intg classid);
    double get_normalized_error();
    idx<int>& get_confusion();

    void info();
    void info_sprint();
    void info_print();

    void display(int iteration, string &dsname, 
                 std::vector<string*> *lblstr = NULL,
                 bool ds_is_test = false);

    void display_average(string &dsname, std::vector<string*> *lblstr = NULL,
                         bool ds_is_test = false);

    void display_positive_rates(double threshold,
                                std::vector<string*> *lblstr = NULL);
    
    bool save();
    bool load();
    
  public:
    double              energy;
    float               confidence;
    intg                size; 
    intg                age;
    intg                total_correct;
    intg                total_error;
    intg                total_punt;
    double              total_energy;
    std::vector<uint>   class_errors;
    std::vector<uint>   class_totals;
    std::vector<uint>   class_tpr;
    std::vector<uint>   class_fpr;
    std::vector<std::string> log_fields; 
    std::vector<double> log_values; 
    std::vector<double> total_values; 
  private:
    idx<int>            confusion;      
    idx<int>            total_confusion;
    uint                nclasses;       
  };


  template <class T> class max_classer { // TODO: idx3-classer
  public:
    idx<ubyte> *classindex2label; 

    max_classer(idx<ubyte> *classes);
    ~max_classer() {
    }
    ;

    void fprop(fstate_idx<T> *in, class_state *out);
  };

} // namespace ebl {

#endif /* EBL_LOGGER_H_ */