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

详细描述

Class which collects generic mathematical functions.

在文件 Math.h135 行定义.

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

Public 成员函数

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 void update_parameter_hash ()
 
virtual bool parameter_hash_changed ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)
 
virtual CSGObjectclone ()
 
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
template<class T >
static bool fequals_abs (const T &a, const T &b, const float64_t eps)
 
template<class T >
static bool fequals (const T &a, const T &b, const float64_t eps, bool tolerant=false)
 
static float64_t get_abs_tolorance (float64_t true_value, float64_t rel_tolorance)
 
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 bool strtof (const char *str, float32_t *float_result)
 
static bool strtod (const char *str, float64_t *double_result)
 
static bool strtold (const char *str, floatmax_t *long_double_result)
 
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 属性

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

constants

static const float64_t NOT_A_NUMBER = NAN
 not a number 更多...
 
static const float64_t INFTY = INFINITY
 infinity 更多...
 
static const float64_t ALMOST_INFTY = +1e+300
 
static const float64_t ALMOST_NEG_INFTY = -1e+300
 almost neg (log) infinity 更多...
 
static const float64_t PI =M_PI
 
static const float64_t MACHINE_EPSILON =DBL_EPSILON
 
static const float64_t MAX_REAL_NUMBER =DBL_MAX
 
static const float64_t MIN_REAL_NUMBER =DBL_MIN
 
static const float32_t F_MAX_VAL32 =FLT_MAX
 
static const float32_t F_MIN_NORM_VAL32 =FLT_MIN
 
static const float64_t F_MAX_VAL64 =DBL_MAX
 
static const float64_t F_MIN_NORM_VAL64 =DBL_MIN
 
static const float32_t F_MIN_VAL32 =(FLT_MIN * FLT_EPSILON)
 
static const float64_t F_MIN_VAL64 =(DBL_MIN * DBL_EPSILON)
 
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.cpp66 行定义.

~CMath ( )
virtual

Destructor - frees logtable.

在文件 Math.cpp83 行定义.

成员函数说明

static T abs ( a)
static

return the absolute value of a number

在文件 Math.h181 行定义.

static float64_t abs ( complex128_t  a)
static

return the absolute value of a complex number

在文件 Math.h194 行定义.

static float64_t acos ( float64_t  x)
static

cos(x), x being a complex128_t

在文件 Math.h554 行定义.

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

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

cosh(x), x being a complex128_t

在文件 Math.h570 行定义.

static float64_t asin ( float64_t  x)
static

sin(x), x being a complex128_t

在文件 Math.h530 行定义.

static float64_t atan ( float64_t  x)
static

tan(x), x being a complex128_t

返回
arcus tangens of input

在文件 Math.h462 行定义.

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

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

在文件 Math.h1193 行定义.

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

binary_search not implemented for complex128_t

在文件 Math.h1202 行定义.

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

在文件 Math.h1217 行定义.

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

binary_search not implemented for complex128_t

在文件 Math.h1248 行定义.

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

在文件 Math.h1160 行定义.

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

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

在文件 Math.h1255 行定义.

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

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

static uint8_t byte ( word,
uint16_t  p 
)
static

在文件 Math.h867 行定义.

static uint8_t byte ( complex128_t  word,
uint16_t  p 
)
static

byte not implemented for complex128_t

在文件 Math.h873 行定义.

static float64_t ceil ( float64_t  d)
static

在文件 Math.h298 行定义.

static T clamp ( value,
lb,
ub 
)
static

return the value clamped to interval [lb,ub]

在文件 Math.h169 行定义.

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

static float64_t cos ( float64_t  x)
static

sinh(x), x being a complex128_t

在文件 Math.h546 行定义.

static float64_t cosh ( float64_t  x)
static

acos(x), x being a complex128_t not implemented

在文件 Math.h562 行定义.

CSGObject * deep_copy ( ) const
virtualinherited

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

在文件 SGObject.cpp146 行定义.

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

display bits (useful for debugging)

在文件 Math.h1039 行定义.

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

disply_bits not implemented for complex128_t

在文件 Math.h1058 行定义.

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

static float64_t exp ( float64_t  x)
static

在文件 Math.h444 行定义.

static int64_t factorial ( int32_t  n)
static

