CPlif类 参考

详细描述

class Plif

在文件 Plif.h 第 40 行定义.

类 CPlif 继承关系图:

Public 成员函数
	CPlif (int32_t len=0)
virtual	~CPlif ()
void	init_penalty_struct_cache ()
float64_t	lookup_penalty_svm (float64_t p_value, float64_t *d_values) const
float64_t	lookup_penalty (float64_t p_value, float64_t *svm_values) const
float64_t	lookup_penalty (int32_t p_value, float64_t *svm_values) const
float64_t	lookup (float64_t p_value)
void	penalty_clear_derivative ()
void	penalty_add_derivative_svm (float64_t p_value, float64_t *svm_values, float64_t factor)
void	penalty_add_derivative (float64_t p_value, float64_t *svm_values, float64_t factor)
const float64_t *	get_cum_derivative (int32_t &p_len) const
bool	set_transform_type (const char *type_str)
const char *	get_transform_type ()
void	set_id (int32_t p_id)
int32_t	get_id () const
int32_t	get_max_id () const
void	set_use_svm (int32_t p_use_svm)
int32_t	get_use_svm () const
virtual bool	uses_svm_values () const
void	set_use_cache (int32_t p_use_cache)
void	invalidate_cache ()
int32_t	get_use_cache ()
void	set_plif (int32_t p_len, float64_t *p_limits, float64_t *p_penalties)
void	set_plif_limits (SGVector< float64_t > p_limits)
void	set_plif_penalty (SGVector< float64_t > p_penalties)
void	set_plif_length (int32_t p_len)
SGVector< float64_t >	get_plif_limits ()
SGVector< float64_t >	get_plif_penalties ()
void	set_max_value (float64_t p_max_value)
virtual float64_t	get_max_value () const
void	set_min_value (float64_t p_min_value)
virtual float64_t	get_min_value () const
void	set_plif_name (char *p_name)
char *	get_plif_name () const
bool	get_do_calc ()
void	set_do_calc (bool b)
void	get_used_svms (int32_t *num_svms, int32_t *svm_ids)
int32_t	get_plif_len ()
virtual void	list_plif () const
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 成员函数
static void	delete_penalty_struct (CPlif **PEN, int32_t P)

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 属性
int32_t	len
SGVector< float64_t >	limits
SGVector< float64_t >	penalties
SGVector< float64_t >	cum_derivatives
float64_t	max_value
float64_t	min_value
float64_t *	cache
enum ETransformType	transform
int32_t	id
char *	name
int32_t	use_svm
bool	use_cache
bool	do_calc

构造及析构函数说明

CPlif

(

int32_t

len = 0

)

constructor

参数

len

len

在文件 Plif.cpp 第 23 行定义.

~CPlif ( )

virtual

在文件 Plif.cpp 第 43 行定义.

成员函数说明

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.

参数

dict	dictionary 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 行定义.

void delete_penalty_struct ( CPlif **  PEN, int32_t  P  )

static

delete plif struct

参数

PEN	array of plifs
P	id of plif

在文件 Plif.cpp 第 115 行定义.

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)
tolerant	allows linient check on float equality (within accuracy)

返回

true if all parameters were equal, false if not

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

const float64_t* get_cum_derivative

(

int32_t &

p_len

)

const

get cum derivative

参数

p_len

len

返回

cum derivative

在文件 Plif.h 第 115 行定义.

bool get_do_calc

(

)

get do calc

返回

if calc shall be done

在文件 Plif.cpp 第 398 行定义.

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

int32_t get_id

(

)

const

get ID

返回

the ID

在文件 Plif.h 第 163 行定义.

int32_t get_max_id ( ) const

virtual

get maximum ID

返回

maximum ID

实现了 CPlifBase.

在文件 Plif.h 第 172 行定义.

virtual float64_t get_max_value ( ) const

virtual

get maximum value

返回

maximum value

实现了 CPlifBase.

在文件 Plif.h 第 341 行定义.

virtual float64_t get_min_value ( ) const

virtual

get minimum value

返回

minimum value

实现了 CPlifBase.

在文件 Plif.h 第 360 行定义.

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_name

name 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_name

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

在文件 Plif.h 第 420 行定义.

int32_t get_plif_len

(

)

get plif len

返回

plif len

在文件 Plif.h 第 398 行定义.

SGVector<float64_t> get_plif_limits

(

)

get Plif limits

返回

limits

在文件 Plif.h 第 313 行定义.

char * get_plif_name

(

)

const

get name

返回

name

在文件 Plif.cpp 第 103 行定义.

SGVector<float64_t> get_plif_penalties

(

)

get plif penalty

返回

plif penalty

在文件 Plif.h 第 322 行定义.

const char* get_transform_type

(

)

get transform type

返回

type_str type (string)

在文件 Plif.h 第 132 行定义.

int32_t get_use_cache

(

)

get use cache

返回

if cache is used

在文件 Plif.h 第 227 行定义.

int32_t get_use_svm

(

)

const

get use SVM

返回

if SVM is used

在文件 Plif.h 第 191 行定义.

void get_used_svms ( int32_t *  num_svms, int32_t *  svm_ids  )

virtual

get SVM_ids and number of SVMs used

实现了 CPlifBase.

在文件 Plif.cpp 第 388 行定义.

void init_penalty_struct_cache

(

)

init penalty struct cache

在文件 Plif.cpp 第 73 行定义.

void invalidate_cache

(

)

invalidate the cache

在文件 Plif.h 第 217 行定义.

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.

参数

generic

set to the type of the generic if returning TRUE

返回

TRUE if a class template.

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

virtual void list_plif ( ) const

virtual

print PLIF

lists some properties of the PLIF

实现了 CPlifBase.

在文件 Plif.h 第 407 行定义.

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!

参数

file	where to load from
prefix	prefix 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.

异常

ShogunException

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

异常

ShogunException

will 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 行定义.

float64_t lookup

(

float64_t

p_value

)

lookup

参数

p_value

value

返回

a penalty

在文件 Plif.h 第 84 行定义.

float64_t lookup_penalty ( float64_t  p_value, float64_t *  svm_values  ) const

virtual

lookup penalty float64_t

参数

p_value	value
svm_values	SVM values

返回

the penalty

实现了 CPlifBase.

在文件 Plif.cpp 第 205 行定义.

float64_t lookup_penalty ( int32_t  p_value, float64_t *  svm_values  ) const

virtual

lookup penalty int32_t

参数

p_value	value
svm_values	SVM values

返回

the penalty

实现了 CPlifBase.

在文件 Plif.cpp 第 185 行定义.

float64_t lookup_penalty_svm	(	float64_t	p_value,
		float64_t *	d_values
	)		const

lookup penalty SVM

参数

p_value	value
d_values	d values

返回

the penalty

在文件 Plif.cpp 第 122 行定义.

bool parameter_hash_changed ( )

virtualinherited

返回

whether parameter combination has changed since last update

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

void penalty_add_derivative ( float64_t  p_value, float64_t *  svm_values, float64_t  factor  )

virtual

penalty add derivative

参数

p_value	value
svm_values	SVM values
factor	factor weighting the added value

实现了 CPlifBase.

在文件 Plif.cpp 第 289 行定义.

void penalty_add_derivative_svm	(	float64_t	p_value,
		float64_t *	svm_values,
		float64_t	factor
	)

penalty add derivative SVM

参数

p_value	value
svm_values	SVM values
factor	factor weighting the added value

在文件 Plif.cpp 第 341 行定义.

void penalty_clear_derivative ( )

virtual

penalty clear derivative

实现了 CPlifBase.

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

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

参数

prefix

prefix for members

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

bool save_serializable ( CSerializableFile *  file, const char *  prefix = ""  )

virtualinherited

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

返回

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.

