SHOGUN  v1.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members | Public Member Functions
CSubset Class Reference

Detailed Description

class for adding subset support to a class. Provides an interface for getting/setting subset_matrices and index conversion. Do not inherit from this class, use it as variable. Write wrappers for all get/set functions.

Definition at line 24 of file Subset.h.

Inheritance diagram for CSubset:
Inheritance graph
[legend]

Public Member Functions

 CSubset ()
 CSubset (SGVector< index_t > subset_idx)
virtual ~CSubset ()
const char * get_name () const
const index_t get_size () const
CSubsetduplicate ()
index_t subset_idx_conversion (index_t idx) const
- Public Member Functions inherited from CSGObject
 CSGObject ()
 CSGObject (const CSGObject &orig)
virtual ~CSGObject ()
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="")
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
void set_global_io (SGIO *io)
SGIOget_global_io ()
void set_global_parallel (Parallel *parallel)
Parallelget_global_parallel ()
void set_global_version (Version *version)
Versionget_global_version ()
SGVector< char * > get_modelsel_names ()
char * get_modsel_param_descr (const char *param_name)
index_t get_modsel_param_index (const char *param_name)

Additional Inherited Members

- Public Attributes inherited from CSGObject
SGIOio
Parallelparallel
Versionversion
Parameterm_parameters
Parameterm_model_selection_parameters
- Protected Member Functions inherited from CSGObject
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)

Constructor & Destructor Documentation

CSubset ( )

default constructor, do not use

Definition at line 17 of file Subset.cpp.

CSubset ( SGVector< index_t subset_idx)

constructor

Parameters
subset_idxvector of subset indices, is deleted in destructor

Definition at line 22 of file Subset.cpp.

~CSubset ( )
virtual

destructor

Definition at line 27 of file Subset.cpp.

Member Function Documentation

CSubset * duplicate ( )
Returns
a copy of this instance with a copy of the index vector

Definition at line 31 of file Subset.cpp.

const char* get_name ( ) const
virtual
Returns
name of the SGSerializable

Implements CSGObject.

Definition at line 40 of file Subset.h.

const index_t get_size ( ) const

get size of subset

Returns
size of subset

Definition at line 45 of file Subset.h.

index_t subset_idx_conversion ( index_t  idx) const

returns the corresponding real index (in array) of a subset index (if there is a subset)

@ return array index of the provided subset index

Definition at line 55 of file Subset.h.


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

SHOGUN Machine Learning Toolbox - Documentation