KNN.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) 2006 Christian Gehl
 * Written (W) 1999-2009 Soeren Sonnenburg
 * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _KNN_H__
#define _KNN_H__

#include <stdio.h>
#include "lib/common.h"
#include "lib/io.h"
#include "features/Features.h"
#include "distance/Distance.h"
#include "classifier/DistanceMachine.h"

namespace shogun
{
class CDistanceMachine;

class CKNN : public CDistanceMachine
{
    public:
        CKNN();

        CKNN(int32_t k, CDistance* d, CLabels* trainlab);
        virtual ~CKNN();

        virtual inline EClassifierType get_classifier_type() { return CT_KNN; }
        //inline EDistanceType get_distance_type() { return DT_KNN;}

        virtual bool train(CFeatures* data=NULL);

        virtual CLabels* classify();

        virtual CLabels* classify(CFeatures* data);

        virtual float64_t classify_example(int32_t vec_idx)
        {
            SG_ERROR( "for performance reasons use classify() instead of classify_example\n");
            return 0;
        }

        void classify_for_multiple_k(int32_t** output, int32_t* num_vec, int32_t* k_out);

        virtual bool load(FILE* srcfile);

        virtual bool save(FILE* dstfile);

        inline void set_k(int32_t p_k)
        {
            ASSERT(p_k>0);
            this->k=p_k;
        }

        inline int32_t get_k()
        {
            return k;
        }

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

    protected:
        int32_t k;

        int32_t num_classes;

        int32_t min_label;

        int32_t num_train_labels;

        int32_t* train_labels;
};
}
#endif