CrossValidationOutput.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 Sergey Lisitsyn
 * Written (W) 2012 Heiko Strathmann
 *
 */

#ifndef __CROSSVALIDATIONOUTPUT_H_
#define __CROSSVALIDATIONOUTPUT_H_

#include <shogun/base/SGObject.h>
#include <shogun/lib/SGVector.h>

namespace shogun
{

class CMachine;
class CLabels;
class CEvaluation;

class CCrossValidationOutput: public CSGObject
{
public:

    CCrossValidationOutput() : CSGObject()
    {
        m_current_run_index=0;
        m_current_fold_index=0;
        m_num_runs=0;
        m_num_folds=0;
    }

    virtual ~CCrossValidationOutput() {}

    virtual const char* get_name() const=0;

    virtual void init_num_runs(index_t num_runs, const char* prefix="")
    {
        m_num_runs=num_runs;
    }

    virtual void init_num_folds(index_t num_folds, const char* prefix="")
    {
        m_num_folds=num_folds;
    }

    virtual void init_expose_labels(CLabels* labels) { }

    virtual void post_init() { }

    virtual void update_run_index(index_t run_index,
            const char* prefix="")
    {
        m_current_run_index=run_index;
    }

    virtual void update_fold_index(index_t fold_index,
            const char* prefix="")
    {
        m_current_fold_index=fold_index;
    }

    virtual void update_train_indices(SGVector<index_t> indices,
            const char* prefix="") {}

    virtual void update_test_indices(SGVector<index_t> indices,
            const char* prefix="") {}

    virtual void update_trained_machine(CMachine* machine,
            const char* prefix="") {}

    virtual void update_test_result(CLabels* results,
            const char* prefix="") {}

    virtual void update_test_true_result(CLabels* results,
            const char* prefix="") {}

    virtual void post_update_results() {}

    virtual void update_evaluation_result(float64_t result,
            const char* prefix="") {}

protected:
    index_t m_current_run_index;

    index_t m_current_fold_index;

    index_t m_num_runs;

    index_t m_num_folds;
};

}

#endif /* __CROSSVALIDATIONOUTPUT_H_ */