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

Inheritance diagram for CMath:
Inheritance graph
[legend]

List of all members.

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_PARAMETER)
virtual bool load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=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_parameter_dictionary (CMap< TParameter *, CSGObject * > &dict)
Constructor/Destructor.

 CMath ()
 Constructor - initializes log-table.
virtual ~CMath ()
 Destructor - frees logtable.

Static Public Member Functions

static uint32_t get_seed ()
 returns number generator seed
static uint32_t get_log_range ()
 returns range of logtable
static int is_finite (double f)
 checks whether a float is finite
static int is_infinity (double f)
 checks whether a float is infinity
static int is_nan (double f)
 checks whether a float is nan
min/max/abs functions.

template<class T >
static T min (T a, T b)
 return the minimum of two integers
template<class T >
static T max (T a, T b)
 return the maximum of two integers
template<class T >
static T clamp (T value, T lb, T ub)
 return the value clamped to interval [lb,ub]
template<class T >
static T abs (T a)
 return the absolute value of a number
misc functions

static float64_t round (float64_t d)
static float64_t floor (float64_t d)
static float64_t ceil (float64_t d)
template<class T >
static T sign (T a)
 signum of type T variable a
template<class T >
static void swap (T &a, T &b)
 swap e.g. floats a and b
template<class T >
static T sq (T x)
 x^2
static float32_t sqrt (float32_t x)
 x^0.5
static float64_t sqrt (float64_t x)
 x^0.5
static floatmax_t sqrt (floatmax_t x)
 x^0.5
static float32_t invsqrt (float32_t x)
 x^-0.5
static floatmax_t powl (floatmax_t x, floatmax_t n)
 x^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 float64_t exp (float64_t x)
static float64_t atan (float64_t x)
static float64_t log10 (float64_t v)
static float64_t log2 (float64_t v)
static float64_t log (float64_t v)
static float64_t sin (float64_t x)
static float64_t cos (float64_t x)
static float64_t area_under_curve (float64_t *xy, int32_t len, bool reversed)
static int64_t factorial (int32_t n)
static void init_random (uint32_t initseed=0)
static int64_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 SGVector< int32_t > randperm_vec (int32_t n)
static int32_t * randperm (int32_t n)
static int64_t nchoosek (int32_t n, int32_t k)
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 radix_sort (T *array, int32_t size)
template<class T >
static uint8_t byte (T word, uint16_t p)
template<class T >
static void radix_sort_helper (T *array, int32_t size, uint16_t i)
template<class T >
static void insertion_sort (T *output, int32_t size)
template<class T >
static index_t find_position_to_insert (SGVector< T > vector, T element)
template<class T >
static void qsort (SGVector< T > vector)
template<class T >
static void qsort (T *output, int32_t size)
template<class T >
static void qsort (T **vector, index_t length)
template<class T >
static void display_bits (T word, int32_t width=8 *sizeof(T))
 display bits (useful for debugging)
template<class T1 , class T2 >
static void qsort_index (T1 *output, T2 *index, uint32_t size)
template<class T1 , class T2 >
static void qsort_backward_index (T1 *output, T2 *index, int32_t size)
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 T1 , class T2 >
static void * parallel_qsort_index (void *p)
template<class T >
static void min (float64_t *output, T *index, int32_t size)
template<class T >
static void nmin (float64_t *output, T *index, int32_t size, int32_t n)
template<class T >
static int32_t binary_search_helper (T *output, int32_t size, T elem)
template<class T >
static int32_t binary_search (T *output, int32_t size, T elem)
template<class T >
static int32_t binary_search (T **vector, index_t length, T *elem)
template<class T >
static int32_t binary_search_max_lower_equal (T *output, int32_t size, T elem)
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
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)
virtual bool update_parameter_hash ()

constants



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

Constructor & Destructor Documentation

CMath (  ) 

Constructor - initializes log-table.

Definition at line 50 of file Math.cpp.

~CMath (  )  [virtual]

Destructor - frees logtable.

Definition at line 70 of file Math.cpp.


Member Function Documentation

static T abs ( a  )  [static]

return the absolute value of a number

Definition at line 181 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 150 of file Math.cpp.

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

Definition at line 364 of file Math.h.

static float64_t atan ( float64_t  x  )  [static]
Returns:
arcus tangens of input

Definition at line 330 of file Math.h.

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

Definition at line 966 of file Math.h.

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

Definition at line 950 of file Math.h.

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

Definition at line 924 of file Math.h.

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

Definition at line 997 of file Math.h.

void build_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:
dict dictionary of parameters to be built.

Definition at line 1201 of file SGObject.cpp.

static uint8_t byte ( word,
uint16_t  p 
) [static]

Definition at line 603 of file Math.h.

static float64_t ceil ( float64_t  d  )  [static]

Definition at line 207 of file Math.h.

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

return the value clamped to interval [lb,ub]

Definition at line 169 of file Math.h.

static float64_t cos ( float64_t  x  )  [static]

Definition at line 359 of file Math.h.

virtual CSGObject* deep_copy (  )  const [virtual, inherited]

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

Definition at line 131 of file SGObject.h.

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

display bits (useful for debugging)

Definition at line 846 of file Math.h.

static float64_t exp ( float64_t  x  )  [static]

Definition at line 324 of file Math.h.

static int64_t factorial ( int32_t  n  )  [static]

Definition at line 384 of file Math.h.

static index_t find_position_to_insert ( SGVector< T >  vector,
element 
) [static]

For a sorted (ascending) vector, gets the index after the first element that is smaller than the given one

Parameters:
vector vector to find position in
element element to find index for
Returns:
index of the first element greater than given one

Definition at line 733 of file Math.h.

static float64_t floor ( float64_t  d  )  [static]

Definition at line 202 of file Math.h.

SGIO * get_global_io (  )  [inherited]

get the io object

Returns:
io object

Definition at line 224 of file SGObject.cpp.

Parallel * get_global_parallel (  )  [inherited]

get the parallel object

Returns:
parallel object

Definition at line 259 of file SGObject.cpp.

Version * get_global_version (  )  [inherited]

get the version object

Returns:
version object

Definition at line 272 of file SGObject.cpp.

static uint32_t get_log_range (  )  [static]

returns range of logtable

Definition at line 1024 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 1108 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_name name of the parameter
Returns:
description of the parameter

Definition at line 1132 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_name name of model selection parameter
Returns:
index of model selection parameter with provided name, -1 if there is no such

Definition at line 1145 of file SGObject.cpp.

virtual const char* get_name (  )  const [virtual]
Returns:
object name

Implements CSGObject.

Definition at line 1153 of file Math.h.

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

Definition at line 535 of file Math.h.

static uint32_t get_seed (  )  [static]

returns number generator seed

Definition at line 1018 of file Math.h.

static void init_random ( uint32_t  initseed = 0  )  [static]

Definition at line 392 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 710 of file Math.h.

static float32_t invsqrt ( float32_t  x  )  [static]

x^-0.5

Definition at line 263 of file Math.h.

static int is_finite ( double  f  )  [static]

checks whether a float is finite

Definition at line 1038 of file Math.h.

bool is_generic ( EPrimitiveType *  generic  )  const [virtual, inherited]

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

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

Definition at line 278 of file SGObject.cpp.

static int is_infinity ( double  f  )  [static]

checks whether a float is infinity

Definition at line 1048 of file Math.h.

static int is_nan ( double  f  )  [static]

checks whether a float is nan

Definition at line 1061 of file Math.h.

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_version parameter version of the file
current_version version from which mapping begins (you want to use VERSION_PARAMETER for this in most cases)
file file to load from
prefix prefix for members
Returns:
(sorted) array of created TParameter instances with file data

Definition at line 679 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_info information of parameter
file_version parameter version of the file, must be <= provided parameter version
file file to load from
prefix prefix for members
Returns:
new array with TParameter instances with the attached data

Definition at line 523 of file SGObject.cpp.

bool load_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

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

Reimplemented in CModelSelectionParameters.

Definition at line 354 of file SGObject.cpp.

void load_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

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

Definition at line 1033 of file SGObject.cpp.

void load_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

Definition at line 1028 of file SGObject.cpp.

static float64_t log ( float64_t  v  )  [static]

Definition at line 349 of file Math.h.

static float64_t log10 ( float64_t  v  )  [static]

Definition at line 335 of file Math.h.

static float64_t log2 ( float64_t  v  )  [static]

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

Definition at line 717 of file SGObject.cpp.

static T max ( a,
b 
) [static]

return the maximum of two integers

Definition at line 162 of file Math.h.

TParameter * migrate ( DynArray< TParameter * > *  param_base,
const SGParamInfo target 
) [protected, virtual, inherited]

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_base set of TParameter instances to use for migration
target parameter 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 923 of file SGObject.cpp.

static T min ( a,
b 
) [static]

return the minimum of two integers

Definition at line 155 of file Math.h.

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

Definition at line 1395 of file Math.h.

static int64_t nchoosek ( int32_t  n,
int32_t  k 
) [static]

Definition at line 573 of file Math.h.

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

Definition at line 1384 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 502 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 479 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 
) [protected, virtual, inherited]

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

Definition at line 864 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 889 of file Math.h.

void * parallel_qsort_index ( void *  p  )  [static]

Definition at line 1194 of file Math.h.

static int32_t pow ( int32_t  x,
int32_t  n 
) [static]

Definition at line 295 of file Math.h.

static float64_t pow ( float64_t  x,
int32_t  n 
) [static]

Definition at line 305 of file Math.h.

static float64_t pow ( float64_t  x,
float64_t  n 
) [static]

Definition at line 319 of file Math.h.

static floatmax_t powl ( floatmax_t  x,
floatmax_t  n 
) [static]

x^n

Definition at line 284 of file Math.h.

void print_modsel_params (  )  [inherited]

prints all parameter registered for model selection and their type

Definition at line 1084 of file SGObject.cpp.

void print_serializable ( const char *  prefix = ""  )  [virtual, inherited]

prints registered parameters out

Parameters:
prefix prefix for members

Definition at line 290 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 758 of file Math.h.

static void qsort ( SGVector< T >  vector  )  [static]

performs a quicksort on the given vector it is sorted from in ascending (for type T)

Parameters:
vector vector to sort

Definition at line 750 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:
vector array of pointers to sort
length length of array

Definition at line 807 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 1342 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 1298 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 597 of file Math.h.

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

Definition at line 609 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 529 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 522 of file Math.h.

static float64_t random ( float64_t  min_value,
float64_t  max_value 
) [static]

Definition at line 456 of file Math.h.

static uint32_t random ( uint32_t  min_value,
uint32_t  max_value 
) [static]

Definition at line 432 of file Math.h.

static int32_t random ( int32_t  min_value,
int32_t  max_value 
) [static]

Definition at line 439 of file Math.h.

static float32_t random ( float32_t  min_value,
float32_t  max_value 
) [static]

Definition at line 446 of file Math.h.

static uint64_t random ( uint64_t  min_value,
uint64_t  max_value 
) [static]

Definition at line 418 of file Math.h.

static floatmax_t random ( floatmax_t  min_value,
floatmax_t  max_value 
) [static]

Definition at line 466 of file Math.h.

static int64_t random (  )  [static]

Definition at line 409 of file Math.h.

static int64_t random ( int64_t  min_value,
int64_t  max_value 
) [static]

Definition at line 425 of file Math.h.

static int32_t* randperm ( int32_t  n  )  [static]

Returns a random permutation of number from 0 to n-1. Caller has to free memory.

Parameters:
n range of permutation
Returns:
random permutation of number from 0 to n-1

Definition at line 560 of file Math.h.

static SGVector<int32_t> randperm_vec ( int32_t  n  )  [static]

Returns a random permutation of number from 0 to n-1

Parameters:
n range of permutation
Returns:
random permutation of number from 0 to n-1

Definition at line 548 of file Math.h.

static float64_t round ( float64_t  d  )  [static]

Definition at line 197 of file Math.h.

bool save_serializable ( CSerializableFile file,
const char *  prefix = "",
int32_t  param_version = VERSION_PARAMETER 
) [virtual, inherited]

Save this object to file.

Parameters:
file where to save the object; will be closed during returning if PREFIX is an empty string.
prefix prefix for members
param_version (optional) a parameter version different to (this is mainly for testing, better do not use)
Returns:
TRUE if done, otherwise FALSE

Reimplemented in CModelSelectionParameters.

Definition at line 296 of file SGObject.cpp.

void save_serializable_post (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1043 of file SGObject.cpp.

void save_serializable_pre (  )  throw (ShogunException) [protected, virtual, inherited]

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:
ShogunException Will be thrown if an error occurres.

Reimplemented in CKernel.

Definition at line 1038 of file SGObject.cpp.

void set_generic< floatmax_t > (  )  [inherited]

set generic type to T

void set_global_io ( SGIO io  )  [inherited]

set the io object

Parameters:
io io object to use

Definition at line 217 of file SGObject.cpp.

void set_global_parallel ( Parallel parallel  )  [inherited]

set the parallel object

Parameters:
parallel parallel object to use

Definition at line 230 of file SGObject.cpp.

void set_global_version ( Version version  )  [inherited]

set the version object

Parameters:
version version object to use

Definition at line 265 of file SGObject.cpp.

virtual CSGObject* shallow_copy (  )  const [virtual, inherited]

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

Reimplemented in CGaussianKernel.

Definition at line 122 of file SGObject.h.

static T sign ( a  )  [static]

signum of type T variable a

Definition at line 214 of file Math.h.

static float64_t sin ( float64_t  x  )  [static]

Definition at line 354 of file Math.h.

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

Definition at line 131 of file Math.cpp.

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

static T sq ( x  )  [static]

x^2

Definition at line 233 of file Math.h.

static floatmax_t sqrt ( floatmax_t  x  )  [static]

x^0.5

Definition at line 251 of file Math.h.

static float32_t sqrt ( float32_t  x  )  [static]

x^0.5

Definition at line 239 of file Math.h.

static float64_t sqrt ( float64_t  x  )  [static]

x^0.5

Definition at line 245 of file Math.h.

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

swap e.g. floats a and b

Definition at line 223 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 285 of file SGObject.cpp.

bool update_parameter_hash (  )  [protected, virtual, inherited]

Updates the hash of current parameter combination.

Returns:
bool if parameter combination has changed since last update.

Definition at line 237 of file SGObject.cpp.


Member Data Documentation

const float64_t ALMOST_INFTY = +1e+20 [static]

Definition at line 1159 of file Math.h.

const float64_t ALMOST_NEG_INFTY = -1000 [static]

almost neg (log) infinity

Definition at line 1162 of file Math.h.

const float64_t INFTY = -log(0.0) [static]

infinity

Definition at line 1158 of file Math.h.

SGIO* io [inherited]

io

Definition at line 462 of file SGObject.h.

int32_t LOGRANGE = 0 [static, protected]

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

Definition at line 1176 of file Math.h.

uint32_t m_hash [inherited]

Hash of parameter values

Definition at line 480 of file SGObject.h.

model selection parameters

Definition at line 474 of file SGObject.h.

map for different parameter versions

Definition at line 477 of file SGObject.h.

Parameter* m_parameters [inherited]

parameters

Definition at line 471 of file SGObject.h.

const float64_t MACHINE_EPSILON = 5E-16 [static]

machine epsilon for float64_t

Definition at line 1168 of file Math.h.

const float64_t MAX_REAL_NUMBER = 1E300 [static]

Definition at line 1171 of file Math.h.

const float64_t MIN_REAL_NUMBER = 1E-300 [static]

Definition at line 1172 of file Math.h.

Parallel* parallel [inherited]

parallel

Definition at line 465 of file SGObject.h.

const float64_t PI = M_PI [static]

the number pi

Definition at line 1165 of file Math.h.

char * rand_state = NULL [static, protected]

Definition at line 1180 of file Math.h.

uint32_t seed = 0 [static, protected]

random generator seed

Definition at line 1179 of file Math.h.

Version* version [inherited]

version

Definition at line 468 of file SGObject.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

SHOGUN Machine Learning Toolbox - Documentation