![]() |
aGrUM
0.20.3
a C++ library for (probabilistic) graphical models
|
The databases' cell translators for discretized variables. More...
#include <agrum/tools/database/DBTranslator4DiscretizedVariable.h>
Public Member Functions | |
Constructors / Destructors | |
template<typename GUM_SCALAR , template< typename > class XALLOC> | |
DBTranslator4DiscretizedVariable (const DiscretizedVariable< GUM_SCALAR > &var, const std::vector< std::string, XALLOC< std::string > > &missing_symbols, std::size_t max_dico_entries=std::numeric_limits< std::size_t >::max(), const allocator_type &alloc=allocator_type()) | |
default constructor with a discretized variable as translator More... | |
template<typename GUM_SCALAR > | |
DBTranslator4DiscretizedVariable (const DiscretizedVariable< GUM_SCALAR > &var, std::size_t max_dico_entries=std::numeric_limits< std::size_t >::max(), const allocator_type &alloc=allocator_type()) | |
default constructor with a discretized variable as translator but without missing symbols More... | |
template<template< typename > class XALLOC> | |
DBTranslator4DiscretizedVariable (const IDiscretizedVariable &var, const std::vector< std::string, XALLOC< std::string > > &missing_symbols, std::size_t max_dico_entries=std::numeric_limits< std::size_t >::max(), const allocator_type &alloc=allocator_type()) | |
default constructor with a IDiscretized variable as translator More... | |
DBTranslator4DiscretizedVariable (const IDiscretizedVariable &var, std::size_t max_dico_entries=std::numeric_limits< std::size_t >::max(), const allocator_type &alloc=allocator_type()) | |
default constructor with a IDiscretized variable as translator but without missing symbols More... | |
DBTranslator4DiscretizedVariable (const DBTranslator4DiscretizedVariable< ALLOC > &from) | |
copy constructor More... | |
DBTranslator4DiscretizedVariable (const DBTranslator4DiscretizedVariable< ALLOC > &from, const allocator_type &alloc) | |
copy constructor with a given allocator More... | |
DBTranslator4DiscretizedVariable (DBTranslator4DiscretizedVariable< ALLOC > &&from) | |
move constructor More... | |
DBTranslator4DiscretizedVariable (DBTranslator4DiscretizedVariable< ALLOC > &&from, const allocator_type &alloc) | |
move constructor with a given allocator More... | |
virtual DBTranslator4DiscretizedVariable< ALLOC > * | clone () const |
virtual copy constructor More... | |
virtual DBTranslator4DiscretizedVariable< ALLOC > * | clone (const allocator_type &alloc) const |
virtual copy constructor with a given allocator More... | |
virtual | ~DBTranslator4DiscretizedVariable () |
destructor More... | |
Operators | |
DBTranslator4DiscretizedVariable< ALLOC > & | operator= (const DBTranslator4DiscretizedVariable< ALLOC > &from) |
copy operator More... | |
DBTranslator4DiscretizedVariable< ALLOC > & | operator= (DBTranslator4DiscretizedVariable< ALLOC > &&from) |
move operator More... | |
Accessors / Modifiers | |
virtual DBTranslatedValue | translate (const std::string &str) final |
returns the translation of a string More... | |
virtual std::string | translateBack (const DBTranslatedValue translated_val) const final |
returns the original value for a given translation More... | |
virtual std::size_t | domainSize () const final |
returns the number of discretization intervals used for translations More... | |
virtual bool | hasEditableDictionary () const final |
indicates that the translator is never in editable dictionary mode More... | |
virtual void | setEditableDictionaryMode (bool new_mode) final |
sets/unset the editable dictionary mode More... | |
virtual bool | needsReordering () const final |
indicates that the translations should never be reordered More... | |
virtual HashTable< std::size_t, std::size_t, ALLOC< std::pair< std::size_t, std::size_t > > > | reorder () final |
returns an empty HashTable to indicate that no reordering is needed. More... | |
virtual const IDiscretizedVariable * | variable () const final |
returns the variable stored into the translator More... | |
virtual DBTranslatedValue | missingValue () const final |
returns the translation of a missing value More... | |
Operators | |
DBTranslatedValue | operator<< (const std::string &str) |
alias for method translate More... | |
std::string | operator>> (const DBTranslatedValue translated_val) |
alias for method translateBack More... | |
Accessors / Modifiers | |
const Set< std::string, ALLOC< std::string > > & | missingSymbols () const |
returns the set of missing symbols taken into account by the translator More... | |
bool | isMissingSymbol (const std::string &str) const |
indicates whether a string corresponds to a missing symbol More... | |
void | setVariableName (const std::string &str) const |
sets the name of the variable stored into the translator More... | |
void | setVariableDescription (const std::string &str) const |
sets the name of the variable stored into the translator More... | |
DBTranslatedValueType | getValType () const |
returns the type of values handled by the translator More... | |
allocator_type | getAllocator () const |
returns the allocator used by the translator More... | |
bool | isMissingValue (const DBTranslatedValue &val) const |
indicates whether a translated value corresponds to a missing value More... | |
Public Types | |
using | allocator_type = typename DBTranslator< ALLOC >::allocator_type |
type for the allocators passed in arguments of methods More... | |
Protected Attributes | |
bool | is_dictionary_dynamic_ |
indicates whether the dictionary can be updated or not More... | |
std::size_t | max_dico_entries_ |
the maximum number of entries that the dictionary is allowed to contain More... | |
Set< std::string, ALLOC< std::string > > | missing_symbols_ |
the set of missing symbols More... | |
Bijection< std::size_t, std::string, ALLOC< std::pair< float, std::string > > > | back_dico_ |
the bijection relating back translated values and their original strings. More... | |
DBTranslatedValueType | val_type_ |
the type of the values translated by the translator More... | |
The databases' cell translators for discretized variables.
Translators are used by DatabaseTable instances to transform datasets' strings into DBTranslatedValue instances. The point is that strings are not adequate for fast learning, they need to be preprocessed into a type that can be analyzed quickly (the so-called DBTranslatedValue type).
A DBTranslator4DiscretizedVariable is a translator that contains and exploits a DiscretizedVariable for translations. Each time a string needs be translated, we ask the DiscretizedVariable which discretization interval contains the the number represented by the string. The DBTranslatedValue corresponding to the translation of the string contains in its discr_val field the index of this discretization interval.
Definition at line 120 of file DBTranslator4DiscretizedVariable.h.
using gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::allocator_type = typename DBTranslator< ALLOC >::allocator_type |
type for the allocators passed in arguments of methods
Definition at line 123 of file DBTranslator4DiscretizedVariable.h.
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | const DiscretizedVariable< GUM_SCALAR > & | var, |
const std::vector< std::string, XALLOC< std::string > > & | missing_symbols, | ||
std::size_t | max_dico_entries = std::numeric_limits< std::size_t >::max() , |
||
const allocator_type & | alloc = allocator_type() |
||
) |
default constructor with a discretized variable as translator
var | a discretized variable which will be used for translations. The translator keeps a copy of this variable |
missing_symbols | the set of symbols in the dataset representing missing values |
max_dico_entries | the max number of entries that the dictionary can contain. During the construction, we check that the discretized variable passed in argument has fewer discretization intervals than the admissible dictionary size |
alloc | The allocator used to allocate memory for all the fields of the DBTranslator4DiscretizedVariable |
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | const DiscretizedVariable< GUM_SCALAR > & | var, |
std::size_t | max_dico_entries = std::numeric_limits< std::size_t >::max() , |
||
const allocator_type & | alloc = allocator_type() |
||
) |
default constructor with a discretized variable as translator but without missing symbols
var | a discretized variable which will be used for translations. The translator keeps a copy of this variable |
max_dico_entries | the max number of entries that the dictionary can contain. During the construction, we check that the discretized variable passed in argument has fewer discretization intervals than the admissible dictionary size |
alloc | The allocator used to allocate memory for all the fields of the DBTranslator4DiscretizedVariable |
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | const IDiscretizedVariable & | var, |
const std::vector< std::string, XALLOC< std::string > > & | missing_symbols, | ||
std::size_t | max_dico_entries = std::numeric_limits< std::size_t >::max() , |
||
const allocator_type & | alloc = allocator_type() |
||
) |
default constructor with a IDiscretized variable as translator
var | a IDiscretized variable which will be used for translations. The translator keeps a copy of this variable |
missing_symbols | the set of symbols in the dataset representing missing values |
max_dico_entries | the max number of entries that the dictionary can contain. During the construction, we check that the discretized variable passed in argument has fewer discretization intervals than the admissible dictionary size |
alloc | The allocator used to allocate memory for all the fields of the DBTranslator4DiscretizedVariable |
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | const IDiscretizedVariable & | var, |
std::size_t | max_dico_entries = std::numeric_limits< std::size_t >::max() , |
||
const allocator_type & | alloc = allocator_type() |
||
) |
default constructor with a IDiscretized variable as translator but without missing symbols
var | a discretized variable which will be used for translations. The translator keeps a copy of this variable |
max_dico_entries | the max number of entries that the dictionary can contain. During the construction, we check that the discretized variable passed in argument has fewer discretization intervals than the admissible dictionary size |
alloc | The allocator used to allocate memory for all the fields of the DBTranslator4DiscretizedVariable |
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | const DBTranslator4DiscretizedVariable< ALLOC > & | from | ) |
copy constructor
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | const DBTranslator4DiscretizedVariable< ALLOC > & | from, |
const allocator_type & | alloc | ||
) |
copy constructor with a given allocator
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | DBTranslator4DiscretizedVariable< ALLOC > && | from | ) |
move constructor
gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::DBTranslator4DiscretizedVariable | ( | DBTranslator4DiscretizedVariable< ALLOC > && | from, |
const allocator_type & | alloc | ||
) |
move constructor with a given allocator
|
virtual |
destructor
|
virtual |
virtual copy constructor
Implements gum::learning::DBTranslator< ALLOC >.
|
virtual |
virtual copy constructor with a given allocator
Implements gum::learning::DBTranslator< ALLOC >.
|
finalvirtual |
returns the number of discretization intervals used for translations
Implements gum::learning::DBTranslator< ALLOC >.
|
inherited |
returns the allocator used by the translator
|
inherited |
returns the type of values handled by the translator
|
finalvirtual |
indicates that the translator is never in editable dictionary mode
Reimplemented from gum::learning::DBTranslator< ALLOC >.
|
inherited |
indicates whether a string corresponds to a missing symbol
|
inherited |
indicates whether a translated value corresponds to a missing value
|
inherited |
returns the set of missing symbols taken into account by the translator
|
finalvirtual |
returns the translation of a missing value
Implements gum::learning::DBTranslator< ALLOC >.
|
finalvirtual |
indicates that the translations should never be reordered
Implements gum::learning::DBTranslator< ALLOC >.
|
inherited |
alias for method translate
DBTranslator4DiscretizedVariable< ALLOC >& gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::operator= | ( | const DBTranslator4DiscretizedVariable< ALLOC > & | from | ) |
copy operator
DBTranslator4DiscretizedVariable< ALLOC >& gum::learning::DBTranslator4DiscretizedVariable< ALLOC >::operator= | ( | DBTranslator4DiscretizedVariable< ALLOC > && | from | ) |
move operator
|
inherited |
alias for method translateBack
|
finalvirtual |
returns an empty HashTable to indicate that no reordering is needed.
Implements gum::learning::DBTranslator< ALLOC >.
|
finalvirtual |
sets/unset the editable dictionary mode
Reimplemented from gum::learning::DBTranslator< ALLOC >.
|
inherited |
sets the name of the variable stored into the translator
|
inherited |
sets the name of the variable stored into the translator
|
finalvirtual |
returns the translation of a string
This method tries to translate a given string into the DBTranslatedValue that should be stored into a databaseTable. If the translator cannot find the translation in its current dictionary, then the translator raises either a TypeError if the string is not a number or a NotFound exception.
UnknownLabelInDatabase | is raised if the translation cannot be found. |
TypeError | is raised if the translation cannot be found and the translator and the string does not correspond to a number. |
Implements gum::learning::DBTranslator< ALLOC >.
|
finalvirtual |
returns the original value for a given translation
UnknownLabelInDatabase | is raised if this original value cannot be found |
Implements gum::learning::DBTranslator< ALLOC >.
|
finalvirtual |
returns the variable stored into the translator
Implements gum::learning::DBTranslator< ALLOC >.
|
mutableprotectedinherited |
the bijection relating back translated values and their original strings.
Note that the translated values considered here are of type std::size_t because only the values for discrete variables need be stored, those for continuous variables are actually identity mappings.
Definition at line 388 of file DBTranslator.h.
|
protectedinherited |
indicates whether the dictionary can be updated or not
Definition at line 373 of file DBTranslator.h.
|
protectedinherited |
the maximum number of entries that the dictionary is allowed to contain
Definition at line 376 of file DBTranslator.h.
|
protectedinherited |
the set of missing symbols
Definition at line 379 of file DBTranslator.h.
|
protectedinherited |
the type of the values translated by the translator
Definition at line 391 of file DBTranslator.h.