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
 * Written (W) 2011-2012 Heiko Strathmann
 * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _LABELS__H__
#define _LABELS__H__

#include <shogun/lib/config.h>

#include <shogun/lib/common.h>
#include <shogun/base/SGObject.h>
#include <shogun/labels/LabelsFactory.h>
#include <shogun/labels/LabelTypes.h>
#include <shogun/features/SubsetStack.h>
#include <shogun/lib/SGVector.h>

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

    virtual ~CLabels();

    virtual void ensure_valid(const char * context = NULL) = 0;

    virtual int32_t get_num_labels() const = 0;

    virtual ELabelType get_label_type() const = 0;

    virtual void add_subset(SGVector<index_t> subset);

    virtual void add_subset_in_place(SGVector<index_t> subset);

    virtual void remove_subset();

    virtual void remove_all_subsets();

    virtual void set_value(float64_t value, int32_t idx);

    virtual float64_t get_value(int32_t idx);

    virtual void set_values(SGVector<float64_t> values);

    virtual SGVector<float64_t> get_values();

#ifndef SWIG // SWIG should skip this part
    virtual CLabels* shallow_subset_copy()
    {
        SG_SNOTIMPLEMENTED;
        return NULL;
    }
#endif

private:
    void init();

protected:

    CSubsetStack * m_subset_stack;

    SGVector<float64_t> m_current_values;
};
}
#endif