MultilabelSOLabels.h

Go to the documentation of this file.

/*
 * This software is distributed under BSD 3-clause license (see LICENSE file).
 *
 * Written (W) 2013 Thoralf Klein
 * Written (W) 2014 Abinash Panda
 * Copyright (C) 2013 Thoralf Klein and Zuse-Institute-Berlin (ZIB)
 * Copyright (C) 2014 Abinash Panda
 */

#ifndef _MULTILABEL_SO_LABELS__H__
#define _MULTILABEL_SO_LABELS__H__

#include <shogun/lib/config.h>

#include <shogun/labels/StructuredLabels.h>
#include <shogun/lib/SGVector.h>
#include <shogun/lib/StructuredData.h>
#include <shogun/lib/StructuredDataTypes.h>
#include <shogun/labels/MultilabelLabels.h>

namespace shogun
{

class CMultilabelSOLabels;

class CSparseMultilabel : public CStructuredData
{
public:
    STRUCTURED_DATA_TYPE(SDT_SPARSE_MULTILABEL);

    CSparseMultilabel() { }

    CSparseMultilabel(SGVector<int32_t> label) : CStructuredData(), m_label(label) { }

    ~CSparseMultilabel() { }

    static CSparseMultilabel * obtain_from_generic(CStructuredData * base_data)
    {
        if (base_data->get_structured_data_type() == SDT_SPARSE_MULTILABEL)
        {
            return (CSparseMultilabel *) base_data;
        }
        else
        {
            SG_SERROR("base_data must be of dynamic type CSparseMultilabel\n");
        }

        return NULL;
    }

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

    SGVector<int32_t> get_data() const
    {
        return m_label;
    }

protected:
    SGVector<int32_t> m_label;
}; /* class CSparseMultilabel */

class CMultilabelSOLabels : public CStructuredLabels
{
public:
    CMultilabelSOLabels();

    CMultilabelSOLabels(int32_t num_classes);

    CMultilabelSOLabels(int32_t num_labels, int32_t num_classes);

    CMultilabelSOLabels(CMultilabelLabels * multilabel_labels);

    ~CMultilabelSOLabels();

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

    virtual int32_t get_num_labels() const;

    virtual int32_t get_num_classes() const;

    virtual CMultilabelLabels * get_multilabel_labels();

    virtual void set_sparse_labels(SGVector<int32_t> * labels);

    virtual void set_sparse_label(int32_t j, SGVector<int32_t> label);

    virtual bool set_label(int32_t j, CStructuredData * label);

    virtual void add_label(CStructuredData * label);

    virtual SGVector<int32_t> get_sparse_label(int32_t j);

    virtual CStructuredData * get_label(int32_t j);

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

    static SGVector<float64_t> to_dense(CStructuredData * label,
                                        int32_t dense_dim, float64_t d_true, float64_t d_false);

private:
    CMultilabelLabels * m_multilabel_labels;
    int32_t m_last_set_label;

private:
    void init();

}; /* class CMultilabelSOLabels */

} /* namespace shogun */

#endif /* _MULTILABEL_SO_LABELS__H__ */