SHOGUN  4.1.0
 全部 类 命名空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义 组 页
所有成员列表 | 类 | Public 成员函数 | Public 属性 | Protected 成员函数 | Protected 属性
CCache< T > 模板类 参考

详细描述

template<class T>
class shogun::CCache< T >

Template class Cache implements a simple cache.

When the cache is full – elements that are least used are freed from the cache. Thus for the cache to be effective one should not visit loop over objects, i.e. visit elements in order 0...num_elements (with num_elements >> the maximal number of entries in cache)

在文件 SparseFeatures.h 第 34 行定义.

类 CCache< T > 继承关系图:
Inheritance graph
[图例]

Public 成员函数

 CCache ()
 
 CCache (int64_t cache_size, int64_t obj_size, int64_t num_entries)
 
virtual ~CCache ()
 
bool is_cached (int64_t number)
 
T * lock_entry (int64_t number)
 
void unlock_entry (int64_t number)
 
T * set_entry (int64_t number)
 
virtual const char * get_name () const
 
virtual CSGObject * shallow_copy () const
 
virtual CSGObject * deep_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="")
 
virtual bool load_serializable (CSerializableFile *file, const char *prefix="")
 
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_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict)
 
virtual void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObject * clone ()
 

Public 属性

SGIO * io
 
Parallel * parallel
 
Version * version
 
Parameter * m_parameters
 
Parameter * m_model_selection_parameters
 
Parameter * m_gradient_parameters
 
uint32_t m_hash
 

Protected 成员函数

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)
 

Protected 属性

bool cache_is_full
 
int64_t entry_size
 
int64_t nr_cache_lines
 
TEntry * lookup_table
 
TEntry ** cache_table
 
T * cache_block
 

构造及析构函数说明

CCache ( )

default constructor

在文件 Cache.h 第 48 行定义.

CCache ( int64_t  cache_size,
int64_t  obj_size,
int64_t  num_entries 
)

constructor

create a cache in which num_entries objects can be cached whose lookup table of sizeof(int64_t)*num_entries must fit into memory

参数
cache_sizecache size in Megabytes
obj_sizeobject size
num_entriesnumber of cached objects

在文件 Cache.h 第 72 行定义.

virtual ~CCache ( )
virtual

在文件 Cache.h 第 118 行定义.

成员函数说明

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.cpp 第 597 行定义.

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.cpp 第 714 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp 第 198 行定义.

bool equals ( CSGObject *  other,
float64_t  accuracy = 0.0,
bool  tolerant = false 
)
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)
tolerantallows linient check on float equality (within accuracy)
返回
true if all parameters were equal, false if not

在文件 SGObject.cpp 第 618 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp 第 235 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp 第 277 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp 第 290 行定义.

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

在文件 SGObject.cpp 第 498 行定义.

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.cpp 第 522 行定义.

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.cpp 第 535 行定义.

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

实现了 CSGObject.

在文件 Cache.h 第 250 行定义.

bool is_cached ( int64_t  number)

checks if an object is cached

参数
numbernumber of object to check for
返回
if an object is cached

在文件 Cache.h 第 130 行定义.

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.cpp 第 296 行定义.

bool load_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 369 行定义.

void load_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::LOAD_SERIALIZABLE_POST is called.

异常
ShogunExceptionwill be thrown if an error occurs.

被 CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel , 以及 CExponentialKernel 重载.

在文件 SGObject.cpp 第 426 行定义.

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 occurs.

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

在文件 SGObject.cpp 第 421 行定义.

T* lock_entry ( int64_t  number)

lock and get a cache entry

参数
numbernumber of object to lock and get
返回
cache entry or NULL when not cached

在文件 Cache.h 第 140 行定义.

bool parameter_hash_changed ( )
virtualinherited
返回
whether parameter combination has changed since last update

在文件 SGObject.cpp 第 262 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp 第 474 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp 第 308 行定义.

bool save_serializable ( CSerializableFile *  file,
const char *  prefix = "" 
)
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
返回
TRUE if done, otherwise FALSE

在文件 SGObject.cpp 第 314 行定义.

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 occurs.

被 CKernel 重载.

在文件 SGObject.cpp 第 436 行定义.

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 occurs.

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

在文件 SGObject.cpp 第 431 行定义.

T* set_entry ( int64_t  number)

returns the address of a free cache entry to where the data of size obj_size has to be written

参数
numbernumber of object to unlock
返回
address of a free cache entry

在文件 Cache.h 第 169 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 41 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 46 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 51 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 56 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 61 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 66 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 71 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 76 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 81 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 86 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 91 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 96 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 101 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 106 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp 第 111 行定义.

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.cpp 第 228 行定义.

void set_global_parallel ( Parallel *  parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp 第 241 行定义.

void set_global_version ( Version *  version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp 第 283 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

被 CGaussianKernel 重载.

在文件 SGObject.cpp 第 192 行定义.

void unlock_entry ( int64_t  number)

unlock a cache entry

参数
numbernumber of object to unlock

在文件 Cache.h 第 156 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp 第 303 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp 第 248 行定义.

类成员变量说明

T* cache_block
protected

cache block

在文件 Cache.h 第 264 行定义.

bool cache_is_full
protected

if cache is full

在文件 Cache.h 第 254 行定义.

TEntry** cache_table
protected

cache table containing cached objects

在文件 Cache.h 第 262 行定义.

int64_t entry_size
protected

size of one entry

在文件 Cache.h 第 256 行定义.

SGIO* io
inherited

io

在文件 SGObject.h 第 369 行定义.

TEntry* lookup_table
protected

lookup table

在文件 Cache.h 第 260 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h 第 384 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h 第 387 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h 第 381 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h 第 378 行定义.

int64_t nr_cache_lines
protected

number of cache lines

在文件 Cache.h 第 258 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h 第 372 行定义.

Version* version
inherited

version

在文件 SGObject.h 第 375 行定义.

该类的文档由以下文件生成:
SHOGUN 机器学习工具包 - 项目文档