Real Labels are real-valued labels.
They are used for regression problems and as outputs of classifiers.
valid values for labels are all real-valued numbers.
Definition at line 34 of file RegressionLabels.h.
Public Member Functions | |
CRegressionLabels () | |
CRegressionLabels (int32_t num_labels) | |
CRegressionLabels (const SGVector< float64_t > src) | |
CRegressionLabels (CFile *loader) | |
virtual ELabelType | get_label_type () |
virtual const char * | get_name () const |
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) |
float64_t | get_label (int32_t idx) |
int32_t | get_int_label (int32_t idx) |
SGVector< float64_t > | get_labels () |
SGVector< float64_t > | get_labels_copy () |
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) |
virtual int32_t | get_num_labels () |
virtual void | add_subset (SGVector< index_t > subset) |
virtual void | remove_subset () |
virtual void | remove_all_subsets () |
virtual void | set_value (float64_t value, int32_t idx) |
virtual float64_t | get_value (int32_t idx) |
virtual void | set_values (SGVector< float64_t > values) |
virtual SGVector< float64_t > | get_values () |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_copy () const |
virtual bool | is_generic (EPrimitiveType *generic) const |
template<class T > | |
void | set_generic () |
void | unset_generic () |
virtual void | print_serializable (const char *prefix="") |
virtual bool | save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=VERSION_PARAMETER) |
DynArray< TParameter * > * | load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="") |
DynArray< TParameter * > * | load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="") |
void | map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos) |
void | set_global_io (SGIO *io) |
SGIO * | get_global_io () |
void | set_global_parallel (Parallel *parallel) |
Parallel * | get_global_parallel () |
void | set_global_version (Version *version) |
Version * | get_global_version () |
SGStringList< char > | get_modelsel_names () |
void | print_modsel_params () |
char * | get_modsel_param_descr (const char *param_name) |
index_t | get_modsel_param_index (const char *param_name) |
void | build_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict) |
Static Public Member Functions | |
static CRegressionLabels * | obtain_from_generic (CLabels *base_labels) |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Static Public Attributes | |
static const int32_t | REJECTION_LABEL = -2 |
Protected Member Functions | |
virtual TParameter * | migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target) |
virtual void | one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL) |
virtual void | load_serializable_pre () throw (ShogunException) |
virtual void | load_serializable_post () throw (ShogunException) |
virtual void | save_serializable_pre () throw (ShogunException) |
virtual void | save_serializable_post () throw (ShogunException) |
virtual bool | update_parameter_hash () |
Protected Attributes | |
SGVector< float64_t > | m_labels |
CSubsetStack * | m_subset_stack |
SGVector< float64_t > | m_current_values |
default constructor
Definition at line 6 of file RegressionLabels.cpp.
CRegressionLabels | ( | int32_t | num_labels | ) |
constructor
num_labels | number of labels |
Definition at line 10 of file RegressionLabels.cpp.
CRegressionLabels | ( | const SGVector< float64_t > | src | ) |
CRegressionLabels | ( | CFile * | loader | ) |
constructor
loader | File object via which to load data |
Definition at line 19 of file RegressionLabels.cpp.
adds a subset of indices on top of the current subsets (possibly subset of subset. Calls subset_changed_post() afterwards
subset | subset of indices to add |
Definition at line 40 of file Labels.cpp.
void build_parameter_dictionary | ( | CMap< TParameter *, CSGObject * > & | dict | ) | [inherited] |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
dict | dictionary of parameters to be built. |
Definition at line 1201 of file SGObject.cpp.
virtual CSGObject* deep_copy | ( | ) | const [virtual, inherited] |
A deep copy. All the instance variables will also be copied.
Definition at line 131 of file SGObject.h.
void ensure_valid | ( | const char * | context = NULL |
) | [virtual, inherited] |
Make sure the label is valid, otherwise raise SG_ERROR.
possible with subset
context | optional message to convey the context |
Implements CLabels.
Reimplemented in CBinaryLabels, and CMulticlassLabels.
Definition at line 122 of file DenseLabels.cpp.
SGIO * get_global_io | ( | ) | [inherited] |
Parallel * get_global_parallel | ( | ) | [inherited] |
Version * get_global_version | ( | ) | [inherited] |
int32_t get_int_label | ( | int32_t | idx | ) | [inherited] |
get INT label
possible with subset
idx | index of label to get |
Definition at line 182 of file DenseLabels.cpp.
SGVector< int32_t > get_int_labels | ( | ) | [inherited] |
get INT label vector
possible with subset
Definition at line 101 of file DenseLabels.cpp.
float64_t get_label | ( | int32_t | idx | ) | [inherited] |
get label
possible with subset
idx | index of label to get |
Definition at line 175 of file DenseLabels.cpp.
ELabelType get_label_type | ( | ) | [virtual] |
get label type
Implements CDenseLabels.
Definition at line 33 of file RegressionLabels.cpp.
get copy of labels.
possible with subset
Definition at line 86 of file DenseLabels.cpp.
SGStringList< char > get_modelsel_names | ( | ) | [inherited] |
Definition at line 1108 of file SGObject.cpp.
char * get_modsel_param_descr | ( | const char * | param_name | ) | [inherited] |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1132 of file SGObject.cpp.
index_t get_modsel_param_index | ( | const char * | param_name | ) | [inherited] |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1145 of file SGObject.cpp.
virtual const char* get_name | ( | ) | const [virtual] |
int32_t get_num_labels | ( | ) | [virtual, inherited] |
get number of labels, depending on whether a subset is set
Implements CLabels.
Definition at line 192 of file DenseLabels.cpp.
float64_t get_value | ( | int32_t | idx | ) | [virtual, inherited] |
get confidence value for a particular label
idx | label index |
Definition at line 55 of file Labels.cpp.
bool is_generic | ( | EPrimitiveType * | generic | ) | const [virtual, inherited] |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 278 of file SGObject.cpp.
void load | ( | CFile * | loader | ) | [virtual, inherited] |
load labels from file
any subset is removed before
loader | File object via which to load data |
Definition at line 128 of file DenseLabels.cpp.
DynArray< TParameter * > * load_all_file_parameters | ( | int32_t | file_version, | |
int32_t | current_version, | |||
CSerializableFile * | file, | |||
const char * | prefix = "" | |||
) | [inherited] |
maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)
file_version | parameter version of the file | |
current_version | version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases) | |
file | file to load from | |
prefix | prefix for members |
Definition at line 679 of file SGObject.cpp.
DynArray< TParameter * > * load_file_parameters | ( | const SGParamInfo * | param_info, | |
int32_t | file_version, | |||
CSerializableFile * | file, | |||
const char * | prefix = "" | |||
) | [inherited] |
loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned
param_info | information of parameter | |
file_version | parameter version of the file, must be <= provided parameter version | |
file | file to load from | |
prefix | prefix for members |
Definition at line 523 of file SGObject.cpp.
bool load_serializable | ( | CSerializableFile * | file, | |
const char * | prefix = "" , |
|||
int32_t | param_version = VERSION_PARAMETER | |||
) | [virtual, inherited] |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from | |
prefix | prefix for members | |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 354 of file SGObject.cpp.
void load_serializable_post | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CLinearHMM, CAlphabet, CANOVAKernel, CCircularKernel, CExponentialKernel, CGaussianKernel, CInverseMultiQuadricKernel, CKernel, CWeightedDegreePositionStringKernel, and CList.
Definition at line 1033 of file SGObject.cpp.
void load_serializable_pre | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Definition at line 1028 of file SGObject.cpp.
void map_parameters | ( | DynArray< TParameter * > * | param_base, | |
int32_t & | base_version, | |||
DynArray< const SGParamInfo * > * | target_param_infos | |||
) | [inherited] |
Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match
param_base | set of TParameter instances that are mapped to the provided target parameter infos | |
base_version | version of the parameter base | |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 717 of file SGObject.cpp.
TParameter * migrate | ( | DynArray< TParameter * > * | param_base, | |
const SGParamInfo * | target | |||
) | [protected, virtual, inherited] |
creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.
If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass
param_base | set of TParameter instances to use for migration | |
target | parameter info for the resulting TParameter |
Definition at line 923 of file SGObject.cpp.
CRegressionLabels * obtain_from_generic | ( | CLabels * | base_labels | ) | [static] |
helper method used to specialize a base class instance
base_labels | its dynamic type must be CRegressionLabels |
Definition at line 23 of file RegressionLabels.cpp.
void one_to_one_migration_prepare | ( | DynArray< TParameter * > * | param_base, | |
const SGParamInfo * | target, | |||
TParameter *& | replacement, | |||
TParameter *& | to_migrate, | |||
char * | old_name = NULL | |||
) | [protected, virtual, inherited] |
This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)
param_base | set of TParameter instances to use for migration | |
target | parameter info for the resulting TParameter | |
replacement | (used as output) here the TParameter instance which is returned by migration is created into | |
to_migrate | the only source that is used for migration | |
old_name | with this parameter, a name change may be specified |
Definition at line 864 of file SGObject.cpp.
void print_modsel_params | ( | ) | [inherited] |
prints all parameter registered for model selection and their type
Definition at line 1084 of file SGObject.cpp.
void print_serializable | ( | const char * | prefix = "" |
) | [virtual, inherited] |
prints registered parameters out
prefix | prefix for members |
Definition at line 290 of file SGObject.cpp.
void remove_all_subsets | ( | ) | [virtual, inherited] |
removes all subsets Calls subset_changed_post() afterwards
Definition at line 50 of file Labels.cpp.
void remove_subset | ( | ) | [virtual, inherited] |
removes that last added subset from subset stack, if existing Calls subset_changed_post() afterwards
Definition at line 45 of file Labels.cpp.
void save | ( | CFile * | writer | ) | [virtual, inherited] |
save labels to file
not possible with subset
writer | File object via which to save data |
Definition at line 139 of file DenseLabels.cpp.
bool save_serializable | ( | CSerializableFile * | file, | |
const char * | prefix = "" , |
|||
int32_t | param_version = VERSION_PARAMETER | |||
) | [virtual, inherited] |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. | |
prefix | prefix for members | |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Reimplemented in CModelSelectionParameters.
Definition at line 296 of file SGObject.cpp.
void save_serializable_post | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1043 of file SGObject.cpp.
void save_serializable_pre | ( | ) | throw (ShogunException) [protected, virtual, inherited] |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1038 of file SGObject.cpp.
void set_generic< floatmax_t > | ( | ) | [inherited] |
set generic type to T
void set_global_io | ( | SGIO * | io | ) | [inherited] |
void set_global_parallel | ( | Parallel * | parallel | ) | [inherited] |
set the parallel object
parallel | parallel object to use |
Definition at line 230 of file SGObject.cpp.
void set_global_version | ( | Version * | version | ) | [inherited] |
set the version object
version | version object to use |
Definition at line 265 of file SGObject.cpp.
bool set_int_label | ( | int32_t | idx, | |
int32_t | label | |||
) | [inherited] |
set INT label
possible with subset
idx | index of label to set | |
label | INT value of label |
Definition at line 163 of file DenseLabels.cpp.
void set_int_labels | ( | SGVector< int32_t > | labels | ) | [inherited] |
set INT labels
not possible on subset
labels | INT labels |
Definition at line 111 of file DenseLabels.cpp.
bool set_label | ( | int32_t | idx, | |
float64_t | label | |||
) | [inherited] |
set label
possible with subset
idx | index of label to set | |
label | value of label |
Definition at line 151 of file DenseLabels.cpp.
set labels
not possible with subset
v | labels |
Definition at line 70 of file DenseLabels.cpp.
void set_to_const | ( | float64_t | c | ) | [inherited] |
set all labels to a const value
possible with subset
c | const to set labels to |
Definition at line 62 of file DenseLabels.cpp.
void set_to_one | ( | ) | [inherited] |
void set_value | ( | float64_t | value, | |
int32_t | idx | |||
) | [virtual, inherited] |
set the confidence value for a particular label
value | value to set | |
idx | label index whose conf. value is to be changed |
Definition at line 62 of file Labels.cpp.
set confidence vector
values | to be set (should have zero length to disable values or length must match the number of labels) |
Definition at line 69 of file Labels.cpp.
virtual CSGObject* shallow_copy | ( | ) | const [virtual, inherited] |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 122 of file SGObject.h.
void unset_generic | ( | ) | [inherited] |
unset generic type
this has to be called in classes specializing a template class
Definition at line 285 of file SGObject.cpp.
bool update_parameter_hash | ( | ) | [protected, virtual, inherited] |
Updates the hash of current parameter combination.
Definition at line 237 of file SGObject.cpp.
void zero | ( | ) | [inherited] |
io
Definition at line 462 of file SGObject.h.
SGVector<float64_t> m_current_values [protected, inherited] |
uint32_t m_hash [inherited] |
Hash of parameter values
Definition at line 480 of file SGObject.h.
the label vector
Definition at line 200 of file DenseLabels.h.
Parameter* m_model_selection_parameters [inherited] |
model selection parameters
Definition at line 474 of file SGObject.h.
ParameterMap* m_parameter_map [inherited] |
map for different parameter versions
Definition at line 477 of file SGObject.h.
Parameter* m_parameters [inherited] |
parameters
Definition at line 471 of file SGObject.h.
CSubsetStack* m_subset_stack [protected, inherited] |
parallel
Definition at line 465 of file SGObject.h.
const int32_t REJECTION_LABEL = -2 [static, inherited] |
label designates classify reject
Definition at line 193 of file DenseLabels.h.
version
Definition at line 468 of file SGObject.h.