CMath类 参考

详细描述

Class which collects generic mathematical functions.

在文件 Math.h 第 138 行定义.

类 CMath 继承关系图:

Public 成员函数
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="", 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)
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 bool	update_parameter_hash ()
virtual bool	equals (CSGObject *other, float64_t accuracy=0.0)
virtual CSGObject *	clone ()
Constructor/Destructor.
	CMath ()
	Constructor - initializes log-table. 更多...
virtual	~CMath ()
	Destructor - frees logtable. 更多...

静态 Public 成员函数
static float64_t	real (complex128_t c)
	returns real part of a complex128_t number 更多...
static float64_t	imag (complex128_t c)
	returns imag part of a complex128_t number 更多...
static uint32_t	get_seed ()
	returns number generator seed 更多...
static uint32_t	get_log_range ()
	returns range of logtable 更多...
static int	is_finite (double f)
	checks whether a float is finite 更多...
static int	is_infinity (double f)
	checks whether a float is infinity 更多...
static int	is_nan (double f)
	checks whether a float is nan 更多...
min/max/abs functions.
template<class T >
static T	min (T a, T b)
	return the minimum of two integers 更多...
template<class T >
static T	max (T a, T b)
	return the maximum of two integers 更多...
template<class T >
static T	clamp (T value, T lb, T ub)
	return the value clamped to interval [lb,ub] 更多...
template<class T >
static T	abs (T a)
	return the absolute value of a number 更多...
static float64_t	abs (complex128_t a)
	return the absolute value of a complex number 更多...
misc functions
static float64_t	round (float64_t d)
static float64_t	floor (float64_t d)
static float64_t	ceil (float64_t d)
template<class T >
static T	sign (T a)
	signum of type T variable a 更多...
template<class T >
static void	swap (T &a, T &b)
	swap e.g. floats a and b 更多...
template<class T >
static T	sq (T x)
	x^2 更多...
static float32_t	sqrt (float32_t x)
	x^0.5 更多...
static float64_t	sqrt (float64_t x)
	x^0.5 更多...
static floatmax_t	sqrt (floatmax_t x)
	x^0.5 更多...
static float32_t	invsqrt (float32_t x)
	x^0.5, x being a complex128_t 更多...
static floatmax_t	powl (floatmax_t x, floatmax_t n)
	x^n 更多...
static int32_t	pow (bool x, int32_t n)
static int32_t	pow (int32_t x, int32_t n)
static float64_t	pow (float64_t x, int32_t n)
static float64_t	pow (float64_t x, float64_t n)
static complex128_t	pow (complex128_t x, int32_t n)
	x^n, x or n being a complex128_t 更多...
static complex128_t	pow (complex128_t x, complex128_t n)
static complex128_t	pow (complex128_t x, float64_t n)
static complex128_t	pow (float64_t x, complex128_t n)
static float64_t	exp (float64_t x)
static float64_t	tan (float64_t x)
	exp(x), x being a complex128_t 更多...
static float64_t	atan (float64_t x)
	tan(x), x being a complex128_t 更多...
static float64_t	atan2 (float64_t x, float64_t y)
	atan(x), x being a complex128_t not implemented 更多...
static float64_t	tanh (float64_t x)
	atan2(x), x being a complex128_t not implemented 更多...
static float64_t	log10 (float64_t v)
	tanh(x), x being a complex128_t 更多...
static float64_t	log2 (float64_t v)
	log10(x), x being a complex128_t 更多...
static float64_t	log (float64_t v)
static index_t	floor_log (index_t n)
	log(x), x being a complex128_t 更多...
static float64_t	sin (float64_t x)
static float64_t	asin (float64_t x)
	sin(x), x being a complex128_t 更多...
static float64_t	sinh (float64_t x)
	asin(x), x being a complex128_t not implemented 更多...
static float64_t	cos (float64_t x)
	sinh(x), x being a complex128_t 更多...
static float64_t	acos (float64_t x)
	cos(x), x being a complex128_t 更多...
static float64_t	cosh (float64_t x)
	acos(x), x being a complex128_t not implemented 更多...
static float64_t	area_under_curve (float64_t *xy, int32_t len, bool reversed)
	cosh(x), x being a complex128_t 更多...
static int64_t	factorial (int32_t n)
static void	init_random (uint32_t initseed=0)
static uint64_t	random ()
static uint64_t	random (uint64_t min_value, uint64_t max_value)
static int64_t	random (int64_t min_value, int64_t max_value)
static uint32_t	random (uint32_t min_value, uint32_t max_value)
static int32_t	random (int32_t min_value, int32_t max_value)
static float32_t	random (float32_t min_value, float32_t max_value)
static float64_t	random (float64_t min_value, float64_t max_value)
static floatmax_t	random (floatmax_t min_value, floatmax_t max_value)
static float32_t	normal_random (float32_t mean, float32_t std_dev)
static float64_t	normal_random (float64_t mean, float64_t std_dev)
static float32_t	randn_float ()
static float64_t	randn_double ()
template<class T >
static int32_t	get_num_nonzero (T *vec, int32_t len)
static int32_t	get_num_nonzero (complex128_t *vec, int32_t len)
static int64_t	nchoosek (int32_t n, int32_t k)
static void	linspace (float64_t *output, float64_t start, float64_t end, int32_t n=100)
template<class T >
static T	log_sum_exp (SGVector< T > values)
template<class T >
static T	log_mean_exp (SGVector< T > values)
static void	sort (int32_t *a, int32_t cols, int32_t sort_col=0)
static void	sort (float64_t *a, int32_t *idx, int32_t N)
template<class T >
static void	qsort (T *output, int32_t size)
template<class T >
static void	insertion_sort (T *output, int32_t size)
template<class T >
static void	radix_sort (T *array, int32_t size)
template<class T >
static uint8_t	byte (T word, uint16_t p)
static uint8_t	byte (complex128_t word, uint16_t p)
	byte not implemented for complex128_t 更多...
template<class T >
static void	radix_sort_helper (T *array, int32_t size, uint16_t i)
static void	radix_sort_helper (complex128_t *array, int32_t size, uint16_t i)
	radix_sort_helper not implemented for complex128_t 更多...
template<class T >
static void	qsort (T **vector, index_t length)
static void	qsort (complex128_t **vector, index_t length)
	qsort not implemented for complex128_t 更多...
template<class T >
static void	display_bits (T word, int32_t width=8 *sizeof(T))
	display bits (useful for debugging) 更多...
static void	display_bits (complex128_t word, int32_t width=8 *sizeof(complex128_t))
	disply_bits not implemented for complex128_t 更多...
template<class T1 , class T2 >
static void	qsort_index (T1 *output, T2 *index, uint32_t size)
template<class T >
static void	qsort_index (complex128_t *output, T *index, uint32_t size)
	qsort_index not implemented for complex128_t 更多...
template<class T1 , class T2 >
static void	qsort_backward_index (T1 *output, T2 *index, int32_t size)
template<class T >
static void	qsort_backword_index (complex128_t *output, T *index, uint32_t size)
	qsort_backword_index not implemented for complex128_t 更多...
template<class T1 , class T2 >
static void	parallel_qsort_index (T1 *output, T2 *index, uint32_t size, int32_t n_threads, int32_t limit=262144)
template<class T >
static void	parallel_qsort_index (complex128_t *output, T *index, uint32_t size, int32_t n_threads, int32_t limit=0)
	parallel_qsort_index not implemented for complex128_t 更多...
template<class T1 , class T2 >
static void *	parallel_qsort_index (void *p)
template<class T >
static void	min (float64_t *output, T *index, int32_t size)
static void	min (float64_t *output, complex128_t *index, int32_t size)
	complex128_t cannot be used as index 更多...
template<class T >
static void	nmin (float64_t *output, T *index, int32_t size, int32_t n)
static void	nmin (float64_t *output, complex128_t *index, int32_t size, int32_t n)
	complex128_t cannot be used as index 更多...
template<class T >
static int32_t	binary_search_helper (T *output, int32_t size, T elem)
static int32_t	binary_search_helper (complex128_t *output, int32_t size, complex128_t elem)
	binary_search_helper not implemented for complex128_t 更多...
template<class T >
static int32_t	binary_search (T *output, int32_t size, T elem)
static int32_t	binary_search (complex128_t *output, int32_t size, complex128_t elem)
	binary_search not implemented for complex128_t 更多...
template<class T >
static int32_t	binary_search (T **vector, index_t length, T *elem)
static int32_t	binary_search (complex128_t **vector, index_t length, complex128_t *elem)
	binary_search not implemented for complex128_t 更多...
template<class T >
static int32_t	binary_search_max_lower_equal (T *output, int32_t size, T elem)
static int32_t	binary_search_max_lower_equal (complex128_t *output, int32_t size, complex128_t elem)
	binary_search_max_lower_equal not implemented for complex128_t 更多...
static float64_t	Align (char *seq1, char *seq2, int32_t l1, int32_t l2, float64_t gapCost)
summing functions
static float64_t	logarithmic_sum (float64_t p, float64_t q)

Public 属性
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters
Parameter *	m_gradient_parameters
ParameterMap *	m_parameter_map
uint32_t	m_hash

Protected 成员函数
virtual TParameter *	migrate (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	load_serializable_post () throw (ShogunException)
virtual void	save_serializable_pre () throw (ShogunException)
virtual void	save_serializable_post () throw (ShogunException)

constants
static const float64_t	INFTY = -log(0.0)
	infinity 更多...
static const float64_t	ALMOST_INFTY = +1e+20
static const float64_t	ALMOST_NEG_INFTY = -1000
	almost neg (log) infinity 更多...
static const float64_t	PI =M_PI
static const float64_t	MACHINE_EPSILON =5E-16
static const float64_t	MAX_REAL_NUMBER =1E300
static const float64_t	MIN_REAL_NUMBER =1E-300
static int32_t	LOGRANGE = 0
	range for logtable: log(1+exp(x)) -LOGRANGE <= x <= 0 更多...
static uint32_t	seed = 0
	random generator seed 更多...

构造及析构函数说明

CMath

(

)

Constructor - initializes log-table.

在文件 Math.cpp 第 50 行定义.

~CMath ( )

virtual

Destructor - frees logtable.

在文件 Math.cpp 第 67 行定义.

成员函数说明

static T abs ( T  a )

static

return the absolute value of a number

在文件 Math.h 第 184 行定义.

static float64_t abs ( complex128_t  a )

static

return the absolute value of a complex number

在文件 Math.h 第 197 行定义.

static float64_t acos ( float64_t  x )

static

cos(x), x being a complex128_t

在文件 Math.h 第 474 行定义.

float64_t Align ( char *  seq1, char *  seq2, int32_t  l1, int32_t  l2, float64_t  gapCost  )

static

align two sequences seq1 & seq2 of length l1 and l2 using gapCost return alignment cost

在文件 Math.cpp 第 145 行定义.

static float64_t area_under_curve ( float64_t *  xy, int32_t  len, bool  reversed  )

static

cosh(x), x being a complex128_t

在文件 Math.h 第 490 行定义.

static float64_t asin ( float64_t  x )

static

sin(x), x being a complex128_t

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

static float64_t atan ( float64_t  x )

static

tan(x), x being a complex128_t

返回

arcus tangens of input

在文件 Math.h 第 382 行定义.

static float64_t atan2 ( float64_t  x, float64_t  y  )

static

atan(x), x being a complex128_t not implemented

返回

arcus tangens of input

在文件 Math.h 第 391 行定义.

static int32_t binary_search ( T *  output, int32_t  size, T  elem  )

static

在文件 Math.h 第 1109 行定义.

static int32_t binary_search ( complex128_t *  output, int32_t  size, complex128_t  elem  )

static

binary_search not implemented for complex128_t

在文件 Math.h 第 1118 行定义.

static int32_t binary_search ( T **  vector, index_t  length, T *  elem  )

static

在文件 Math.h 第 1133 行定义.

static int32_t binary_search ( complex128_t **  vector, index_t  length, complex128_t *  elem  )

static

binary_search not implemented for complex128_t

在文件 Math.h 第 1164 行定义.

static int32_t binary_search_helper ( T *  output, int32_t  size, T  elem  )

static

在文件 Math.h 第 1076 行定义.

static int32_t binary_search_helper ( complex128_t *  output, int32_t  size, complex128_t  elem  )

static

binary_search_helper not implemented for complex128_t

在文件 Math.h 第 1100 行定义.

static int32_t binary_search_max_lower_equal ( T *  output, int32_t  size, T  elem  )

static

在文件 Math.h 第 1171 行定义.

static int32_t binary_search_max_lower_equal ( complex128_t *  output, int32_t  size, complex128_t  elem  )

static

binary_search_max_lower_equal not implemented for complex128_t

在文件 Math.h 第 1184 行定义.

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

static uint8_t byte ( T  word, uint16_t  p  )

static

在文件 Math.h 第 783 行定义.

static uint8_t byte ( complex128_t  word, uint16_t  p  )

static

byte not implemented for complex128_t

在文件 Math.h 第 789 行定义.

static float64_t ceil ( float64_t  d )

static

在文件 Math.h 第 218 行定义.

static T clamp ( T  value, T  lb, T  ub  )

static

return the value clamped to interval [lb,ub]

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

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

static float64_t cos ( float64_t  x )

static

sinh(x), x being a complex128_t

在文件 Math.h 第 466 行定义.

static float64_t cosh ( float64_t  x )

static

acos(x), x being a complex128_t not implemented

在文件 Math.h 第 482 行定义.

virtual CSGObject* deep_copy ( ) const

virtualinherited

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

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

static void display_bits ( T  word, int32_t  width = 8*sizeof(T)  )

static

display bits (useful for debugging)

在文件 Math.h 第 955 行定义.

static void display_bits ( complex128_t  word, int32_t  width = 8*sizeof(complex128_t)  )

static

disply_bits not implemented for complex128_t

在文件 Math.h 第 974 行定义.

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.

参数

other	object to compare with
accuracy	accuracy to use for comparison (optional)

返回

true if all parameters were equal, false if not

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

static float64_t exp ( float64_t  x )

static

在文件 Math.h 第 364 行定义.

static int64_t factorial ( int32_t  n )

static

在文件 Math.h 第 510 行定义.

static float64_t floor ( float64_t  d )

static

在文件 Math.h 第 213 行定义.

static index_t floor_log ( index_t  n )

static

log(x), x being a complex128_t

在文件 Math.h 第 433 行定义.

SGIO * get_global_io ( )

inherited

get the io object

返回

io object

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

Parallel * get_global_parallel ( )

inherited

get the parallel object

返回

parallel object

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

Version * get_global_version ( )

inherited

get the version object

返回

version object

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

static uint32_t get_log_range ( )

static

returns range of logtable

在文件 Math.h 第 1219 行定义.

SGStringList< char > get_modelsel_names ( )

inherited

返回

vector of names of all parameters which are registered for model selection

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

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

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

virtual const char* get_name ( ) const

virtual

返回

object name

实现了 CSGObject.

在文件 Math.h 第 1324 行定义.

static int32_t get_num_nonzero ( T *  vec, int32_t  len  )

static

在文件 Math.h 第 614 行定义.

static int32_t get_num_nonzero ( complex128_t *  vec, int32_t  len  )

static

在文件 Math.h 第 623 行定义.

static uint32_t get_seed ( )

static

returns number generator seed

在文件 Math.h 第 1213 行定义.

static float64_t imag ( complex128_t  c )

static

returns imag part of a complex128_t number

在文件 Math.h 第 1207 行定义.

static void init_random ( uint32_t  initseed = 0 )

static

在文件 Math.h 第 518 行定义.

static void insertion_sort ( T *  output, int32_t  size  )

static

performs insertion sort of an array output of length size it is sorted from in ascending (for type T)

在文件 Math.h 第 755 行定义.

static float32_t invsqrt ( float32_t  x )

static

x^0.5, x being a complex128_t

x^-0.5

在文件 Math.h 第 277 行定义.

int is_finite ( double  f )

static

checks whether a float is finite

在文件 Math.cpp 第 234 行定义.

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

int is_infinity ( double  f )

static

checks whether a float is infinity

在文件 Math.cpp 第 215 行定义.

int is_nan ( double  f )

static

checks whether a float is nan

在文件 Math.cpp 第 202 行定义.

void linspace ( float64_t *  output, float64_t  start, float64_t  end, int32_t  n = 100  )

static

Builds an array with n linearly spaced elements between start and end.

参数

output	array with linearly spaced elements within the interval
start	beginning of the interval to divide
end	upper bound of the interval to divide
n	number of elements used to divide the interval

在文件 Math.cpp 第 188 行定义.

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_version	parameter version of the file
current_version	version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases)
file	file to load from
prefix	prefix for members

返回

(sorted) array of created TParameter instances with file data

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

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_info	information of parameter
file_version	parameter version of the file, must be <= provided parameter version
file	file to load from
prefix	prefix for members

返回

new array with TParameter instances with the attached data

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

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!

参数

file	where to load from
prefix	prefix 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.cpp 第 305 行定义.

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

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

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

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

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

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

static float64_t log ( float64_t  v )

static

在文件 Math.h 第 425 行定义.

static float64_t log10 ( float64_t  v )

static

tanh(x), x being a complex128_t

在文件 Math.h 第 408 行定义.

static float64_t log2 ( float64_t  v )

static

log10(x), x being a complex128_t

在文件 Math.h 第 416 行定义.

static T log_mean_exp ( SGVector< T >  values )

static

Computes \(\log(\frac{1}{n}\sum_{i=1}^n \exp(x_i))\) for given \(x_i\) using the log-sum-exp trick which avoids numerical problems.

参数

values

the vector of \(x_i\)

返回

\(\log(\frac{1}{n}\sum_{i=1}^n \exp(x_i))\)

在文件 Math.h 第 699 行定义.

static T log_sum_exp ( SGVector< T >  values )

static

Computes \(\log(\sum_{i=1}^n \exp(x_i))\) for given \(x_i\) using the log-sum-exp trick which avoids numerical problems.

参数

values

the vector of \(x_i\)

返回

\(\log(\sum_{i=1}^n \exp(x_i))\) for given \(x_i\)

在文件 Math.h 第 657 行定义.

static float64_t logarithmic_sum ( float64_t  p, float64_t  q  )

static

sum logarithmic probabilities. Probability measures are summed up but are now given in logspace where direct summation of exp(operand) is not possible due to numerical problems, i.e. eg. exp(-1000)=0. Therefore we do log( exp(a) + exp(b)) = a + log (1 + exp (b-a)) where a = max(p,q) and b min(p,q).

在文件 Math.h 第 1279 行定义.

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_base	set of TParameter instances that are mapped to the provided target parameter infos
base_version	version of the parameter base
target_param_infos	set of SGParamInfo instances that specify the target parameter base

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

static T max ( T  a, T  b  )

static

return the maximum of two integers

在文件 Math.h 第 165 行定义.

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_base	set of TParameter instances to use for migration
target	parameter 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.cpp 第 878 行定义.

static T min ( T  a, T  b  )

static

return the minimum of two integers

在文件 Math.h 第 158 行定义.

void min ( float64_t *  output, T *  index, int32_t  size  )

static

在文件 Math.h 第 1573 行定义.

static void min ( float64_t *  output, complex128_t *  index, int32_t  size  )

static

complex128_t cannot be used as index

在文件 Math.h 第 1053 行定义.

static int64_t nchoosek ( int32_t  n, int32_t  k  )

static

在文件 Math.h 第 631 行定义.

void nmin ( float64_t *  output, T *  index, int32_t  size, int32_t  n  )

static

在文件 Math.h 第 1562 行定义.

static void nmin ( float64_t *  output, complex128_t *  index, int32_t  size, int32_t  n  )

static

complex128_t cannot be used as index

在文件 Math.h 第 1065 行定义.

static float32_t normal_random ( float32_t  mean, float32_t  std_dev  )

static

Returns a Gaussian or Normal random number. Using the polar form of the Box-Muller transform. http://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform#Polar_form

在文件 Math.h 第 571 行定义.

static float64_t normal_random ( float64_t  mean, float64_t  std_dev  )

static

Returns a Gaussian or Normal random number. Using the polar form of the Box-Muller transform. http://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform#Polar_form

在文件 Math.h 第 594 行定义.

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

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

static void parallel_qsort_index ( T1 *  output, T2 *  index, uint32_t  size, int32_t  n_threads, int32_t  limit = 262144  )

static

performs a quicksort on an array output of length size it is sorted in ascending order (for type T1) and returns the index (type T2) matlab alike [sorted,index]=sort(output)

parallel version

在文件 Math.h 第 1021 行定义.

static void parallel_qsort_index ( complex128_t *  output, T *  index, uint32_t  size, int32_t  n_threads, int32_t  limit = 0  )

static

parallel_qsort_index not implemented for complex128_t

在文件 Math.h 第 1036 行定义.

void * parallel_qsort_index ( void *  p )

static

在文件 Math.h 第 1364 行定义.

static int32_t pow ( bool  x, int32_t  n  )

static

在文件 Math.h 第 309 行定义.

static int32_t pow ( int32_t  x, int32_t  n  )

static

在文件 Math.h 第 314 行定义.

static float64_t pow ( float64_t  x, int32_t  n  )

static

在文件 Math.h 第 324 行定义.

static float64_t pow ( float64_t  x, float64_t  n  )

static

在文件 Math.h 第 338 行定义.

static complex128_t pow ( complex128_t  x, int32_t  n  )

static

x^n, x or n being a complex128_t

在文件 Math.h 第 344 行定义.

static complex128_t pow ( complex128_t  x, complex128_t  n  )

static

在文件 Math.h 第 349 行定义.

static complex128_t pow ( complex128_t  x, float64_t  n  )

static

在文件 Math.h 第 354 行定义.

static complex128_t pow ( float64_t  x, complex128_t  n  )

static

在文件 Math.h 第 359 行定义.

static floatmax_t powl ( floatmax_t  x, floatmax_t  n  )

static

x^n

在文件 Math.h 第 298 行定义.

void print_modsel_params ( )

inherited

prints all parameter registered for model selection and their type

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

void print_serializable ( const char *  prefix = "" )

virtualinherited

prints registered parameters out

参数

prefix

prefix for members

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

static void qsort ( T *  output, int32_t  size  )

static

performs a quicksort on an array output of length size it is sorted from in ascending (for type T)

在文件 Math.h 第 713 行定义.

static void qsort ( T **  vector, index_t  length  )

static

Performs a quicksort on an array of pointers. It is sorted from in ascending (for type T)

Every element is dereferenced once before being compared

参数

vector	array of pointers to sort
length	length of array

在文件 Math.h 第 910 行定义.

static void qsort ( complex128_t **  vector, index_t  length  )

static

qsort not implemented for complex128_t

在文件 Math.h 第 949 行定义.

void qsort_backward_index ( T1 *  output, T2 *  index, int32_t  size  )

static

performs a quicksort on an array output of length size it is sorted in descending order (for type T1) and returns the index (type T2) matlab alike [sorted,index]=sort(output)

在文件 Math.h 第 1517 行定义.

static void qsort_backword_index ( complex128_t *  output, T *  index, uint32_t  size  )

static

qsort_backword_index not implemented for complex128_t

在文件 Math.h 第 1006 行定义.

void qsort_index ( T1 *  output, T2 *  index, uint32_t  size  )

static

performs a quicksort on an array output of length size it is sorted in ascending order (for type T1) and returns the index (type T2) matlab alike [sorted,index]=sort(output)

在文件 Math.h 第 1473 行定义.

static void qsort_index ( complex128_t *  output, T *  index, uint32_t  size  )

static

qsort_index not implemented for complex128_t

在文件 Math.h 第 990 行定义.

static void radix_sort ( T *  array, int32_t  size  )

static

performs a in-place radix sort in ascending order

在文件 Math.h 第 772 行定义.

static void radix_sort_helper ( T *  array, int32_t  size, uint16_t  i  )

static

在文件 Math.h 第 796 行定义.

static void radix_sort_helper ( complex128_t *  array, int32_t  size, uint16_t  i  )

static

radix_sort_helper not implemented for complex128_t

在文件 Math.h 第 895 行定义.

static float64_t randn_double ( )

static

Convenience method for generating Standard Normal random numbers Double: Mean = 0 and Standard Deviation = 1

在文件 Math.h 第 608 行定义.

static float32_t randn_float ( )

static

Convenience method for generating Standard Normal random numbers Float: Mean = 0 and Standard Deviation = 1

在文件 Math.h 第 601 行定义.

static uint64_t random ( )

static

在文件 Math.h 第 528 行定义.

static uint64_t random ( uint64_t  min_value, uint64_t  max_value  )

static

在文件 Math.h 第 533 行定义.

static int64_t random ( int64_t  min_value, int64_t  max_value  )

static

在文件 Math.h 第 538 行定义.

static uint32_t random ( uint32_t  min_value, uint32_t  max_value  )

static

在文件 Math.h 第 543 行定义.

static int32_t random ( int32_t  min_value, int32_t  max_value  )

static

在文件 Math.h 第 548 行定义.

static float32_t random ( float32_t  min_value, float32_t  max_value  )

static

在文件 Math.h 第 553 行定义.

static float64_t random ( float64_t  min_value, float64_t  max_value  )

static

在文件 Math.h 第 558 行定义.

static floatmax_t random ( floatmax_t  min_value, floatmax_t  max_value  )

static

在文件 Math.h 第 563 行定义.

static float64_t real ( complex128_t  c )

static

returns real part of a complex128_t number

在文件 Math.h 第 1201 行定义.

static float64_t round ( float64_t  d )

static

在文件 Math.h 第 208 行定义.

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

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
param_version	(optional) a parameter version different to (this is mainly for testing, better do not use)

返回

TRUE if done, otherwise FALSE

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

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

被 CKernel 重载.

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

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

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

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

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

void set_global_parallel ( Parallel *  parallel )

inherited

set the parallel object

参数

parallel

parallel object to use

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

void set_global_version ( Version *  version )

inherited

set the version object

参数

version

version object to use

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

virtual CSGObject* shallow_copy ( ) const

virtualinherited

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

被 CGaussianKernel 重载.

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

static T sign ( T  a )

static

signum of type T variable a

在文件 Math.h 第 225 行定义.

static float64_t sin ( float64_t  x )

static

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

static float64_t sinh ( float64_t  x )

static

asin(x), x being a complex128_t not implemented

在文件 Math.h 第 458 行定义.

void sort ( int32_t *  a, int32_t  cols, int32_t  sort_col = 0  )

static

performs a bubblesort on a given matrix a. it is sorted in ascending order from top to bottom and left to right

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

void sort ( float64_t *  a, int32_t *  idx, int32_t  N  )

static

在文件 Math.cpp 第 126 行定义.

static T sq ( T  x )

static

x^2

在文件 Math.h 第 244 行定义.

static float32_t sqrt ( float32_t  x )

static

x^0.5

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

static float64_t sqrt ( float64_t  x )

static

x^0.5

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

static floatmax_t sqrt ( floatmax_t  x )

static

x^0.5

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

static void swap ( T &  a, T &  b  )

static

swap e.g. floats a and b

在文件 Math.h 第 234 行定义.

static float64_t tan ( float64_t  x )

static

exp(x), x being a complex128_t

返回

tangens of input

在文件 Math.h 第 373 行定义.

static float64_t tanh ( float64_t  x )

static

atan2(x), x being a complex128_t not implemented

返回

tangens hyperbolicus of input

在文件 Math.h 第 400 行定义.

void unset_generic ( )

inherited

unset generic type

this has to be called in classes specializing a template class

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

bool update_parameter_hash ( )

virtualinherited

Updates the hash of current parameter combination.

返回

bool if parameter combination has changed since last update.

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

类成员变量说明

const float64_t ALMOST_INFTY = +1e+20

static

在文件 Math.h 第 1330 行定义.

const float64_t ALMOST_NEG_INFTY = -1000

static

almost neg (log) infinity

在文件 Math.h 第 1333 行定义.

const float64_t INFTY = -log(0.0)

static

infinity

在文件 Math.h 第 1329 行定义.

SGIO* io

inherited

io

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

int32_t LOGRANGE = 0

staticprotected

range for logtable: log(1+exp(x)) -LOGRANGE <= x <= 0

在文件 Math.h 第 1347 行定义.

Parameter* m_gradient_parameters

inherited

parameters wrt which we can compute gradients

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

uint32_t m_hash

inherited

Hash of parameter values

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

Parameter* m_model_selection_parameters

inherited

model selection parameters

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

ParameterMap* m_parameter_map

inherited

map for different parameter versions

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

Parameter* m_parameters

inherited

parameters

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

const float64_t MACHINE_EPSILON =5E-16

static

machine epsilon for float64_t

在文件 Math.h 第 1339 行定义.

const float64_t MAX_REAL_NUMBER =1E300

static

在文件 Math.h 第 1342 行定义.

const float64_t MIN_REAL_NUMBER =1E-300

static

在文件 Math.h 第 1343 行定义.

Parallel* parallel

inherited

parallel

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

const float64_t PI =M_PI

static

the number pi

在文件 Math.h 第 1336 行定义.

uint32_t seed = 0

staticprotected

random generator seed

在文件 Math.h 第 1350 行定义.

Version* version

inherited

version

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

---

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

• Math.h
• Math.cpp