gum::learning::DBTranslatedValue Union Reference

The union class for storing the translated values in learning databases. More...

#include <agrum/base/database/DBTranslatedValue.h>

Public Member Functions
Constructors / Destructors
constexpr	DBTranslatedValue ()
	default constructor: stores discrete value 0
constexpr	DBTranslatedValue (const float &val)
	the constructor for storing a continuous value
constexpr	DBTranslatedValue (const std::size_t &val)
	the constructor for storing a discrete value
	~DBTranslatedValue ()
	destructor

Public Attributes
std::size_t	discr_val
	the field for storing discrete values
float	cont_val
	the field for storing continuous values

Detailed Description

The union class for storing the translated values in learning databases.

In aGrUM, learning is performed on datasets that are preprocessed, i.e., their values are encoded in such a way that learning is fast. More precisely, the values of discrete random variables are encoded as integers ranging from 0 to the domain size minus 1 of the variable, and the values of continuous random variables are encoded as floating point numbers. Missing values are encoded as std::numeric_limits<>::max() over these types. The DBTranslatedValue class is the representation of these types.

Usage example:

// create a discrete value equal to 3 and a continuous value equal to 4.5
gum::learning::DBTranslatedValue x1 { std::size_t(3) };
gum::learning::DBTranslatedValue x2 { 4.5f };
 
// access these elements and display them
std::cout << x1.discr_val << "  " << x2.cont_val << std::endl;

Definition at line 88 of file DBTranslatedValue.h.

Constructor & Destructor Documentation

DBTranslatedValue() [1/3]

gum::learning::DBTranslatedValue::DBTranslatedValue ( )

inlineconstexpr

default constructor: stores discrete value 0

Definition at line 102 of file DBTranslatedValue.h.

: discr_val{std::size_t(0)} {}

References discr_val.

DBTranslatedValue() [2/3]

gum::learning::DBTranslatedValue::DBTranslatedValue ( const float & val )

inlineconstexpr

the constructor for storing a continuous value

Definition at line 105 of file DBTranslatedValue.h.

: cont_val{val} {}

References cont_val.

DBTranslatedValue() [3/3]

gum::learning::DBTranslatedValue::DBTranslatedValue ( const std::size_t & val )

inlineconstexpr

the constructor for storing a discrete value

Definition at line 108 of file DBTranslatedValue.h.

: discr_val{val} {}

References discr_val.

~DBTranslatedValue()

gum::learning::DBTranslatedValue::~DBTranslatedValue ( )

inline

destructor

Definition at line 111 of file DBTranslatedValue.h.

{};

Member Data Documentation

cont_val

float gum::learning::DBTranslatedValue::cont_val

the field for storing continuous values

Definition at line 93 of file DBTranslatedValue.h.

Referenced by DBTranslatedValue().

discr_val

std::size_t gum::learning::DBTranslatedValue::discr_val

the field for storing discrete values

Definition at line 90 of file DBTranslatedValue.h.

Referenced by DBTranslatedValue(), and DBTranslatedValue().

---

The documentation for this union was generated from the following file:

• agrum/base/database/DBTranslatedValue.h