Labels.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) 1999-2009 Soeren Sonnenburg
 * Written (W) 1999-2008 Gunnar Raetsch
 * Subset support written (W) 2011 Heiko Strathmann
 * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _LABELS__H__
#define _LABELS__H__

#include <shogun/lib/common.h>
#include <shogun/io/File.h>
#include <shogun/base/SGObject.h>
#include <shogun/features/Subset.h>

namespace shogun
{
    class CFile;

class CLabels : public CSGObject
{
    public:
        CLabels();

        CLabels(int32_t num_labels);

        CLabels(SGVector<float64_t> src);

        CLabels(CFile* loader);

        virtual ~CLabels();

        virtual void load(CFile* loader);

        virtual void save(CFile* writer);

        bool set_label(int32_t idx, float64_t label);

        bool set_int_label(int32_t idx, int32_t label);

        float64_t get_label(int32_t idx);

        int32_t get_int_label(int32_t idx);

        bool is_two_class_labeling();

        int32_t get_num_classes();

        SGVector<float64_t> get_labels();

        void set_labels(SGVector<float64_t> v);

        void set_to_one();

        SGVector<int32_t> get_int_labels();

        SGVector<float64_t> get_classes();

        void set_int_labels(SGVector<int32_t> labels);

        int32_t get_num_labels();

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

        virtual void set_subset(CSubset* subset);

        virtual void remove_subset();

        index_t subset_idx_conversion(index_t idx) const;

    private:
        void init();

    protected:
        SGVector<float64_t> labels;

        int32_t m_num_classes;

    private:
        /* subset class to enable subset support for this class */
        CSubset* m_subset;
};
}
#endif