CRandom类 参考

详细描述

: Pseudo random number geneartor

It is based on SIMD oriented Fast Mersenne Twister(SFMT) pseudorandom number generator.

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

类 CRandom 继承关系图:

Public 成员函数
	CRandom ()
	CRandom (uint32_t seed)
virtual	~CRandom ()
void	set_seed (uint32_t seed)
uint32_t	get_seed () const
uint32_t	random_32 () const
uint64_t	random_64 () const
int32_t	random_s32 () const
int64_t	random_s64 () const
uint64_t	random (uint64_t min_value, uint64_t max_value)
int64_t	random (int64_t min_value, int64_t max_value)
uint32_t	random (uint32_t min_value, uint32_t max_value)
int32_t	random (int32_t min_value, int32_t max_value)
float32_t	random (float32_t min_value, float32_t max_value)
float64_t	random (float64_t min_value, float64_t max_value)
floatmax_t	random (floatmax_t min_value, floatmax_t max_value)
void	fill_array (uint32_t *array, int32_t size) const
void	fill_array (uint64_t *array, int32_t size) const
void	fill_array_oc (float64_t *array, int32_t size) const
void	fill_array_co (float64_t *array, int32_t size) const
void	fill_array_oo (float64_t *array, int32_t size) const
void	fill_array_c1o2 (float64_t *array, int32_t size) const
float64_t	random_close () const
float64_t	random_open () const
float64_t	random_half_open () const
float64_t	normal_distrib (float64_t mu, float64_t sigma) const
float64_t	std_normal_distrib () 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 uint32_t	generate_seed ()

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)

构造及析构函数说明

CRandom

(

)

default ctor

在文件 Random.cpp 第 29 行定义.

CRandom

(

uint32_t

seed

)

ctor

参数

seed	the seed for the PRNG

在文件 Random.cpp 第 38 行定义.

~CRandom ( )

virtual

dtor

在文件 Random.cpp 第 47 行定义.

成员函数说明

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

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

void fill_array	(	uint32_t *	array,
		int32_t	size
	)		const

Fill an array of unsinged 32 bit integer

参数

array	32-bit unsigened int array to be filled
size	size of the array

在文件 Random.cpp 第 140 行定义.

void fill_array	(	uint64_t *	array,
		int32_t	size
	)		const

Fill an array of unsinged 64 bit integer

参数

array	64-bit unsigened int array to be filled
size	size of the array

在文件 Random.cpp 第 153 行定义.

void fill_array_c1o2	(	float64_t *	array,
		int32_t	size
	)		const

Fills an array of float64_t with randoms from the [1,2) interval

参数

array
size

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

void fill_array_co	(	float64_t *	array,
		int32_t	size
	)		const

Fills an array of float64_t with randoms from the [0,1) interval

参数

array
size

在文件 Random.cpp 第 179 行定义.

void fill_array_oc	(	float64_t *	array,
		int32_t	size
	)		const

Fills an array of float64_t with randoms from the (0,1] interval

参数

array
size

在文件 Random.cpp 第 166 行定义.

void fill_array_oo	(	float64_t *	array,
		int32_t	size
	)		const

Fills an array of float64_t with randoms from the (0,1) interval

参数

array
size

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

uint32_t generate_seed ( )

static

Generate a seed for PRNG

返回

entropy for PRNG

在文件 Random.cpp 第 315 行定义.

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_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

Returns the name of the SGSerializable instance. It MUST BE the CLASS NAME without the prefixed `C'.

返回

name of the SGSerializable

实现了 CSGObject.

在文件 Random.h 第 276 行定义.

uint32_t get_seed

(

)

const

get seed

返回

seed

在文件 Random.cpp 第 62 行定义.

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

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 normal_distrib	(	float64_t	mu,
		float64_t	sigma
	)		const

Sample a normal distrbution. Using Ziggurat algorithm

参数

mu	mean
sigma	variance

返回

sample from the desired normal distrib

在文件 Random.cpp 第 233 行定义.

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

参数

prefix

prefix for members

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

uint64_t random	(	uint64_t	min_value,
		uint64_t	max_value
	)

generate an unsigned 64bit integer in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 101 行定义.

int64_t random	(	int64_t	min_value,
		int64_t	max_value
	)

generate an signed 64bit integer in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 113 行定义.

uint32_t random	(	uint32_t	min_value,
		uint32_t	max_value
	)

generate an unsigned signed 32bit integer in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 125 行定义.

int32_t random	(	int32_t	min_value,
		int32_t	max_value
	)

generate an signed 32bit integer in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 137 行定义.

float32_t random	(	float32_t	min_value,
		float32_t	max_value
	)

generate an 32bit floating point number in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 149 行定义.

float64_t random	(	float64_t	min_value,
		float64_t	max_value
	)

generate an 64bit floating point number in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 161 行定义.

floatmax_t random	(	floatmax_t	min_value,
		floatmax_t	max_value
	)

generate an 96-128bit floating point number (depending on the size of floatmax_t) in the range [min_value, max_value] (closed interval!)

参数

min_value	minimum value
max_value	maximum value

返回

random number

在文件 Random.h 第 174 行定义.

uint32_t random_32

(

)

const

Generate an unsigned 32-bit random integer

返回

the random 32-bit unsigned integer

在文件 Random.cpp 第 130 行定义.

uint64_t random_64

(

)

const

Generate an unsigned 64-bit random integer

返回

the random 64-bit unsigned integer

在文件 Random.cpp 第 135 行定义.

float64_t random_close

(

)

const

Get random

返回

a float64_t random from [0,1] interval

在文件 Random.cpp 第 218 行定义.

float64_t random_half_open

(

)

const

Get random

返回

a float64_t random from [0,1) interval

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

float64_t random_open

(

)

const

Get random

返回

a float64_t random from (0,1) interval

在文件 Random.cpp 第 223 行定义.

int32_t random_s32

(

)

const

Generate a signed 32-bit random integer

返回

the random 32-bit signed integer

在文件 Random.h 第 79 行定义.

int64_t random_s64

(

)

const

Generate a signed 64-bit random integer

返回

the random 64-bit signed integer

在文件 Random.h 第 89 行定义.

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_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_seed

(

uint32_t

seed

)

set seed

参数

seed	seed for PRNG

在文件 Random.cpp 第 57 行定义.

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

float64_t std_normal_distrib

(

)

const

Sample a standard normal distribution, i.e. mean = 0, var = 1.0

返回

sample from the std normal distrib

在文件 Random.cpp 第 238 行定义.

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

类成员变量说明

SGIO* io

inherited

io

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

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

Parallel* parallel

inherited

parallel

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

Version* version

inherited

version

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

---

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

• Random.h
• Random.cpp