SHOGUN  3.2.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 136 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 ()
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.

Static Public Member Functions

template<class T >
static int32_t arg_max (T *vec, int32_t inc, int32_t len, T *maxv_ptr=NULL)
template<class T >
static int32_t arg_min (T *vec, int32_t inc, int32_t len, T *minv_ptr=NULL)
 return arg_min(vec)
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 min (T *vec, int32_t len)
 return the smallest element in a vector.
template<class T >
static T max (T *vec, int32_t len)
 return the greatest element in a vector.
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 void permute (SGVector< T > v, CRandom *rand=NULL)
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 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
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

Constructor & Destructor Documentation

CMath ( )

Constructor - initializes log-table.

Definition at line 66 of file Math.cpp.

~CMath ( )
virtual

Destructor - frees logtable.

Definition at line 83 of file Math.cpp.

Member Function Documentation

static T abs ( a)
static

return the absolute value of a number

Definition at line 210 of file Math.h.

static float64_t abs ( complex128_t  a)
static

return the absolute value of a complex number

Definition at line 223 of file Math.h.

static float64_t acos ( float64_t  x)
static

cos(x), x being a complex128_t

Definition at line 625 of file Math.h.

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 161 of file Math.cpp.

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 641 of file Math.h.

static int32_t arg_max ( T *  vec,
int32_t  inc,
int32_t  len,
T *  maxv_ptr = NULL 
)
static
Returns
arg_max(vec)

Definition at line 233 of file Math.h.

static int32_t arg_min ( T *  vec,
int32_t  inc,
int32_t  len,
T *  minv_ptr = NULL 
)
static

return arg_min(vec)

Returns
arg_min(vec)

Definition at line 255 of file Math.h.

static float64_t asin ( float64_t  x)
static

sin(x), x being a complex128_t

Definition at line 601 of file Math.h.

static float64_t atan ( float64_t  x)
static

tan(x), x being a complex128_t

Returns
arcus tangens of input

Definition at line 533 of file Math.h.

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 542 of file Math.h.

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

Definition at line 1286 of file Math.h.

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 1295 of file Math.h.

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

Definition at line 1310 of file Math.h.

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 1341 of file Math.h.

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

Definition at line 1253 of file Math.h.

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 1277 of file Math.h.

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

Definition at line 1348 of file Math.h.

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 1361 of file Math.h.

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 1243 of file SGObject.cpp.

static uint8_t byte ( word,
uint16_t  p 
)
static

Definition at line 960 of file Math.h.

static uint8_t byte ( complex128_t  word,
uint16_t  p 
)
static

byte not implemented for complex128_t

Definition at line 966 of file Math.h.

static float64_t ceil ( float64_t  d)
static

Definition at line 370 of file Math.h.

static T clamp ( value,
lb,
ub 
)
static

return the value clamped to interval [lb,ub]

Definition at line 198 of file Math.h.

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 1360 of file SGObject.cpp.

static float64_t cos ( float64_t  x)
static

sinh(x), x being a complex128_t

Definition at line 617 of file Math.h.

static float64_t cosh ( float64_t  x)
static

acos(x), x being a complex128_t not implemented

Definition at line 633 of file Math.h.

CSGObject * deep_copy ( ) const
virtualinherited

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

Definition at line 200 of file SGObject.cpp.

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

display bits (useful for debugging)

Definition at line 1132 of file Math.h.

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 1151 of file Math.h.

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.

Parameters
otherobject to compare with
accuracyaccuracy to use for comparison (optional)
tolerantallows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 1264 of file SGObject.cpp.

static float64_t exp ( float64_t  x)
static

Definition at line 515 of file Math.h.

static int64_t factorial ( int32_t  n)
static

Definition at line 665 of file Math.h.

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/

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

Definition at line 301 of file Math.h.

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

Parameters
afirst value to compare
bsecond value to compare
epsthreshold for values to be equal/different
Returns
true if values are equal within eps accuracy, false if not.

Definition at line 284 of file Math.h.

static float64_t floor ( float64_t  d)
static

Definition at line 365 of file Math.h.

static index_t floor_log ( index_t  n)
static

log(x), x being a complex128_t

Definition at line 584 of file Math.h.

float64_t get_abs_tolorance ( float64_t  true_value,
float64_t  rel_tolorance 
)
static

Definition at line 364 of file Math.cpp.

SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 237 of file SGObject.cpp.

Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 278 of file SGObject.cpp.

Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 291 of file SGObject.cpp.

static uint32_t get_log_range ( )
static

returns range of logtable

Definition at line 1396 of file Math.h.

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

Definition at line 1135 of file SGObject.cpp.

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 1159 of file SGObject.cpp.

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 1172 of file SGObject.cpp.

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

Implements CSGObject.

Definition at line 1501 of file Math.h.

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

Definition at line 790 of file Math.h.

static int32_t get_num_nonzero ( complex128_t vec,
int32_t  len 
)
static

Definition at line 799 of file Math.h.

static uint32_t get_seed ( )
static

returns number generator seed

Definition at line 1390 of file Math.h.

static float64_t imag ( complex128_t  c)
static

returns imag part of a complex128_t number

Definition at line 1384 of file Math.h.

static void init_random ( uint32_t  initseed = 0)
static

Definition at line 673 of file Math.h.

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 932 of file Math.h.

static float32_t invsqrt ( float32_t  x)
static

x^0.5, x being a complex128_t

x^-0.5

Definition at line 428 of file Math.h.

int is_finite ( double  f)
static

checks whether a float is finite

Definition at line 249 of file Math.cpp.

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 297 of file SGObject.cpp.

int is_infinity ( double  f)
static

checks whether a float is infinity

Definition at line 230 of file Math.cpp.

int is_nan ( double  f)
static

checks whether a float is nan

Definition at line 217 of file Math.cpp.

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 204 of file Math.cpp.

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 704 of file SGObject.cpp.

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 545 of file SGObject.cpp.

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 374 of file SGObject.cpp.

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

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

Definition at line 1062 of file SGObject.cpp.

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

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

Definition at line 1057 of file SGObject.cpp.

static float64_t log ( float64_t  v)
static

Definition at line 576 of file Math.h.

static float64_t log10 ( float64_t  v)
static

tanh(x), x being a complex128_t

Definition at line 559 of file Math.h.

static float64_t log2 ( float64_t  v)
static

log10(x), x being a complex128_t

Definition at line 567 of file Math.h.

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 876 of file Math.h.

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 833 of file Math.h.

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 1456 of file Math.h.

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 742 of file SGObject.cpp.

static T max ( a,
b 
)
static

return the maximum of two integers

Definition at line 163 of file Math.h.

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

return the greatest element in a vector.

Returns
max(vec)

Definition at line 185 of file Math.h.

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 949 of file SGObject.cpp.

static T min ( a,
b 
)
static

return the minimum of two integers

Definition at line 156 of file Math.h.

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

return the smallest element in a vector.

Returns
min(vec)

Definition at line 171 of file Math.h.

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

Definition at line 1762 of file Math.h.

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

complex128_t cannot be used as index

Definition at line 1230 of file Math.h.

static int64_t nchoosek ( int32_t  n,
int32_t  k 
)
static

Definition at line 807 of file Math.h.

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

Definition at line 1751 of file Math.h.

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 1242 of file Math.h.

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 726 of file Math.h.

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 749 of file Math.h.

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 889 of file SGObject.cpp.

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 1198 of file Math.h.

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 1213 of file Math.h.

void * parallel_qsort_index ( void *  p)
static

Definition at line 1553 of file Math.h.

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

Definition at line 263 of file SGObject.cpp.

static void permute ( SGVector< T >  v,
CRandom rand = NULL 
)
static

Permute randomly the elements of the vector. If provided, use the random object to generate the permutations.

