SHOGUN  v3.2.0
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions
CMath Class Reference

Detailed Description

Class which collects generic mathematical functions.

Definition at line 133 of file Math.h.

Inheritance diagram for CMath:
Inheritance graph
[legend]

Public Member Functions

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 bool update_parameter_hash ()
 
virtual bool equals (CSGObject *other, float64_t accuracy=0.0)
 
virtual CSGObjectclone ()
 
Constructor/Destructor.
 CMath ()
 Constructor - initializes log-table. More...
 
virtual ~CMath ()
 Destructor - frees logtable. More...
 

Static Public Member Functions

static float64_t real (complex128_t c)
 returns real part of a complex128_t number More...
 
static float64_t imag (complex128_t c)
 returns imag part of a complex128_t number More...
 
static uint32_t get_seed ()
 returns number generator seed More...
 
static uint32_t get_log_range ()
 returns range of logtable More...
 
static int is_finite (double f)
 checks whether a float is finite More...
 
static int is_infinity (double f)
 checks whether a float is infinity More...
 
static int is_nan (double f)
 checks whether a float is nan More...
 
min/max/abs functions.
template<class T >
static T min (T a, T b)
 return the minimum of two integers More...
 
template<class T >
static T max (T a, T b)
 return the maximum of two integers More...
 
template<class T >
static T clamp (T value, T lb, T ub)
 return the value clamped to interval [lb,ub] More...
 
template<class T >
static T abs (T a)
 return the absolute value of a number More...
 
static float64_t abs (complex128_t a)
 return the absolute value of a complex number More...
 
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 More...
 
template<class T >
static void swap (T &a, T &b)
 swap e.g. floats a and b More...
 
template<class T >
static T sq (T x)
 x^2 More...
 
static float32_t sqrt (float32_t x)
 x^0.5 More...
 
static float64_t sqrt (float64_t x)
 x^0.5 More...
 
static floatmax_t sqrt (floatmax_t x)
 x^0.5 More...
 
static float32_t invsqrt (float32_t x)
 x^0.5, x being a complex128_t More...
 
static floatmax_t powl (floatmax_t x, floatmax_t n)
 x^n More...
 
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 More...
 
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 More...
 
static float64_t atan (float64_t x)
 tan(x), x being a complex128_t More...
 
static float64_t atan2 (float64_t x, float64_t y)
 atan(x), x being a complex128_t not implemented More...
 
static float64_t tanh (float64_t x)
 atan2(x), x being a complex128_t not implemented More...
 
static float64_t log10 (float64_t v)
 tanh(x), x being a complex128_t More...
 
static float64_t log2 (float64_t v)
 log10(x), x being a complex128_t More...
 
static float64_t log (float64_t v)
 
static index_t floor_log (index_t n)
 log(x), x being a complex128_t More...
 
static float64_t sin (float64_t x)
 
static float64_t asin (float64_t x)
 sin(x), x being a complex128_t More...
 
static float64_t sinh (float64_t x)
 asin(x), x being a complex128_t not implemented More...
 
static float64_t cos (float64_t x)
 sinh(x), x being a complex128_t More...
 
static float64_t acos (float64_t x)
 cos(x), x being a complex128_t More...
 
static float64_t cosh (float64_t x)
 acos(x), x being a complex128_t not implemented More...
 
static float64_t area_under_curve (float64_t *xy, int32_t len, bool reversed)
 cosh(x), x being a complex128_t More...
 
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 More...
 
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 More...
 
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 More...
 
template<class T >
static void display_bits (T word, int32_t width=8 *sizeof(T))
 display bits (useful for debugging) More...
 
static void display_bits (complex128_t word, int32_t width=8 *sizeof(complex128_t))
 disply_bits not implemented for complex128_t More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 Attributes

SGIOio
 
Parallelparallel
 
Versionversion
 
Parameterm_parameters
 
Parameterm_model_selection_parameters
 
Parameterm_gradient_parameters
 
ParameterMapm_parameter_map
 
uint32_t m_hash
 

Protected Member Functions

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 More...
 
static const float64_t INFTY = INFINITY
 infinity More...
 
static const float64_t ALMOST_INFTY = +1e+20
 
static const float64_t ALMOST_NEG_INFTY = -1000
 almost neg (log) infinity More...
 
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 More...
 
