SHOGUN  v3.0.1
 全部  命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义  
所有成员列表 | Public 成员函数 | Public 属性 | Protected 成员函数
CList类 参考

详细描述

Class List implements a doubly connected list for low-level-objects.

For higher level objects pointers should be used. The list supports calling delete() of an object that is to be removed from the list.

在文件 List.h82 行定义.

类 CList 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CList (bool p_delete_data=false)
 
virtual ~CList ()
 
void delete_all_elements ()
 
int32_t get_num_elements ()
 
CSGObjectget_first_element ()
 
CSGObjectget_last_element ()
 
CSGObjectget_next_element ()
 
CSGObjectget_previous_element ()
 
CSGObjectget_current_element ()
 
bool append_element (CSGObject *data)
 
bool append_element_at_listend (CSGObject *data)
 
bool push (CSGObject *data)
 
bool pop ()
 
bool insert_element (CSGObject *data)
 
CSGObjectdelete_element ()
 
virtual void load_serializable_post () throw (ShogunException)
 
void print_list ()
 
bool get_delete_data ()
 
virtual const char * get_name () const
 
virtual CSGObjectshallow_copy () const
 
virtual CSGObjectdeep_copy () const
 
virtual bool is_generic (EPrimitiveType *generic) const
 
template<class T >
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
void set_generic ()
 
template<>
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::get_version_parameter())
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_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)
 
SGIOget_global_io ()
 
void set_global_parallel (Parallel *parallel)
 
Parallelget_global_parallel ()
 
void set_global_version (Version *version)
 
Versionget_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_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual bool update_parameter_hash ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0)
 
virtual CSGObjectclone ()
 
thread safe list access functions
CSGObjectget_first_element (CListElement *&p_current)
 
CSGObjectget_last_element (CListElement *&p_current)
 
CSGObjectget_next_element (CListElement *&p_current)
 
CSGObjectget_previous_element (CListElement *&p_current)
 
CSGObjectget_current_element (CListElement *&p_current)
 

Public 属性

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
ParameterMapm_parameter_map
 
uint32_t m_hash
 

Protected 成员函数

virtual TParametermigrate (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 save_serializable_pre () throw (ShogunException)
 
virtual void save_serializable_post () throw (ShogunException)
 

构造及析构函数说明

CList ( bool  p_delete_data = false)

constructor

参数
p_delete_dataif data shall be deleted

在文件 List.h89 行定义.

virtual ~CList ( )
virtual

在文件 List.h108 行定义.

成员函数说明

bool append_element ( CSGObject data)

append element AFTER the current element

参数
datadata element to append
返回
if appending was successful

在文件 List.h323 行定义.

bool append_element_at_listend ( CSGObject data)

append at end of list

参数
datadata element to append
返回
if appending was successful

在文件 List.h366 行定义.

void build_gradient_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.

参数
dictdictionary of parameters to be built.

在文件 SGObject.cpp1195 行定义.

CSGObject * clone ( )
virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

返回
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

在文件 SGObject.cpp1312 行定义.

virtual CSGObject* deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

在文件 SGObject.h159 行定义.

void delete_all_elements ( )

deletes all elements from list

在文件 List.h116 行定义.

CSGObject* delete_element ( )

erases current element the new current element is the successor of the former current element

返回
the elements data - if available - otherwise NULL

在文件 List.h475 行定义.

bool equals ( CSGObject other,
float64_t  accuracy = 0.0 
)
virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

参数
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp1216 行定义.

CSGObject* get_current_element ( )

get current element in list

返回
current element in list or NULL if not available

在文件 List.h212 行定义.

CSGObject* get_current_element ( CListElement *&  p_current)

get current element in list

参数
p_currentcurrent list element
返回
current element in list or NULL if not available

在文件 List.h305 行定义.

bool get_delete_data ( )
返回
delete_data flag which indicates if list SG_REF's stuff

在文件 List.h541 行定义.

CSGObject* get_first_element ( )

go to first element in list and return it

返回
first element in list or NULL if list is empty

在文件 List.h144 行定义.

CSGObject* get_first_element ( CListElement *&  p_current)

go to first element in list and return it

参数
p_currentcurrent list element
返回
first element in list or NULL if list is empty

在文件 List.h233 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp213 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp248 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp261 行定义.

CSGObject* get_last_element ( )

go to last element in list and return it

返回
last element in list or NULL if list is empty

在文件 List.h161 行定义.

CSGObject* get_last_element ( CListElement *&  p_current)

go to last element in list and return it

参数
p_currentcurrent list element
返回
last element in list or NULL if list is empty

在文件 List.h251 行定义.

SGStringList< char > get_modelsel_names ( )
inherited
返回
vector of names of all parameters which are registered for model selection

在文件 SGObject.cpp1099 行定义.

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

参数
param_namename of the parameter
返回
description of the parameter

在文件 SGObject.cpp1123 行定义.

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

参数
param_namename of model selection parameter
返回
index of model selection parameter with provided name, -1 if there is no such

在文件 SGObject.cpp1136 行定义.

virtual const char* get_name ( ) const
virtual
返回
object name

实现了 CSGObject.

在文件 List.h544 行定义.

CSGObject* get_next_element ( )

go to next element in list and return it

返回
next element in list or NULL if list is empty

在文件 List.h178 行定义.

CSGObject* get_next_element ( CListElement *&  p_current)

go to next element in list and return it

参数
p_currentcurrent list element
返回
next element in list or NULL if list is empty

在文件 List.h269 行定义.

int32_t get_num_elements ( )

get number of elements in list

返回
number of elements in list

在文件 List.h138 行定义.

CSGObject* get_previous_element ( )

go to previous element in list and return it

返回
previous element in list or NULL if list is empty

在文件 List.h195 行定义.

CSGObject* get_previous_element ( CListElement *&  p_current)

go to previous element in list and return it

参数
p_currentcurrent list element
返回
previous element in list or NULL if list is empty

在文件 List.h287 行定义.

bool insert_element ( CSGObject data)

insert element BEFORE the current element

参数
datadata element to insert
返回
if inserting was successful

在文件 List.h426 行定义.

bool is_generic ( EPrimitiveType *  generic) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

参数
genericset to the type of the generic if returning TRUE
返回
TRUE if a class template.

在文件 SGObject.cpp267 行定义.

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_versionparameter version of the file
current_versionversion from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
filefile to load from
prefixprefix for members
返回
(sorted) array of created TParameter instances with file data

在文件 SGObject.cpp672 行定义.

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_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
返回
new array with TParameter instances with the attached data

在文件 SGObject.cpp513 行定义.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

参数
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp344 行定义.

virtual void load_serializable_post ( )
throw (ShogunException
)
virtual

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.

异常
ShogunExceptionWill be thrown if an error occurres.

重载 CSGObject .

在文件 List.h514 行定义.

void load_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp1023 行定义.

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_baseset of TParameter instances that are mapped to the provided target parameter infos
base_versionversion of the parameter base
target_param_infosset of SGParamInfo instances that specify the target parameter base

在文件 SGObject.cpp710 行定义.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
)
protectedvirtualinherited

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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
返回
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

在文件 SGObject.cpp917 行定义.

void one_to_one_migration_prepare ( DynArray< TParameter * > *  param_base,
const SGParamInfo target,
TParameter *&  replacement,
TParameter *&  to_migrate,
char *  old_name = NULL 
)
protectedvirtualinherited

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_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
replacement(used as output) here the TParameter instance which is returned by migration is created into
to_migratethe only source that is used for migration
old_namewith this parameter, a name change may be specified

在文件 SGObject.cpp857 行定义.

bool pop ( )

removes last element of list

返回
if deletion was successful

在文件 List.h389 行定义.

void print_list ( )

print all elements of the list

在文件 List.h529 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp1075 行定义.

void print_serializable ( const char *  prefix = "")
virtualinherited

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp279 行定义.

bool push ( CSGObject data)

append at end of list

参数
datadata element to append
返回
if appending was successful

在文件 List.h380 行定义.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = Version::get_version_parameter() 
)
virtualinherited

Save this object to file.

参数
filewhere to save the object; will be closed during returning if PREFIX is an empty string.
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp285 行定义.

void save_serializable_post ( )
throw (ShogunException
)
protectedvirtualinherited

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CKernel 重载.

在文件 SGObject.cpp1038 行定义.

void save_serializable_pre ( )
throw (ShogunException
)
protectedvirtualinherited

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.

异常
ShogunExceptionWill be thrown if an error occurres.

CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool > , 以及 CDynamicObjectArray 重载.

在文件 SGObject.cpp1033 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp40 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp45 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp50 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp55 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp60 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp65 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp70 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp75 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp80 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp85 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp90 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp95 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp100 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp105 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp110 行定义.

void set_generic ( )
inherited

set generic type to T

void set_global_io ( SGIO io)
inherited

set the io object

参数
ioio object to use

在文件 SGObject.cpp206 行定义.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp219 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp254 行定义.

virtual CSGObject* shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

CGaussianKernel 重载.

在文件 SGObject.h150 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp274 行定义.

bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

返回
bool if parameter combination has changed since last update.

在文件 SGObject.cpp226 行定义.

类成员变量说明

SGIO* io
inherited

io

在文件 SGObject.h513 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h528 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h534 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h525 行定义.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

在文件 SGObject.h531 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h522 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h516 行定义.

Version* version
inherited

version

在文件 SGObject.h519 行定义.


该类的文档由以下文件生成:

SHOGUN Machine Learning Toolbox - Documentation