ROCEvaluation.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * Written (W) 2011 Sergey Lisitsyn
 * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
 */

#ifndef ROCEVALUATION_H_
#define ROCEVALUATION_H_

#include <shogun/lib/config.h>

#include <shogun/evaluation/BinaryClassEvaluation.h>

namespace shogun
{

class CLabels;

class CROCEvaluation: public CBinaryClassEvaluation
{
public:
    CROCEvaluation() :
        CBinaryClassEvaluation(), m_computed(false)
    {
        m_ROC_graph = SGMatrix<float64_t>();
        m_thresholds = SGVector<float64_t>();
    };

    virtual ~CROCEvaluation();

    virtual const char* get_name() const { return "ROCEvaluation"; };

    virtual float64_t evaluate(CLabels* predicted, CLabels* ground_truth);

    virtual EEvaluationDirection get_evaluation_direction() const
    {
        return ED_MAXIMIZE;
    }

    float64_t get_auROC();

    SGMatrix<float64_t> get_ROC();

    SGVector<float64_t> get_thresholds();

protected:

    float64_t evaluate_roc(CLabels* predicted, CLabels* ground_truth);

protected:

    SGMatrix<float64_t> m_ROC_graph;

    SGVector<float64_t> m_thresholds;

    float64_t m_auROC;

    bool m_computed;
};

}

#endif /* ROCEVALUATION_H_ */