Parameters
vthe vector to permute.
randrandom object that might be used to generate the permutations.

Definition at line 775 of file Math.h.

static int32_t pow ( bool  x,
int32_t  n 
)
static

Definition at line 460 of file Math.h.

static int32_t pow ( int32_t  x,
int32_t  n 
)
static

Definition at line 465 of file Math.h.

static float64_t pow ( float64_t  x,
int32_t  n 
)
static

Definition at line 475 of file Math.h.

static float64_t pow ( float64_t  x,
float64_t  n 
)
static

Definition at line 489 of file Math.h.

static complex128_t pow ( complex128_t  x,
int32_t  n 
)
static

x^n, x or n being a complex128_t

Definition at line 495 of file Math.h.

static complex128_t pow ( complex128_t  x,
complex128_t  n 
)
static

Definition at line 500 of file Math.h.

static complex128_t pow ( complex128_t  x,
float64_t  n 
)
static

Definition at line 505 of file Math.h.

static complex128_t pow ( float64_t  x,
complex128_t  n 
)
static

Definition at line 510 of file Math.h.

static floatmax_t powl ( floatmax_t  x,
floatmax_t  n 
)
static

x^n

Definition at line 449 of file Math.h.

void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 1111 of file SGObject.cpp.

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

prints registered parameters out

Parameters
prefixprefix for members

Definition at line 309 of file SGObject.cpp.

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 890 of file Math.h.

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 1087 of file Math.h.

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

qsort not implemented for complex128_t

Definition at line 1126 of file Math.h.

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 1706 of file Math.h.

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 1183 of file Math.h.

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 1662 of file Math.h.

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

qsort_index not implemented for complex128_t

Definition at line 1167 of file Math.h.

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

performs a in-place radix sort in ascending order

Definition at line 949 of file Math.h.

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

Definition at line 973 of file Math.h.

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 1072 of file Math.h.

static float64_t randn_double ( )
static

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

Definition at line 763 of file Math.h.

static float32_t randn_float ( )
static

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

Definition at line 756 of file Math.h.

static uint64_t random ( )
static

Definition at line 683 of file Math.h.

static uint64_t random ( uint64_t  min_value,
uint64_t  max_value 
)
static

Definition at line 688 of file Math.h.

static int64_t random ( int64_t  min_value,
int64_t  max_value 
)
static

Definition at line 693 of file Math.h.

static uint32_t random ( uint32_t  min_value,
uint32_t  max_value 
)
static

Definition at line 698 of file Math.h.

static int32_t random ( int32_t  min_value,
int32_t  max_value 
)
static

Definition at line 703 of file Math.h.

static float32_t random ( float32_t  min_value,
float32_t  max_value 
)
static

Definition at line 708 of file Math.h.

static float64_t random ( float64_t  min_value,
float64_t  max_value 
)
static

Definition at line 713 of file Math.h.

static floatmax_t random ( floatmax_t  min_value,
floatmax_t  max_value 
)
static

Definition at line 718 of file Math.h.

static float64_t real ( complex128_t  c)
static

returns real part of a complex128_t number

Definition at line 1378 of file Math.h.

static float64_t round ( float64_t  d)
static

Definition at line 360 of file Math.h.

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 315 of file SGObject.cpp.

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

Reimplemented in CKernel.

Definition at line 1072 of file SGObject.cpp.

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

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

Definition at line 1067 of file SGObject.cpp.

void set_generic< complex128_t > ( )
inherited

set generic type to T

Definition at line 42 of file SGObject.cpp.

void set_global_io ( SGIO io)
inherited

set the io object

Parameters
ioio object to use

Definition at line 230 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel)
inherited

set the parallel object

Parameters
parallelparallel object to use

Definition at line 243 of file SGObject.cpp.

void set_global_version ( Version version)
inherited

set the version object

Parameters
versionversion object to use

Definition at line 284 of file SGObject.cpp.

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 194 of file SGObject.cpp.

static T sign ( a)
static

signum of type T variable a

Definition at line 377 of file Math.h.

static float64_t sin ( float64_t  x)
static

Definition at line 593 of file Math.h.

static float64_t sinh ( float64_t  x)
static

asin(x), x being a complex128_t not implemented

Definition at line 609 of file Math.h.

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 122 of file Math.cpp.

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

Definition at line 142 of file Math.cpp.

static T sq ( x)
static

x^2

Definition at line 395 of file Math.h.

static float32_t sqrt ( float32_t  x)
static

x^0.5

Definition at line 401 of file Math.h.

static float64_t sqrt ( float64_t  x)
static

x^0.5

Definition at line 407 of file Math.h.

static floatmax_t sqrt ( floatmax_t  x)
static

x^0.5

Definition at line 413 of file Math.h.

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

Definition at line 295 of file Math.cpp.

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

Definition at line 264 of file Math.cpp.

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

Definition at line 326 of file Math.cpp.

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

swap e.g. floats a and b

Definition at line 386 of file Math.h.

static float64_t tan ( float64_t  x)
static

exp(x), x being a complex128_t

Returns
tangens of input

Definition at line 524 of file Math.h.

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 551 of file Math.h.

void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 304 of file SGObject.cpp.

void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 250 of file SGObject.cpp.

Member Data Documentation

const float64_t ALMOST_INFTY = +1e+300
static

Definition at line 1509 of file Math.h.

const float64_t ALMOST_NEG_INFTY = -1e+300
static

almost neg (log) infinity

Definition at line 1512 of file Math.h.

const float32_t F_MAX_VAL32 = FLT_MAX
static

Definition at line 1525 of file Math.h.

const float64_t F_MAX_VAL64 = DBL_MAX
static

Definition at line 1527 of file Math.h.

const float32_t F_MIN_NORM_VAL32 = FLT_MIN
static

Definition at line 1526 of file Math.h.

const float64_t F_MIN_NORM_VAL64 = DBL_MIN
static

Definition at line 1528 of file Math.h.

const float32_t F_MIN_VAL32 = (FLT_MIN * FLT_EPSILON)
static

Definition at line 1531 of file Math.h.

const float64_t F_MIN_VAL64 = (DBL_MIN * DBL_EPSILON)
static

Definition at line 1532 of file Math.h.

const float64_t INFTY = INFINITY
static

infinity

Definition at line 1508 of file Math.h.

SGIO* io
inherited

io

Definition at line 496 of file SGObject.h.

int32_t LOGRANGE = 0
staticprotected

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

Definition at line 1536 of file Math.h.

Parameter* m_gradient_parameters
inherited

parameters wrt which we can compute gradients

Definition at line 511 of file SGObject.h.

uint32_t m_hash
inherited

Hash of parameter values

Definition at line 517 of file SGObject.h.

Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 508 of file SGObject.h.

ParameterMap* m_parameter_map
inherited

map for different parameter versions

Definition at line 514 of file SGObject.h.

Parameter* m_parameters
inherited

parameters

Definition at line 505 of file SGObject.h.

const float64_t MACHINE_EPSILON = DBL_EPSILON
static

machine epsilon for float64_t

Definition at line 1518 of file Math.h.

const float64_t MAX_REAL_NUMBER = DBL_MAX
static

Definition at line 1521 of file Math.h.

const float64_t MIN_REAL_NUMBER = DBL_MIN
static

Definition at line 1522 of file Math.h.

const float64_t NOT_A_NUMBER = NAN
static

not a number

Definition at line 1506 of file Math.h.

Parallel* parallel
inherited

parallel

Definition at line 499 of file SGObject.h.

const float64_t PI = M_PI
static

the number pi

Definition at line 1515 of file Math.h.

uint32_t seed = 0
staticprotected

random generator seed

Definition at line 1539 of file Math.h.

Version* version
inherited

version

Definition at line 502 of file SGObject.h.


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

SHOGUN Machine Learning Toolbox - Documentation