CLabels Class Reference

Inheritance diagram for CLabels:

Inheritance graph
[legend]

List of all members.


Detailed Description

class Labels

Definition at line 20 of file Labels.h.


Public Member Functions

 CLabels ()
 CLabels (INT num_labels)
 CLabels (DREAL *labels, INT len)
 CLabels (CHAR *fname)
 ~CLabels ()
bool load (CHAR *fname)
bool save (CHAR *fname)
bool set_label (INT idx, DREAL label)
bool set_int_label (INT idx, INT label)
DREAL get_label (INT idx)
INT get_int_label (INT idx)
bool is_two_class_labeling ()
INT get_num_classes ()
DREALget_labels (INT &len)
void get_labels (DREAL **labels, INT *len)
void set_labels (DREAL *labels, INT len)
INTget_int_labels (INT &len)
void set_int_labels (INT *labels, INT len)
INT get_num_labels ()

Static Public Attributes

static CParallel parallel
static CIO io
static CVersion version

Protected Attributes

INT num_labels
DREALlabels

Constructor & Destructor Documentation

CLabels::CLabels (  ) 

default constructor

Definition at line 18 of file Labels.cpp.

CLabels::CLabels ( INT  num_labels  ) 

constructor

Parameters:
num_labels number of labels

Definition at line 25 of file Labels.cpp.

CLabels::CLabels ( DREAL labels,
INT  len 
)

constructor

Parameters:
labels labels to set
len number of labels

Definition at line 33 of file Labels.cpp.

CLabels::CLabels ( CHAR fname  ) 

constructor

Parameters:
fname filename to load labels from

Definition at line 42 of file Labels.cpp.

CLabels::~CLabels (  ) 

Definition at line 51 of file Labels.cpp.


Member Function Documentation

bool CLabels::load ( CHAR fname  ) 

load labels from file

Parameters:
fname filename to load from
Returns:
if loading was successful

Definition at line 154 of file Labels.cpp.

bool CLabels::save ( CHAR fname  ) 

save labels to file

Parameters:
fname filename to save to
Returns:
if saving was successful

Definition at line 178 of file Labels.cpp.

bool CLabels::set_label ( INT  idx,
DREAL  label 
)

set label

Parameters:
idx index of label to set
label value of label
Returns:
if setting was successful

Definition at line 66 of file Labels.h.

bool CLabels::set_int_label ( INT  idx,
INT  label 
)

set INT label

Parameters:
idx index of label to set
label INT value of label
Returns:
if setting was successful

Definition at line 83 of file Labels.h.

DREAL CLabels::get_label ( INT  idx  ) 

get label

Parameters:
idx index of label to get
Returns:
value of label

Definition at line 99 of file Labels.h.

INT CLabels::get_int_label ( INT  idx  ) 

get INT label

Parameters:
idx index of label to get
Returns:
INT value of label

Definition at line 112 of file Labels.h.

bool CLabels::is_two_class_labeling (  ) 

is two-class labeling

Returns:
if this is two-class labeling

Definition at line 70 of file Labels.cpp.

INT CLabels::get_num_classes (  ) 

return number of classes (for multiclass) labels have to be zero based 0,1,...C missing labels are illegal

Returns:
number of classes

Definition at line 85 of file Labels.cpp.

DREAL * CLabels::get_labels ( INT len  ) 

get labels caller has to clean up

Parameters:
len number of labels
Returns:
the labels

Definition at line 99 of file Labels.cpp.

void CLabels::get_labels ( DREAL **  labels,
INT len 
)

get labels (swig compatible)

Parameters:
labels where labels will be stored in
len where number of labels will be stored in

Definition at line 114 of file Labels.cpp.

void CLabels::set_labels ( DREAL labels,
INT  len 
)

set labels

Parameters:
labels labels to set
len number of labels

Definition at line 58 of file Labels.cpp.

INT * CLabels::get_int_labels ( INT len  ) 

get INT label vector caller has to clean up

Parameters:
len number of labels to get
Returns:
INT labels

Definition at line 129 of file Labels.cpp.

void CLabels::set_int_labels ( INT labels,
INT  len 
)

set INT labels caller has to clean up

Parameters:
labels INT labels
len number of INT labels

Definition at line 144 of file Labels.cpp.

INT CLabels::get_num_labels (  ) 

get number of labels

Returns:
number of labels

Definition at line 179 of file Labels.h.


Member Data Documentation

INT CLabels::num_labels [protected]

number of labels

Definition at line 182 of file Labels.h.

DREAL* CLabels::labels [protected]

the labels

Definition at line 184 of file Labels.h.

CParallel CSGObject::parallel [static, inherited]

Definition at line 105 of file SGObject.h.

CIO CSGObject::io [static, inherited]

Definition at line 106 of file SGObject.h.

CVersion CSGObject::version [static, inherited]

Definition at line 107 of file SGObject.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation