StructuredLabels.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) 2012 Fernando José Iglesias García
 * Copyright (C) 2012 Fernando José Iglesias García
 */

#ifndef _STRUCTURED_LABELS__H__
#define _STRUCTURED_LABELS__H__

#include <shogun/labels/Labels.h>
#include <shogun/labels/LabelTypes.h>
#include <shogun/lib/DynamicObjectArray.h>
#include <shogun/lib/StructuredData.h>
#include <shogun/lib/StructuredDataTypes.h>

namespace shogun {

class CStructuredLabels : public CLabels
{

    public:
        CStructuredLabels();

        CStructuredLabels(int32_t num_labels);

        virtual ~CStructuredLabels();

        static CStructuredLabels* obtain_from_generic(CLabels* base_labels);

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

        void add_label(CStructuredData* label);

        CDynamicObjectArray* get_labels() const;
        
        CStructuredData* get_label(int32_t idx);

        bool set_label(int32_t idx, CStructuredData* label);

        virtual int32_t get_num_labels();

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

        virtual ELabelType get_label_type() { return LT_STRUCTURED; }

        inline EStructuredDataType get_structured_data_type() { return m_sdt; }

    private:
        void init();

        void ensure_valid_sdt(CStructuredData* label);

    protected:
        CDynamicObjectArray* m_labels;

        EStructuredDataType m_sdt;

}; /* class CStructuredLabels */

} /* namespace shogun */

#endif /* _STRUCTUREDLABELS_H__ */