异常

ShogunException

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

异常

ShogunException

will 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 行定义.

void set_do_calc

(

bool

b

)

set do calc

参数

b	if calc shall be done

在文件 Plif.cpp 第 403 行定义.

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

参数

io	io object to use

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

void set_global_parallel ( Parallel *  parallel )

inherited

set the parallel object

参数

parallel

parallel object to use

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

void set_global_version ( Version *  version )

inherited

set the version object

参数

version

version object to use

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

void set_id

(

int32_t

p_id

)

set ID

参数

p_id	the id to set

在文件 Plif.h 第 154 行定义.

void set_max_value

(

float64_t

p_max_value

)

set maximum value

参数

p_max_value

maximum value

在文件 Plif.h 第 331 行定义.

void set_min_value

(

float64_t

p_min_value

)

set minimum value

参数

p_min_value

minimum value

在文件 Plif.h 第 350 行定义.

void set_plif	(	int32_t	p_len,
		float64_t *	p_limits,
		float64_t *	p_penalties
	)

set plif

参数

p_len	len
p_limits	limit
p_penalties	penalties

在文件 Plif.h 第 238 行定义.

void set_plif_length

(

int32_t

p_len

)

set plif length

参数

p_len

len

在文件 Plif.h 第 286 行定义.

void set_plif_limits

(

SGVector< float64_t >

p_limits

)

set plif_limits

参数

p_limits

limit

在文件 Plif.h 第 257 行定义.

void set_plif_name

(

char *

p_name

)

set name

参数

p_name

name

在文件 Plif.cpp 第 97 行定义.

void set_plif_penalty

(

SGVector< float64_t >

p_penalties

)

set plif penalty

参数

p_penalties

penalties

在文件 Plif.h 第 272 行定义.

bool set_transform_type

(

const char *

type_str

)

set transform type

参数

type_str

type (string)

返回

if setting was successful

在文件 Plif.cpp 第 49 行定义.

void set_use_cache

(

int32_t

p_use_cache

)

set use cache

参数

p_use_cache

if cache shall be used

在文件 Plif.h 第 209 行定义.

void set_use_svm

(

int32_t

p_use_svm

)

set use SVM

参数

p_use_svm

if SVM shall be used

在文件 Plif.h 第 181 行定义.

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

virtual bool uses_svm_values ( ) const

virtual

check if plif uses SVM values

返回

if plif uses SVM values

实现了 CPlifBase.

在文件 Plif.h 第 200 行定义.

类成员变量说明

float64_t* cache

protected

cache

在文件 Plif.h 第 436 行定义.

SGVector<float64_t> cum_derivatives

protected

cum derivatives

在文件 Plif.h 第 430 行定义.

bool do_calc

protected

do calc if this is true: lookup_penalty behaves normal else: lookup_penalty returns the p_value untransformed

在文件 Plif.h 第 450 行定义.

int32_t id

protected

id

在文件 Plif.h 第 440 行定义.

SGIO* io

inherited

io

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

int32_t len

protected

len

在文件 Plif.h 第 424 行定义.

SGVector<float64_t> limits

protected

limits

在文件 Plif.h 第 426 行定义.

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

float64_t max_value

protected

maximum value

在文件 Plif.h 第 432 行定义.

float64_t min_value

protected

minimum value

在文件 Plif.h 第 434 行定义.

char* name

protected

name

在文件 Plif.h 第 442 行定义.

Parallel* parallel

inherited

parallel

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

SGVector<float64_t> penalties

protected

penalties

在文件 Plif.h 第 428 行定义.

enum ETransformType transform

protected

transform type

在文件 Plif.h 第 438 行定义.

bool use_cache

protected

if cache shall be used

在文件 Plif.h 第 446 行定义.

int32_t use_svm

protected

if SVM shall be used

在文件 Plif.h 第 444 行定义.

Version* version

inherited

version

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

---

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

• Plif.h
• Plif.cpp