static uint32_t seed = 0
 random generator seed More...
 

Constructor & Destructor Documentation

◆ CMath()

CMath ( )

Constructor - initializes log-table.

Definition at line 59 of file Math.cpp.

◆ ~CMath()

~CMath ( )
virtual

Destructor - frees logtable.

Definition at line 76 of file Math.cpp.

Member Function Documentation

◆ abs() [1/2]

static T abs ( a)
static

return the absolute value of a number

Definition at line 179 of file Math.h.

◆ abs() [2/2]

static float64_t abs ( complex128_t  a)
static

return the absolute value of a complex number

Definition at line 192 of file Math.h.

◆ acos()

static float64_t acos ( float64_t  x)
static

cos(x), x being a complex128_t

Definition at line 469 of file Math.h.

◆ Align()

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

Definition at line 154 of file Math.cpp.

◆ area_under_curve()

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

cosh(x), x being a complex128_t

Definition at line 485 of file Math.h.

◆ asin()

static float64_t asin ( float64_t  x)
static

sin(x), x being a complex128_t

Definition at line 445 of file Math.h.

◆ atan()

static float64_t atan ( float64_t  x)
static

tan(x), x being a complex128_t

Returns
arcus tangens of input

Definition at line 377 of file Math.h.

◆ atan2()

static float64_t atan2 ( float64_t  x,
float64_t  y 
)
static

atan(x), x being a complex128_t not implemented

Returns
arcus tangens of input

Definition at line 386 of file Math.h.

◆ binary_search() [1/4]

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

Definition at line 1108 of file Math.h.

◆ binary_search() [2/4]

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

binary_search not implemented for complex128_t

Definition at line 1117 of file Math.h.

◆ binary_search() [3/4]

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

Definition at line 1132 of file Math.h.

◆ binary_search() [4/4]

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

binary_search not implemented for complex128_t

Definition at line 1163 of file Math.h.

◆ binary_search_helper() [1/2]

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

Definition at line 1075 of file Math.h.

◆ binary_search_helper() [2/2]

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

binary_search_helper not implemented for complex128_t

Definition at line 1099 of file Math.h.

◆ binary_search_max_lower_equal() [1/2]

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

Definition at line 1170 of file Math.h.

◆ binary_search_max_lower_equal() [2/2]

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

Definition at line 1183 of file Math.h.

◆ build_gradient_parameter_dictionary()

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.

Parameters
dictdictionary of parameters to be built.

Definition at line 1156 of file SGObject.cpp.

◆ byte() [1/2]

static uint8_t byte ( word,
uint16_t  p 
)
static

Definition at line 782 of file Math.h.

◆ byte() [2/2]

static uint8_t byte ( complex128_t  word,
uint16_t  p 
)
static

byte not implemented for complex128_t

Definition at line 788 of file Math.h.

◆ ceil()

static float64_t ceil ( float64_t  d)
static

Definition at line 213 of file Math.h.

◆ clamp()

static T clamp ( value,
lb,
ub 
)
static

return the value clamped to interval [lb,ub]

Definition at line 167 of file Math.h.

◆ clone()

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.

Returns
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

Definition at line 1273 of file SGObject.cpp.

◆ cos()

static float64_t cos ( float64_t  x)
static

sinh(x), x being a complex128_t

Definition at line 461 of file Math.h.

◆ cosh()

static float64_t cosh ( float64_t  x)
static

acos(x), x being a complex128_t not implemented

Definition at line 477 of file Math.h.

◆ deep_copy()

virtual CSGObject* deep_copy ( ) const
virtualinherited

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

Definition at line 126 of file SGObject.h.

◆ display_bits() [1/2]

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

display bits (useful for debugging)

Definition at line 954 of file Math.h.

◆ display_bits() [2/2]

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

disply_bits not implemented for complex128_t

Definition at line 973 of file Math.h.

◆ equals()

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.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
Returns
true if all parameters were equal, false if not

Definition at line 1177 of file SGObject.cpp.

◆ exp()

static float64_t exp ( float64_t  x)
static

Definition at line 359 of file Math.h.

◆ factorial()

static int64_t factorial ( int32_t  n)
static

Definition at line 509 of file Math.h.

◆ floor()

static float64_t floor ( float64_t  d)
static

Definition at line 208 of file Math.h.

