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

#ifndef _DENSE_LABELS__H__
#define _DENSE_LABELS__H__

#include <shogun/lib/config.h>

#include <shogun/lib/common.h>
#include <shogun/io/File.h>
#include <shogun/labels/Labels.h>
#include <shogun/features/SubsetStack.h>

namespace shogun
{
    class CFile;

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

        CDenseLabels(int32_t num_labels);

        CDenseLabels(CFile* loader);

        virtual ~CDenseLabels();

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

        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);

        SGVector<float64_t> get_labels();

        float64_t get_label(int32_t idx);

        template<typename ST>
        ST get_label_t(int32_t idx)
        {
            REQUIRE(idx<get_num_labels(), "The provided index (%d) is out of bounds (the last label has index (%d)).  "
                "Please ensure that you're using a valid index number.", idx, get_num_labels())
            REQUIRE(m_labels.vector, "You're attempting to get a label when there are in fact none!  "
                "Please ensure that you initialized the labels correctly.")
            int32_t real_num=m_subset_stack->subset_idx_conversion(idx);
            return m_labels.vector[real_num];
        }

        int32_t get_int_label(int32_t idx);

        SGVector<float64_t> get_labels_copy();

        template<typename ST>
        SGVector<ST> get_labels_t()
        {
            if (m_subset_stack->has_subsets())
                return get_labels_copy_t<ST>();

            SGVector<ST> labels_copy(m_labels.vlen);
            for(index_t i = 0; i < m_labels.vlen; ++i)
                labels_copy[i] = (ST) m_labels[i];

            return labels_copy;
        }

        template<typename ST>
        SGVector<ST> get_labels_copy_t()
        {
            if (!m_subset_stack->has_subsets())
            {
                SGVector<ST> labels_copy(m_labels.vlen);
                for(index_t i = 0; i < m_labels.vlen; ++i)
                    labels_copy[i] = (ST) m_labels[i];

                return labels_copy;
            }

            index_t num_labels = get_num_labels();
            SGVector<ST> result(num_labels);

            /* copy element wise because of possible subset */
            for (index_t i=0; i<num_labels; i++)
                result[i] = get_label_t<ST>(i);

            return result;
        }

        void set_labels(SGVector<float64_t> v);

        void set_to_one();

        void zero();

        void set_to_const(float64_t c);

        SGVector<int32_t> get_int_labels();

        void set_int_labels(SGVector<int32_t> labels);

#if !defined(SWIGJAVA) && !defined(SWIGCSHARP)

        void set_int_labels(SGVector<int64_t> labels);
#endif

        virtual int32_t get_num_labels() const;

        virtual ELabelType get_label_type() const=0;

    public:
        static const int32_t REJECTION_LABEL = -2;

    private:
        void init();

    protected:
        SGVector<float64_t> m_labels;
};

    template<> inline
    SGVector<float64_t> CDenseLabels::get_labels_t<float64_t>()
    {
        if (m_subset_stack->has_subsets())
            return get_labels_copy_t<float64_t>();

        return m_labels;
    }
}
#endif