在文件 Math.h594 行定义.

static bool fequals ( const T &  a,
const T &  b,
const float64_t  eps,
bool  tolerant = false 
)
static

Compares the value of two floats (handles special cases, such as NaN, Inf etc.) Note: returns true if a == b == NAN Implementation inspired by http://floating-point-gui.de/errors/comparison/

参数
afirst value to compare
bsecond value to compare
epsthreshold for values to be equal/different
tolerantallows linient check on float equality (within accuracy)
返回
true if values are equal within eps accuracy, false if not.

在文件 Math.h229 行定义.

static bool fequals_abs ( const T &  a,
const T &  b,
const float64_t  eps 
)
static

Compares the value of two floats based on eps only

参数
afirst value to compare
bsecond value to compare
epsthreshold for values to be equal/different
返回
true if values are equal within eps accuracy, false if not.

在文件 Math.h212 行定义.

static float64_t floor ( float64_t  d)
static

在文件 Math.h293 行定义.

static index_t floor_log ( index_t  n)
static

log(x), x being a complex128_t

在文件 Math.h513 行定义.

float64_t get_abs_tolorance ( float64_t  true_value,
float64_t  rel_tolorance 
)
static

在文件 Math.cpp364 行定义.

SGIO * get_global_io ( )
inherited

get the io object

返回
io object

在文件 SGObject.cpp183 行定义.

Parallel * get_global_parallel ( )
inherited

get the parallel object

返回
parallel object

在文件 SGObject.cpp224 行定义.

Version * get_global_version ( )
inherited

get the version object

返回
version object

在文件 SGObject.cpp237 行定义.

static uint32_t get_log_range ( )
static

returns range of logtable

在文件 Math.h1303 行定义.

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

在文件 SGObject.cpp1077 行定义.

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

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

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

实现了 CSGObject.

在文件 Math.h1408 行定义.

static int32_t get_num_nonzero ( T *  vec,
int32_t  len 
)
static

在文件 Math.h698 行定义.

static int32_t get_num_nonzero ( complex128_t vec,
int32_t  len 
)
static

在文件 Math.h707 行定义.

static uint32_t get_seed ( )
static

returns number generator seed

在文件 Math.h1297 行定义.

static float64_t imag ( complex128_t  c)
static

returns imag part of a complex128_t number

在文件 Math.h1291 行定义.

static void init_random ( uint32_t  initseed = 0)
static

在文件 Math.h602 行定义.

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

static float32_t invsqrt ( float32_t  x)
static

x^0.5, x being a complex128_t

x^-0.5

在文件 Math.h357 行定义.

int is_finite ( double  f)
static

checks whether a float is finite

在文件 Math.cpp249 行定义.

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

int is_infinity ( double  f)
static

checks whether a float is infinity

在文件 Math.cpp230 行定义.

int is_nan ( double  f)
static

checks whether a float is nan

在文件 Math.cpp217 行定义.

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.

参数
outputarray with linearly spaced elements within the interval
startbeginning of the interval to divide
endupper bound of the interval to divide
nnumber of elements used to divide the interval

在文件 Math.cpp204 行定义.

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

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

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

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

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

在文件 SGObject.cpp1004 行定义.

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

static float64_t log ( float64_t  v)
static

在文件 Math.h505 行定义.

static float64_t log10 ( float64_t  v)
static

tanh(x), x being a complex128_t

在文件 Math.h488 行定义.

static float64_t log2 ( float64_t  v)
static

log10(x), x being a complex128_t

在文件 Math.h496 行定义.

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.

参数
valuesthe vector of \(x_i\)
返回
\(\log(\frac{1}{n}\sum_{i=1}^n \exp(x_i))\)

在文件 Math.h783 行定义.

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.

参数
valuesthe vector of \(x_i\)
返回
\(\log(\sum_{i=1}^n \exp(x_i))\) for given \(x_i\)

在文件 Math.h741 行定义.

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

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

static T max ( a,
b 
)
static

return the maximum of two integers

在文件 Math.h162 行定义.

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

static T min ( a,
b 
)
static

return the minimum of two integers

在文件 Math.h155 行定义.

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

在文件 Math.h1669 行定义.

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

complex128_t cannot be used as index