◆ floor_log()

static index_t floor_log ( index_t  n)
static

log(x), x being a complex128_t

Definition at line 428 of file Math.h.

◆ get_global_io()

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 174 of file SGObject.cpp.

◆ get_global_parallel()

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 209 of file SGObject.cpp.

◆ get_global_version()

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 222 of file SGObject.cpp.

◆ get_log_range()

static uint32_t get_log_range ( )
static

returns range of logtable

Definition at line 1218 of file Math.h.

◆ get_modelsel_names()

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

Definition at line 1060 of file SGObject.cpp.

◆ get_modsel_param_descr()

char * get_modsel_param_descr ( const char *  param_name)
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
param_namename of the parameter
Returns
description of the parameter

Definition at line 1084 of file SGObject.cpp.

◆ get_modsel_param_index()

index_t get_modsel_param_index ( const char *  param_name)
inherited

Returns index of model selection parameter with provided index

Parameters
param_namename of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1097 of file SGObject.cpp.

◆ get_name()

virtual const char* get_name ( ) const
virtual
Returns
object name

Implements CSGObject.

Definition at line 1323 of file Math.h.

◆ get_num_nonzero() [1/2]

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

Definition at line 613 of file Math.h.

◆ get_num_nonzero() [2/2]

static int32_t get_num_nonzero ( complex128_t vec,
int32_t  len 
)
static

Definition at line 622 of file Math.h.

◆ get_seed()

static uint32_t get_seed ( )
static

returns number generator seed

Definition at line 1212 of file Math.h.

◆ imag()

static float64_t imag ( complex128_t  c)
static

returns imag part of a complex128_t number

Definition at line 1206 of file Math.h.

◆ init_random()

static void init_random ( uint32_t  initseed = 0)
static

Definition at line 517 of file Math.h.

◆ insertion_sort()

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)

Definition at line 754 of file Math.h.

◆ invsqrt()

static float32_t invsqrt ( float32_t  x)
static

x^0.5, x being a complex128_t

x^-0.5

Definition at line 272 of file Math.h.

◆ is_finite()

int is_finite ( double  f)
static

checks whether a float is finite

Definition at line 243 of file Math.cpp.

◆ is_generic()

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.

Parameters
genericset to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 228 of file SGObject.cpp.

◆ is_infinity()

int is_infinity ( double  f)
static

checks whether a float is infinity

Definition at line 224 of file Math.cpp.

◆ is_nan()

int is_nan ( double  f)
static

checks whether a float is nan

Definition at line 211 of file Math.cpp.

◆ linspace()

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.

Parameters
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

Definition at line 197 of file Math.cpp.

◆ load_all_file_parameters()

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)

Parameters
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
Returns
(sorted) array of created TParameter instances with file data

Definition at line 633 of file SGObject.cpp.

◆ load_file_parameters()

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

Parameters
param_infoinformation of parameter
file_versionparameter version of the file, must be <= provided parameter version
filefile to load from
prefixprefix for members
Returns
new array with TParameter instances with the attached data

Definition at line 474 of file SGObject.cpp.

◆ load_serializable()

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!

Parameters
filewhere to load from
prefixprefix for members
param_version(optional) a parameter version different to (this is mainly for testing, better do not use)
Returns
TRUE if done, otherwise FALSE

Definition at line 305 of file SGObject.cpp.

◆ load_serializable_post()

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.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CWeightedDegreePositionStringKernel, CKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.

Definition at line 989 of file SGObject.cpp.

◆ load_serializable_pre()

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.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 984 of file SGObject.cpp.

◆ log()

static float64_t log ( float64_t  v)
static

Definition at line 420 of file Math.h.

◆ log10()

static float64_t log10 ( float64_t  v)
static

tanh(x), x being a complex128_t

Definition at line 403 of file Math.h.

◆ log2()

static float64_t log2 ( float64_t  v)
static

log10(x), x being a complex128_t

Definition at line 411 of file Math.h.

◆ log_mean_exp()

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.

Parameters
valuesthe vector of \(x_i\)
Returns
\(\log(\frac{1}{n}\sum_{i=1}^n \exp(x_i))\)

Definition at line 698 of file Math.h.

◆ log_sum_exp()

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.

Parameters
valuesthe vector of \(x_i\)
Returns
\(\log(\sum_{i=1}^n \exp(x_i))\) for given \(x_i\)

Definition at line 656 of file Math.h.

◆ logarithmic_sum()

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

Definition at line 1278 of file Math.h.

◆ map_parameters()

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

Parameters
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

Definition at line 671 of file SGObject.cpp.

◆ max()

static T max ( a,
b 
)
static

return the maximum of two integers

Definition at line 160 of file Math.h.

◆ migrate()

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

Parameters
param_baseset of TParameter instances to use for migration
targetparameter info for the resulting TParameter
Returns
a new TParameter instance with migrated data from the base of the type which is specified by the target parameter

Definition at line 878 of file SGObject.cpp.

◆ min() [1/3]

static T min ( a,
b 
)
static

return the minimum of two integers

Definition at line 153 of file Math.h.

◆ min() [2/3]

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

Definition at line 1574 of file Math.h.

◆ min() [3/3]

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

complex128_t cannot be used as index

Definition at line 1052 of file Math.h.

◆ nchoosek()

static int64_t nchoosek ( int32_t  n,
int32_t  k 
)
static

Definition at line 630 of file Math.h.

◆ nmin() [1/2]

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

Definition at line 1563 of file Math.h.

◆ nmin() [2/2]

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

complex128_t cannot be used as index

Definition at line 1064 of file Math.h.

◆ normal_random() [1/2]

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

Definition at line 570 of file Math.h.

◆ normal_random() [2/2]

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

Definition at line 593 of file Math.h.

◆ one_to_one_migration_prepare()

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)

Parameters
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

Definition at line 818 of file SGObject.cpp.

◆ parallel_qsort_index() [1/3]

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

Definition at line 1020 of file Math.h.

◆ parallel_qsort_index() [2/3]

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

Definition at line 1035 of file Math.h.

◆ parallel_qsort_index() [3/3]

void * parallel_qsort_index ( void *  p)
static

Definition at line 1365 of file Math.h.

◆ pow() [1/8]

static int32_t pow ( bool  x,
int32_t  n 
)
static

Definition at line 304 of file Math.h.

◆ pow() [2/8]

static int32_t pow ( int32_t  x,
int32_t  n 
)
static

Definition at line 309 of file Math.h.

◆ pow() [3/8]

static float64_t pow ( float64_t  x,
int32_t  n 
)
static

Definition at line 319 of file Math.h.

◆ pow() [4/8]

static float64_t pow ( float64_t  x,
float64_t  n 
)
static

Definition at line 333 of file Math.h.

◆ pow() [5/8]

static complex128_t pow ( complex128_t  x,
int32_t  n 
)
static

x^n, x or n being a complex128_t

Definition at line 339 of file Math.h.

◆ pow() [6/8]

static complex128_t pow ( complex128_t  x,
complex128_t  n 
)
static

Definition at line 344 of file Math.h.

◆ pow() [7/8]

static complex128_t pow ( complex128_t  x,
float64_t  n 
)
static

Definition at line 349 of file Math.h.

◆ pow() [8/8]

static complex128_t pow ( float64_t  x,
complex128_t  n 
)
static

Definition at line 354 of file Math.h.

◆ powl()

static floatmax_t powl ( floatmax_t  x,
floatmax_t  n 
)
static

x^n

Definition at line 293 of file Math.h.

◆ print_modsel_params()

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1036 of file SGObject.cpp.

◆ print_serializable()

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 240 of file SGObject.cpp.

◆ qsort() [1/3]

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)

Definition at line 712 of file Math.h.

◆ qsort() [2/3]

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

Parameters
vectorarray of pointers to sort
lengthlength of array

Definition at line 909 of file Math.h.

◆ qsort() [3/3]

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

qsort not implemented for complex128_t

Definition at line 948 of file Math.h.

◆ qsort_backward_index()

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)

Definition at line 1518 of file Math.h.

◆ qsort_backword_index()

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

qsort_backword_index not implemented for complex128_t

Definition at line 1005 of file Math.h.

◆ qsort_index() [1/2]

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)

Definition at line 1474 of file Math.h.

◆ qsort_index() [2/2]

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

qsort_index not implemented for complex128_t

Definition at line 989 of file Math.h.

◆ radix_sort()

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

performs a in-place radix sort in ascending order

Definition at line 771 of file Math.h.

◆ radix_sort_helper() [1/2]

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

Definition at line 795 of file Math.h.

◆ radix_sort_helper() [2/2]

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

radix_sort_helper not implemented for complex128_t

Definition at line 894 of file Math.h.

◆ randn_double()

static float64_t randn_double ( )
static

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

Definition at line 607 of file Math.h.

◆ randn_float()

static float32_t randn_float ( )
static

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

Definition at line 600 of file Math.h.

◆ random() [1/8]

static uint64_t random ( )
static

Definition at line 527 of file Math.h.

◆ random() [2/8]

static uint64_t random ( uint64_t  min_value,
uint64_t  max_value 
)
static

Definition at line 532 of file Math.h.

◆ random() [3/8]

static int64_t random ( int64_t  min_value,
int64_t  max_value 
)
static

Definition at line 537 of file Math.h.

◆ random() [4/8]

static uint32_t random ( uint32_t  min_value,
uint32_t  max_value 
)
static

Definition at line 542 of file Math.h.

◆ random() [5/8]

static int32_t random ( int32_t  min_value,
int32_t  max_value 
)
static

Definition at line 547 of file Math.h.

◆ random() [6/8]

static float32_t random ( float32_t  min_value,
float32_t  max_value 
)
static

Definition at line 552 of file Math.h.

◆ random() [7/8]

static float64_t random ( float64_t  min_value,
float64_t  max_value 
)
static

Definition at line 557 of file Math.h.

◆ random() [8/8]

static floatmax_t random ( floatmax_t  min_value,
floatmax_t  max_value 
)
static

Definition at line 562 of file Math.h.

◆ real()

static float64_t real ( complex128_t  c)
static

returns real part of a complex128_t number

Definition at line 1200 of file Math.h.

◆ round()

static float64_t round ( float64_t  d)
static

Definition at line 203 of file Math.h.

◆ save_serializable()

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

Save this object to file.

Parameters
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)
Returns
TRUE if done, otherwise FALSE

Definition at line 246 of file SGObject.cpp.

◆ save_serializable_post()

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.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 999 of file SGObject.cpp.

◆ save_serializable_pre()

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.

Exceptions
ShogunExceptionWill be thrown if an error occurres.

Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, and CDynamicObjectArray.

Definition at line 994 of file SGObject.cpp.

◆ set_generic() [1/16]

void set_generic ( )
inherited

Definition at line 41 of file SGObject.cpp.

◆ set_generic() [2/16]

void set_generic ( )
inherited

Definition at line 46 of file SGObject.cpp.

◆ set_generic() [3/16]

void set_generic ( )
inherited

Definition at line 51 of file SGObject.cpp.

◆ set_generic() [4/16]

void set_generic ( )
inherited

Definition at line 56 of file SGObject.cpp.

◆ set_generic() [5/16]

void set_generic ( )
inherited

Definition at line 61 of file SGObject.cpp.

◆ set_generic() [6/16]

void set_generic ( )
inherited

Definition at line 66 of file SGObject.cpp.

◆ set_generic() [7/16]

void set_generic ( )
inherited

Definition at line 71 of file SGObject.cpp.

◆ set_generic() [8/16]

void set_generic ( )
inherited

Definition at line 76 of file SGObject.cpp.

◆ set_generic() [9/16]

void set_generic ( )
inherited

Definition at line 81 of file SGObject.cpp.

◆ set_generic() [10/16]

void set_generic ( )
inherited

Definition at line 86 of file SGObject.cpp.

◆ set_generic() [11/16]

void set_generic ( )
inherited

Definition at line 91 of file SGObject.cpp.

◆ set_generic() [12/16]

void set_generic ( )
inherited

Definition at line 96 of file SGObject.cpp.

◆ set_generic() [13/16]

void set_generic ( )
inherited

Definition at line 101 of file SGObject.cpp.

◆ set_generic() [14/16]

void set_generic ( )
inherited

Definition at line 106 of file SGObject.cpp.

◆ set_generic() [15/16]

void set_generic ( )
inherited

Definition at line 111 of file SGObject.cpp.

◆ set_generic() [16/16]

void set_generic ( )
inherited

set generic type to T

◆ set_global_io()

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 167 of file SGObject.cpp.

◆ set_global_parallel()

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 180 of file SGObject.cpp.

◆ set_global_version()

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 215 of file SGObject.cpp.

◆ shallow_copy()

virtual CSGObject* shallow_copy ( ) const
virtualinherited

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

Reimplemented in CGaussianKernel.

Definition at line 117 of file SGObject.h.

◆ sign()

static T sign ( a)
static

signum of type T variable a

Definition at line 220 of file Math.h.

◆ sin()

static float64_t sin ( float64_t  x)
static

Definition at line 437 of file Math.h.

◆ sinh()

static float64_t sinh ( float64_t  x)
static

asin(x), x being a complex128_t not implemented

Definition at line 453 of file Math.h.

◆ sort() [1/2]

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

Definition at line 115 of file Math.cpp.

◆ sort() [2/2]

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

Definition at line 135 of file Math.cpp.

◆ sq()

static T sq ( x)
static

x^2

Definition at line 239 of file Math.h.

◆ sqrt() [1/3]

static float32_t sqrt ( float32_t  x)
static

x^0.5

Definition at line 245 of file Math.h.

◆ sqrt() [2/3]

static float64_t sqrt ( float64_t  x)
static

x^0.5

Definition at line 251 of file Math.h.

◆ sqrt() [3/3]

static floatmax_t sqrt ( floatmax_t  x)
static

x^0.5

Definition at line 257 of file Math.h.

◆ strtod()

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

Definition at line 289 of file Math.cpp.

◆ strtof()

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

Definition at line 258 of file Math.cpp.

◆ strtold()

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

Definition at line 320 of file Math.cpp.

◆ swap()

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

swap e.g. floats a and b

Definition at line 229 of file Math.h.

◆ tan()

static float64_t tan ( float64_t  x)
static

exp(x), x being a complex128_t

Returns
tangens of input

Definition at line 368 of file Math.h.

◆ tanh()

static float64_t tanh ( float64_t  x)
static

atan2(x), x being a complex128_t not implemented

Returns
tangens hyperbolicus of input

Definition at line 395 of file Math.h.

◆ unset_generic()

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 235 of file SGObject.cpp.

◆ update_parameter_hash()

bool update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination.

Returns
bool if parameter combination has changed since last update.

Definition at line 187 of file SGObject.cpp.

Member Data Documentation

◆ ALMOST_INFTY

const float64_t ALMOST_INFTY = +1e+20
static

Definition at line 1331 of file Math.h.

◆ ALMOST_NEG_INFTY

const float64_t ALMOST_NEG_INFTY = -1000
static

almost neg (log) infinity

Definition at line 1334 of file Math.h.

◆ INFTY

const float64_t INFTY = INFINITY
static

infinity

Definition at line 1330 of file Math.h.

◆ io

SGIO* io
inherited

io

Definition at line 473 of file SGObject.h.

◆ LOGRANGE

int32_t LOGRANGE = 0
staticprotected

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

Definition at line 1348 of file Math.h.

◆ m_gradient_parameters

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 488 of file SGObject.h.

◆ m_hash

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 494 of file SGObject.h.

◆ m_model_selection_parameters

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 485 of file SGObject.h.

◆ m_parameter_map

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 491 of file SGObject.h.

◆ m_parameters

Parameter* m_parameters
inherited

parameters

Definition at line 482 of file SGObject.h.

◆ MACHINE_EPSILON

const float64_t MACHINE_EPSILON =5E-16
static

machine epsilon for float64_t

Definition at line 1340 of file Math.h.

◆ MAX_REAL_NUMBER

const float64_t MAX_REAL_NUMBER =1E300
static

Definition at line 1343 of file Math.h.

◆ MIN_REAL_NUMBER

const float64_t MIN_REAL_NUMBER =1E-300
static

Definition at line 1344 of file Math.h.

◆ NOT_A_NUMBER

const float64_t NOT_A_NUMBER = NAN
static

not a number

Definition at line 1328 of file Math.h.

◆ parallel

Parallel* parallel
inherited

parallel

Definition at line 476 of file SGObject.h.

◆ PI

const float64_t PI =M_PI
static

the number pi

Definition at line 1337 of file Math.h.

◆ seed

uint32_t seed = 0
staticprotected

random generator seed

Definition at line 1351 of file Math.h.

◆ version

Version* version
inherited

version

Definition at line 479 of file SGObject.h.


The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation