MultilabelLabels.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013 Zuse-Institute-Berlin (ZIB)
 * Copyright (C) 2013-2014 Thoralf Klein
 * Written (W) 2013-2014 Thoralf Klein
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the Shogun Development Team.
 */

#ifndef _MULTILABEL_LABELS__H__
#define _MULTILABEL_LABELS__H__

#include <shogun/lib/config.h>

#include <shogun/lib/common.h>
#include <shogun/labels/LabelTypes.h>
#include <shogun/labels/Labels.h>
#include <shogun/lib/SGVector.h>
#include <shogun/lib/SGMatrix.h>

namespace shogun
{

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

    CMultilabelLabels(int32_t num_classes);

    CMultilabelLabels(int32_t num_labels, int32_t num_classes);

    ~CMultilabelLabels();

    void ensure_valid(const char * context = NULL);

    virtual ELabelType get_label_type() const
    {
        return LT_SPARSE_MULTILABEL;
    }

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

    virtual int32_t get_num_labels() const;

    virtual int32_t  get_num_classes() const;

    void set_labels(SGVector<int32_t> * labels);

    SGVector<int32_t> ** get_class_labels() const;

    SGMatrix<int32_t> get_labels() const;

    SGVector<int32_t> get_label(int32_t j);

    template <class S, class D>
    static SGVector<D> to_dense(SGVector<S> * sparse, int32_t dense_len, D d_true, D d_false);

    void set_label(int32_t j, SGVector<int32_t> label);

    void set_class_labels(SGVector <int32_t> ** labels_list);

    void display() const;

private:
    void init(int32_t num_labels, int32_t num_classes);

protected:
    int32_t m_num_labels;

    int32_t m_num_classes;

    SGVector<int32_t>* m_labels;
};

}

#endif