在文件 Math.h1137 行定义.

static int64_t nchoosek ( int32_t  n,
int32_t  k 
)
static

在文件 Math.h715 行定义.

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

在文件 Math.h1658 行定义.

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

complex128_t cannot be used as index

在文件 Math.h1149 行定义.

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

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

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

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

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

void * parallel_qsort_index ( void *  p)
static

在文件 Math.h1460 行定义.

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

在文件 SGObject.cpp209 行定义.

static int32_t pow ( bool  x,
int32_t  n 
)
static

在文件 Math.h389 行定义.

static int32_t pow ( int32_t  x,
int32_t  n 
)
static

在文件 Math.h394 行定义.

static float64_t pow ( float64_t  x,
int32_t  n 
)
static

在文件 Math.h404 行定义.

static float64_t pow ( float64_t  x,
float64_t  n 
)
static

在文件 Math.h418 行定义.

static complex128_t pow ( complex128_t  x,
int32_t  n 
)
static

x^n, x or n being a complex128_t

在文件 Math.h424 行定义.

static complex128_t pow ( complex128_t  x,
complex128_t  n 
)
static

在文件 Math.h429 行定义.

static complex128_t pow ( complex128_t  x,
float64_t  n 
)
static

在文件 Math.h434 行定义.

static complex128_t pow ( float64_t  x,
complex128_t  n 
)
static

在文件 Math.h439 行定义.

static floatmax_t powl ( floatmax_t  x,
floatmax_t  n 
)
static

x^n

在文件 Math.h378 行定义.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

在文件 SGObject.cpp1053 行定义.

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

prints registered parameters out

参数
prefixprefix for members

在文件 SGObject.cpp255 行定义.

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

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

参数
vectorarray of pointers to sort
lengthlength of array

在文件 Math.h994 行定义.

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

qsort not implemented for complex128_t

在文件 Math.h1033 行定义.

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

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

qsort_backword_index not implemented for complex128_t

在文件 Math.h1090 行定义.

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

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

qsort_index not implemented for complex128_t

在文件 Math.h1074 行定义.

static void radix_sort ( T *  array,
int32_t  size 
)
static

performs a in-place radix sort in ascending order

在文件 Math.h856 行定义.

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

在文件 Math.h880 行定义.

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

radix_sort_helper not implemented for complex128_t

在文件 Math.h979 行定义.

static float64_t randn_double ( )
static

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

在文件 Math.h692 行定义.

static float32_t randn_float ( )
static

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

在文件 Math.h685 行定义.

static uint64_t random ( )
static

在文件 Math.h612 行定义.

static uint64_t random ( uint64_t  min_value,
uint64_t  max_value 
)
static

在文件 Math.h617 行定义.

static int64_t random ( int64_t  min_value,
int64_t  max_value 
)
static

在文件 Math.h622 行定义.

static uint32_t random ( uint32_t  min_value,
uint32_t  max_value 
)
static

在文件 Math.h627 行定义.

static int32_t random ( int32_t  min_value,
int32_t  max_value 
)
static

在文件 Math.h632 行定义.

static float32_t random ( float32_t  min_value,
float32_t  max_value 
)
static

在文件 Math.h637 行定义.

static float64_t random ( float64_t  min_value,
float64_t  max_value 
)
static

在文件 Math.h642 行定义.

static floatmax_t random ( floatmax_t  min_value,
floatmax_t  max_value 
)
static

在文件 Math.h647 行定义.

static float64_t real ( complex128_t  c)
static

returns real part of a complex128_t number

在文件 Math.h1285 行定义.

static float64_t round ( float64_t  d)
static

在文件 Math.h288 行定义.

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

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

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

void set_generic ( )
inherited

在文件 SGObject.cpp38 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp43 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp48 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp53 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp58 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp63 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp68 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp73 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp78 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp83 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp88 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp93 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp98 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp103 行定义.

void set_generic ( )
inherited

在文件 SGObject.cpp108 行定义.

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

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

参数
parallelparallel object to use

在文件 SGObject.cpp189 行定义.

void set_global_version ( Version version)
inherited

set the version object

参数
versionversion object to use

在文件 SGObject.cpp230 行定义.

CSGObject * shallow_copy ( ) const
virtualinherited

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

CGaussianKernel 重载.

在文件 SGObject.cpp140 行定义.

static T sign ( a)
static

signum of type T variable a

在文件 Math.h305 行定义.

static float64_t sin ( float64_t  x)
static

在文件 Math.h522 行定义.

static float64_t sinh ( float64_t  x)
static

asin(x), x being a complex128_t not implemented

在文件 Math.h538 行定义.

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

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

在文件 Math.cpp142 行定义.

static T sq ( x)
static

x^2

在文件 Math.h324 行定义.

static float32_t sqrt ( float32_t  x)
static

x^0.5

在文件 Math.h330 行定义.

static float64_t sqrt ( float64_t  x)
static

x^0.5

在文件 Math.h336 行定义.

static floatmax_t sqrt ( floatmax_t  x)
static

x^0.5

在文件 Math.h342 行定义.

bool strtod ( const char *  str,
float64_t double_result 
)
static

在文件 Math.cpp295 行定义.

bool strtof ( const char *  str,
float32_t float_result 
)
static

在文件 Math.cpp264 行定义.

bool strtold ( const char *  str,
floatmax_t long_double_result 
)
static

在文件 Math.cpp326 行定义.

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

swap e.g. floats a and b

在文件 Math.h314 行定义.

static float64_t tan ( float64_t  x)
static

exp(x), x being a complex128_t

返回
tangens of input

在文件 Math.h453 行定义.

static float64_t tanh ( float64_t  x)
static

atan2(x), x being a complex128_t not implemented

返回
tangens hyperbolicus of input

在文件 Math.h480 行定义.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

在文件 SGObject.cpp250 行定义.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

在文件 SGObject.cpp196 行定义.

类成员变量说明

const float64_t ALMOST_INFTY = +1e+300
static

在文件 Math.h1416 行定义.

const float64_t ALMOST_NEG_INFTY = -1e+300
static

almost neg (log) infinity

在文件 Math.h1419 行定义.

const float32_t F_MAX_VAL32 =FLT_MAX
static

在文件 Math.h1432 行定义.

const float64_t F_MAX_VAL64 =DBL_MAX
static

在文件 Math.h1434 行定义.

const float32_t F_MIN_NORM_VAL32 =FLT_MIN
static

在文件 Math.h1433 行定义.

const float64_t F_MIN_NORM_VAL64 =DBL_MIN
static

在文件 Math.h1435 行定义.

const float32_t F_MIN_VAL32 =(FLT_MIN * FLT_EPSILON)
static

在文件 Math.h1438 行定义.

const float64_t F_MIN_VAL64 =(DBL_MIN * DBL_EPSILON)
static

在文件 Math.h1439 行定义.

const float64_t INFTY = INFINITY
static

infinity

在文件 Math.h1415 行定义.

SGIO* io
inherited

io

在文件 SGObject.h461 行定义.

int32_t LOGRANGE = 0
staticprotected

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

在文件 Math.h1443 行定义.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

在文件 SGObject.h476 行定义.

uint32_t m_hash
inherited

Hash of parameter values

在文件 SGObject.h482 行定义.

Parameter* m_model_selection_parameters
inherited

model selection parameters

在文件 SGObject.h473 行定义.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

在文件 SGObject.h479 行定义.

Parameter* m_parameters
inherited

parameters

在文件 SGObject.h470 行定义.

const float64_t MACHINE_EPSILON =DBL_EPSILON
static

machine epsilon for float64_t

在文件 Math.h1425 行定义.

const float64_t MAX_REAL_NUMBER =DBL_MAX
static

在文件 Math.h1428 行定义.

const float64_t MIN_REAL_NUMBER =DBL_MIN
static

在文件 Math.h1429 行定义.

const float64_t NOT_A_NUMBER = NAN
static

not a number

在文件 Math.h1413 行定义.

Parallel* parallel
inherited

parallel

在文件 SGObject.h464 行定义.

const float64_t PI =M_PI
static

the number pi

在文件 Math.h1422 行定义.

uint32_t seed = 0
staticprotected

random generator seed

在文件 Math.h1446 行定义.

Version* version
inherited

version

在文件 SGObject.h467 行定义.


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

SHOGUN 机器学习工具包 - 项目文档