ClusteringMutualInformation.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) 2012 Chiyuan Zhang
 * Copyright (C) 2012 Chiyuan Zhang
 */

#ifndef __CLUSTERINGMUTUALINFORMATION_H__
#define __CLUSTERINGMUTUALINFORMATION_H__

#include <shogun/lib/config.h>

#include <shogun/evaluation/ClusteringEvaluation.h>

namespace shogun
{

class CClusteringMutualInformation: public CClusteringEvaluation
{
public:
    CClusteringMutualInformation(): CClusteringEvaluation() {}

    virtual ~CClusteringMutualInformation() {}

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

    virtual EEvaluationDirection get_evaluation_direction() const
    {
        return ED_MINIMIZE;
    }

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

}

#endif /* end of include guard: __CLUSTERINGMUTUALINFORMATION_H__ */