SHOGUN
v3.0.0
|
Public Member Functions | |
virtual const char * | get_name () const |
virtual CSGObject * | shallow_copy () const |
virtual CSGObject * | deep_copy () const |
virtual bool | is_generic (EPrimitiveType *generic) const |
template<class T > | |
void | set_generic () |
void | unset_generic () |
virtual void | print_serializable (const char *prefix="") |
virtual bool | save_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter()) |
virtual bool | load_serializable (CSerializableFile *file, const char *prefix="", int32_t param_version=Version::get_version_parameter()) |
DynArray< TParameter * > * | load_file_parameters (const SGParamInfo *param_info, int32_t file_version, CSerializableFile *file, const char *prefix="") |
DynArray< TParameter * > * | load_all_file_parameters (int32_t file_version, int32_t current_version, CSerializableFile *file, const char *prefix="") |
void | map_parameters (DynArray< TParameter * > *param_base, int32_t &base_version, DynArray< const SGParamInfo * > *target_param_infos) |
void | set_global_io (SGIO *io) |
SGIO * | get_global_io () |
void | set_global_parallel (Parallel *parallel) |
Parallel * | get_global_parallel () |
void | set_global_version (Version *version) |
Version * | get_global_version () |
SGStringList< char > | get_modelsel_names () |
void | print_modsel_params () |
char * | get_modsel_param_descr (const char *param_name) |
index_t | get_modsel_param_index (const char *param_name) |
void | build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject * > *dict) |
virtual bool | update_parameter_hash () |
virtual bool | equals (CSGObject *other, float64_t accuracy=0.0) |
virtual CSGObject * | clone () |
Constructor/Destructor. | |
CMath () | |
Constructor - initializes log-table. | |
virtual | ~CMath () |
Destructor - frees logtable. |
Static Public Member Functions | |
static float64_t | real (complex128_t c) |
returns real part of a complex128_t number | |
static float64_t | imag (complex128_t c) |
returns imag part of a complex128_t number | |
static uint32_t | get_seed () |
returns number generator seed | |
static uint32_t | get_log_range () |
returns range of logtable | |
static int | is_finite (double f) |
checks whether a float is finite | |
static int | is_infinity (double f) |
checks whether a float is infinity | |
static int | is_nan (double f) |
checks whether a float is nan | |
min/max/abs functions. | |
template<class T > | |
static T | min (T a, T b) |
return the minimum of two integers | |
template<class T > | |
static T | max (T a, T b) |
return the maximum of two integers | |
template<class T > | |
static T | clamp (T value, T lb, T ub) |
return the value clamped to interval [lb,ub] | |
template<class T > | |
static T | abs (T a) |
return the absolute value of a number | |
static float64_t | abs (complex128_t a) |
return the absolute value of a complex number | |
misc functions | |
static float64_t | round (float64_t d) |
static float64_t | floor (float64_t d) |
static float64_t | ceil (float64_t d) |
template<class T > | |
static T | sign (T a) |
signum of type T variable a | |
template<class T > | |
static void | swap (T &a, T &b) |
swap e.g. floats a and b | |
template<class T > | |
static T | sq (T x) |
x^2 | |
static float32_t | sqrt (float32_t x) |
x^0.5 | |
static float64_t | sqrt (float64_t x) |
x^0.5 | |
static floatmax_t | sqrt (floatmax_t x) |
x^0.5 | |
static float32_t | invsqrt (float32_t x) |
x^0.5, x being a complex128_t | |
static floatmax_t | powl (floatmax_t x, floatmax_t n) |
x^n | |
static int32_t | pow (bool x, int32_t n) |
static int32_t | pow (int32_t x, int32_t n) |
static float64_t | pow (float64_t x, int32_t n) |
static float64_t | pow (float64_t x, float64_t n) |
static complex128_t | pow (complex128_t x, int32_t n) |
x^n, x or n being a complex128_t | |
static complex128_t | pow (complex128_t x, complex128_t n) |
static complex128_t | pow (complex128_t x, float64_t n) |
static complex128_t | pow (float64_t x, complex128_t n) |
static float64_t | exp (float64_t x) |
static float64_t | tan (float64_t x) |
exp(x), x being a complex128_t | |
static float64_t | atan (float64_t x) |
tan(x), x being a complex128_t | |
static float64_t | atan2 (float64_t x, float64_t y) |
atan(x), x being a complex128_t not implemented | |
static float64_t | tanh (float64_t x) |
atan2(x), x being a complex128_t not implemented | |
static float64_t | log10 (float64_t v) |
tanh(x), x being a complex128_t | |
static float64_t | log2 (float64_t v) |
log10(x), x being a complex128_t | |
static float64_t | log (float64_t v) |
static index_t | floor_log (index_t n) |
log(x), x being a complex128_t | |
static float64_t | sin (float64_t x) |
static float64_t | asin (float64_t x) |
sin(x), x being a complex128_t | |
static float64_t | sinh (float64_t x) |
asin(x), x being a complex128_t not implemented | |
static float64_t | cos (float64_t x) |
sinh(x), x being a complex128_t | |
static float64_t | acos (float64_t x) |
cos(x), x being a complex128_t | |
static float64_t | cosh (float64_t x) |
acos(x), x being a complex128_t not implemented | |
static float64_t | area_under_curve (float64_t *xy, int32_t len, bool reversed) |
cosh(x), x being a complex128_t | |
static int64_t | factorial (int32_t n) |
static void | init_random (uint32_t initseed=0) |
static uint64_t | random () |
static uint64_t | random (uint64_t min_value, uint64_t max_value) |
static int64_t | random (int64_t min_value, int64_t max_value) |
static uint32_t | random (uint32_t min_value, uint32_t max_value) |
static int32_t | random (int32_t min_value, int32_t max_value) |
static float32_t | random (float32_t min_value, float32_t max_value) |
static float64_t | random (float64_t min_value, float64_t max_value) |
static floatmax_t | random (floatmax_t min_value, floatmax_t max_value) |
static float32_t | normal_random (float32_t mean, float32_t std_dev) |
static float64_t | normal_random (float64_t mean, float64_t std_dev) |
static float32_t | randn_float () |
static float64_t | randn_double () |
template<class T > | |
static int32_t | get_num_nonzero (T *vec, int32_t len) |
static int32_t | get_num_nonzero (complex128_t *vec, int32_t len) |
static int64_t | nchoosek (int32_t n, int32_t k) |
static void | linspace (float64_t *output, float64_t start, float64_t end, int32_t n=100) |
template<class T > | |
static T | log_sum_exp (SGVector< T > values) |
template<class T > | |
static T | log_mean_exp (SGVector< T > values) |
static void | sort (int32_t *a, int32_t cols, int32_t sort_col=0) |
static void | sort (float64_t *a, int32_t *idx, int32_t N) |
template<class T > | |
static void | qsort (T *output, int32_t size) |
template<class T > | |
static void | insertion_sort (T *output, int32_t size) |
template<class T > | |
static void | radix_sort (T *array, int32_t size) |
template<class T > | |
static uint8_t | byte (T word, uint16_t p) |
static uint8_t | byte (complex128_t word, uint16_t p) |
byte not implemented for complex128_t | |
template<class T > | |
static void | radix_sort_helper (T *array, int32_t size, uint16_t i) |
static void | radix_sort_helper (complex128_t *array, int32_t size, uint16_t i) |
radix_sort_helper not implemented for complex128_t | |
template<class T > | |
static void | qsort (T **vector, index_t length) |
static void | qsort (complex128_t **vector, index_t length) |
qsort not implemented for complex128_t | |
template<class T > | |
static void | display_bits (T word, int32_t width=8 *sizeof(T)) |
display bits (useful for debugging) | |
static void | display_bits (complex128_t word, int32_t width=8 *sizeof(complex128_t)) |
disply_bits not implemented for complex128_t | |
template<class T1 , class T2 > | |
static void | qsort_index (T1 *output, T2 *index, uint32_t size) |
template<class T > | |
static void | qsort_index (complex128_t *output, T *index, uint32_t size) |
qsort_index not implemented for complex128_t | |
template<class T1 , class T2 > | |
static void | qsort_backward_index (T1 *output, T2 *index, int32_t size) |
template<class T > | |
static void | qsort_backword_index (complex128_t *output, T *index, uint32_t size) |
qsort_backword_index not implemented for complex128_t | |
template<class T1 , class T2 > | |
static void | parallel_qsort_index (T1 *output, T2 *index, uint32_t size, int32_t n_threads, int32_t limit=262144) |
template<class T > | |
static void | parallel_qsort_index (complex128_t *output, T *index, uint32_t size, int32_t n_threads, int32_t limit=0) |
parallel_qsort_index not implemented for complex128_t | |
template<class T1 , class T2 > | |
static void * | parallel_qsort_index (void *p) |
template<class T > | |
static void | min (float64_t *output, T *index, int32_t size) |
static void | min (float64_t *output, complex128_t *index, int32_t size) |
complex128_t cannot be used as index | |
template<class T > | |
static void | nmin (float64_t *output, T *index, int32_t size, int32_t n) |
static void | nmin (float64_t *output, complex128_t *index, int32_t size, int32_t n) |
complex128_t cannot be used as index | |
template<class T > | |
static int32_t | binary_search_helper (T *output, int32_t size, T elem) |
static int32_t | binary_search_helper (complex128_t *output, int32_t size, complex128_t elem) |
binary_search_helper not implemented for complex128_t | |
template<class T > | |
static int32_t | binary_search (T *output, int32_t size, T elem) |
static int32_t | binary_search (complex128_t *output, int32_t size, complex128_t elem) |
binary_search not implemented for complex128_t | |
template<class T > | |
static int32_t | binary_search (T **vector, index_t length, T *elem) |
static int32_t | binary_search (complex128_t **vector, index_t length, complex128_t *elem) |
binary_search not implemented for complex128_t | |
template<class T > | |
static int32_t | binary_search_max_lower_equal (T *output, int32_t size, T elem) |
static int32_t | binary_search_max_lower_equal (complex128_t *output, int32_t size, complex128_t elem) |
binary_search_max_lower_equal not implemented for complex128_t | |
static float64_t | Align (char *seq1, char *seq2, int32_t l1, int32_t l2, float64_t gapCost) |
summing functions | |
static float64_t | logarithmic_sum (float64_t p, float64_t q) |
Public Attributes | |
SGIO * | io |
Parallel * | parallel |
Version * | version |
Parameter * | m_parameters |
Parameter * | m_model_selection_parameters |
Parameter * | m_gradient_parameters |
ParameterMap * | m_parameter_map |
uint32_t | m_hash |
Protected Member Functions | |
virtual TParameter * | migrate (DynArray< TParameter * > *param_base, const SGParamInfo *target) |
virtual void | one_to_one_migration_prepare (DynArray< TParameter * > *param_base, const SGParamInfo *target, TParameter *&replacement, TParameter *&to_migrate, char *old_name=NULL) |
virtual void | load_serializable_pre () throw (ShogunException) |
virtual void | load_serializable_post () throw (ShogunException) |
virtual void | save_serializable_pre () throw (ShogunException) |
virtual void | save_serializable_post () throw (ShogunException) |
constants | |
static const float64_t | INFTY = -log(0.0) |
infinity | |
static const float64_t | ALMOST_INFTY = +1e+20 |
static const float64_t | ALMOST_NEG_INFTY = -1000 |
almost neg (log) infinity | |
static const float64_t | PI = M_PI |
static const float64_t | MACHINE_EPSILON = 5E-16 |
static const float64_t | MAX_REAL_NUMBER = 1E300 |
static const float64_t | MIN_REAL_NUMBER = 1E-300 |
static int32_t | LOGRANGE = 0 |
range for logtable: log(1+exp(x)) -LOGRANGE <= x <= 0 | |
static uint32_t | seed = 0 |
random generator seed |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
inherited |
Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.
dict | dictionary of parameters to be built. |
Definition at line 1196 of file SGObject.cpp.
|
static |
|
static |
|
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.
Definition at line 1313 of file SGObject.cpp.
|
virtualinherited |
A deep copy. All the instance variables will also be copied.
Definition at line 160 of file SGObject.h.
|
static |
|
static |
Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!
May be overwritten but please do with care! Should not be necessary in most cases.
other | object to compare with |
accuracy | accuracy to use for comparison (optional) |
Definition at line 1217 of file SGObject.cpp.
|
inherited |
|
inherited |
|
inherited |
|
static |
|
inherited |
Definition at line 1100 of file SGObject.cpp.
|
inherited |
Returns description of a given parameter string, if it exists. SG_ERROR otherwise
param_name | name of the parameter |
Definition at line 1124 of file SGObject.cpp.
|
inherited |
Returns index of model selection parameter with provided index
param_name | name of model selection parameter |
Definition at line 1137 of file SGObject.cpp.
|
virtual |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
virtualinherited |
If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.
generic | set to the type of the generic if returning TRUE |
Definition at line 268 of file SGObject.cpp.
|
static |
|
static |
Builds an array with n linearly spaced elements between start and end.
output | array with linearly spaced elements within the interval |
start | beginning of the interval to divide |
end | upper bound of the interval to divide |
n | number of elements used to divide the interval |
|
inherited |
maps all parameters of this instance to the provided file version and loads all parameter data from the file into an array, which is sorted (basically calls load_file_parameter(...) for all parameters and puts all results into a sorted array)
file_version | parameter version of the file |
current_version | version from which mapping begins (you want to use Version::get_version_parameter() for this in most cases) |
file | file to load from |
prefix | prefix for members |
Definition at line 673 of file SGObject.cpp.
|
inherited |
loads some specified parameters from a file with a specified version The provided parameter info has a version which is recursively mapped until the file parameter version is reached. Note that there may be possibly multiple parameters in the mapping, therefore, a set of TParameter instances is returned
param_info | information of parameter |
file_version | parameter version of the file, must be <= provided parameter version |
file | file to load from |
prefix | prefix for members |
Definition at line 514 of file SGObject.cpp.
|
virtualinherited |
Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!
file | where to load from |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 345 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel, CWeightedDegreePositionStringKernel, CList, CAlphabet, CLinearHMM, CGaussianKernel, CInverseMultiQuadricKernel, CCircularKernel, and CExponentialKernel.
Definition at line 1029 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1024 of file SGObject.cpp.
|
static |
|
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).
|
inherited |
Takes a set of TParameter instances (base) with a certain version and a set of target parameter infos and recursively maps the base level wise to the current version using CSGObject::migrate(...). The base is replaced. After this call, the base version containing parameters should be of same version/type as the initial target parameter infos. Note for this to work, the migrate methods and all the internal parameter mappings have to match
param_base | set of TParameter instances that are mapped to the provided target parameter infos |
base_version | version of the parameter base |
target_param_infos | set of SGParamInfo instances that specify the target parameter base |
Definition at line 711 of file SGObject.cpp.
|
static |
|
protectedvirtualinherited |
creates a new TParameter instance, which contains migrated data from the version that is provided. The provided parameter data base is used for migration, this base is a collection of all parameter data of the previous version. Migration is done FROM the data in param_base TO the provided param info Migration is always one version step. Method has to be implemented in subclasses, if no match is found, base method has to be called.
If there is an element in the param_base which equals the target, a copy of the element is returned. This represents the case when nothing has changed and therefore, the migrate method is not overloaded in a subclass
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
Definition at line 918 of file SGObject.cpp.
|
static |
|
static |
|
static |
|
static |
|
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
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
|
protectedvirtualinherited |
This method prepares everything for a one-to-one parameter migration. One to one here means that only ONE element of the parameter base is needed for the migration (the one with the same name as the target). Data is allocated for the target (in the type as provided in the target SGParamInfo), and a corresponding new TParameter instance is written to replacement. The to_migrate pointer points to the single needed TParameter instance needed for migration. If a name change happened, the old name may be specified by old_name. In addition, the m_delete_data flag of to_migrate is set to true. So if you want to migrate data, the only thing to do after this call is converting the data in the m_parameter fields. If unsure how to use - have a look into an example for this. (base_migration_type_conversion.cpp for example)
param_base | set of TParameter instances to use for migration |
target | parameter info for the resulting TParameter |
replacement | (used as output) here the TParameter instance which is returned by migration is created into |
to_migrate | the only source that is used for migration |
old_name | with this parameter, a name change may be specified |
Definition at line 858 of file SGObject.cpp.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
inherited |
prints all parameter registered for model selection and their type
Definition at line 1076 of file SGObject.cpp.
|
virtualinherited |
prints registered parameters out
prefix | prefix for members |
Definition at line 280 of file SGObject.cpp.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
virtualinherited |
Save this object to file.
file | where to save the object; will be closed during returning if PREFIX is an empty string. |
prefix | prefix for members |
param_version | (optional) a parameter version different to (this is mainly for testing, better do not use) |
Definition at line 286 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel.
Definition at line 1039 of file SGObject.cpp.
|
protectedvirtualinherited |
Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.
ShogunException | Will be thrown if an error occurres. |
Reimplemented in CKernel, CDynamicArray< T >, CDynamicArray< float64_t >, CDynamicArray< float32_t >, CDynamicArray< int32_t >, CDynamicArray< char >, CDynamicArray< bool >, CDynamicArray< uint64_t >, and CDynamicObjectArray.
Definition at line 1034 of file SGObject.cpp.
|
inherited |
set generic type to T
Definition at line 41 of file SGObject.cpp.
|
inherited |
|
inherited |
set the parallel object
parallel | parallel object to use |
Definition at line 220 of file SGObject.cpp.
|
inherited |
set the version object
version | version object to use |
Definition at line 255 of file SGObject.cpp.
|
virtualinherited |
A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.
Reimplemented in CGaussianKernel.
Definition at line 151 of file SGObject.h.
|
static |
|
static |
|
static |
|
static |
|
inherited |
unset generic type
this has to be called in classes specializing a template class
Definition at line 275 of file SGObject.cpp.
|
virtualinherited |
Updates the hash of current parameter combination.
Definition at line 227 of file SGObject.cpp.
|
static |
|
inherited |
io
Definition at line 514 of file SGObject.h.
|
staticprotected |
|
inherited |
parameters wrt which we can compute gradients
Definition at line 529 of file SGObject.h.
|
inherited |
Hash of parameter values
Definition at line 535 of file SGObject.h.
|
inherited |
model selection parameters
Definition at line 526 of file SGObject.h.
|
inherited |
map for different parameter versions
Definition at line 532 of file SGObject.h.
|
inherited |
parameters
Definition at line 523 of file SGObject.h.
|
static |
|
inherited |
parallel
Definition at line 517 of file SGObject.h.
|
inherited |
version
Definition at line 520 of file SGObject.h.