-
-
Notifications
You must be signed in to change notification settings - Fork 1k
/
MultilabelLabels.h
162 lines (137 loc) · 4.59 KB
/
MultilabelLabels.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
* 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/common.h>
#include <shogun/labels/LabelTypes.h>
#include <shogun/labels/Labels.h>
#include <shogun/lib/SGVector.h>
namespace shogun
{
/** @brief Multilabel Labels for multi-label classification
*
* Labels are subsets of {0, ..., num_classes-1}
*/
class CMultilabelLabels : public CLabels
{
public:
/** default constructor */
CMultilabelLabels();
/** constructor
*
* @param num_classes number of (binary) class assignments per label
*/
CMultilabelLabels(int32_t num_classes);
/** constructor
*
* @param num_labels number of labels
* @param num_classes number of (binary) class assignments per label
*/
CMultilabelLabels(int32_t num_labels, int32_t num_classes);
/** destructor */
~CMultilabelLabels();
/** Make sure the label is valid, otherwise raise SG_ERROR.
*
* possible with subset
*
* @param context optional message to convey the context
*/
void ensure_valid(const char * context = NULL);
/** get label type
*
* @return label type multiclass
*/
virtual ELabelType get_label_type() const
{
return LT_SPARSE_MULTILABEL;
}
/** @return object name */
virtual const char * get_name() const
{
return "MultilabelLabels";
}
/** get the number of stored labels
*
* @return the number of labels
*/
virtual int32_t get_num_labels() const;
/** return number of classes (per label)
*
* @return number of classes
*/
virtual int32_t get_num_classes() const;
/** set labels
*
* @param labels list of sparse labels
*/
void set_labels(SGVector<int32_t> * labels);
/** get list of sparse class labels (one vector per class)
*
* @return SGVector<int32_t> **
*/
SGVector<int32_t> ** get_class_labels() const;
/** get sparse assignment for j-th label
*
* @return SGVector<int32_t > sparse label
*/
SGVector<int32_t> get_label(int32_t j);
/** Convert sparse label vector to dense. The dense vector
* will be {d_true; d_false}^dense_dim. Indices in sparse
* will be marked "d_true", everything else "d_false".
*
* @param SGVector<S> * sparse vector to convert
* @param int32_t dense dimension
* @param D marker for "true" labels
* @param D marker for "false" labels
*
* @return SGVector<D> dense vector of dimension dense_len
*/
template <class S, class D>
static SGVector<D> to_dense(SGVector<S> * sparse, int32_t dense_len, D d_true, D d_false);
/** set sparse assignment for j-th label
*
* @param int32_t label index
* @param SGVector<int32_t > sparse label
*/
void set_label(int32_t j, SGVector<int32_t> label);
/** assigning class labels */
void set_class_labels(SGVector <int32_t> ** labels_list);
/** print the current labeling */
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