 |
aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
|
|
aGrUM 2.3.2
a C++ library for (probabilistic) graphical models
|
the internal prior for the K2 score = Laplace Prior More...
#include <agrum/base/database/K2Prior.h>
Public Member Functions | |
Constructors / Destructors | |
| K2Prior (const DatabaseTable &database, const Bijection< NodeId, std::size_t > &nodeId2columns=Bijection< NodeId, std::size_t >()) | |
| default constructor | |
| K2Prior (const K2Prior &from) | |
| copy constructor | |
| K2Prior (K2Prior &&from) | |
| move constructor | |
| virtual K2Prior * | clone () const |
| virtual copy constructor | |
| virtual | ~K2Prior () |
| destructor | |
Operators | |
| K2Prior & | operator= (const K2Prior &from) |
| copy operator | |
| K2Prior & | operator= (K2Prior &&from) |
| move operator | |
Accessors / Modifiers | |
| virtual void | setWeight (const double weight) final |
| dummy set weight function: in K2, weights are always equal to 1 | |
Accessors / Modifiers | |
| PriorType | getType () const final |
| returns the type of the prior | |
| virtual bool | isInformative () const final |
| indicates whether the prior is tensorly informative | |
| virtual void | addJointPseudoCount (const IdCondSet &idset, std::vector< double > &counts) final |
| adds the prior to a counting vector corresponding to the idset | |
| virtual void | addConditioningPseudoCount (const IdCondSet &idset, std::vector< double > &counts) final |
| adds the prior to a counting vectordefined over the right hand side of the idset | |
Accessors / Modifiers | |
| double | weight () const |
| returns the weight assigned to the prior | |
Protected Attributes | |
| double | weight_ {1.0} |
| the weight of the prior | |
| const DatabaseTable * | database_ |
| a reference to the database in order to have access to its variables | |
| Bijection< NodeId, std::size_t > | nodeId2columns_ |
| a mapping from the NodeIds of the variables to the indices of the columns in the database | |
the internal prior for the K2 score = Laplace Prior
K2 is a BD score with a Laplace prior (i.e., a smoothing of 1).
It is important to note that, to be meaningful a structure + parameter learning requires that the same priors are taken into account during structure learning and parameter learning.
|
explicit |
default constructor
| database | the database from which learning is performed. This is useful to get access to the random variables |
| nodeId2Columns | a mapping from the ids of the nodes in the graphical model to the corresponding column in the DatabaseTable. This enables estimating from a database in which variable A corresponds to the 2nd column the parameters of a BN in which variable A has a NodeId of 5. An empty nodeId2Columns bijection means that the mapping is an identity, i.e., the value of a NodeId is equal to the index of the column in the DatabaseTable. |
Referenced by K2Prior(), K2Prior(), clone(), operator=(), and operator=().
| gum::learning::K2Prior::K2Prior | ( | const K2Prior & | from | ) |
| gum::learning::K2Prior::K2Prior | ( | K2Prior && | from | ) |
|
virtual |
destructor
|
finalvirtualinherited |
adds the prior to a counting vectordefined over the right hand side of the idset
Implements gum::learning::Prior.
References addConditioningPseudoCount().
Referenced by addConditioningPseudoCount().
|
finalvirtualinherited |
adds the prior to a counting vector corresponding to the idset
adds the prior to an already created counting vector defined over the union of the variables on both the left and right hand side of the conditioning bar of the idset.
Implements gum::learning::Prior.
References addJointPseudoCount().
Referenced by addJointPseudoCount().
|
virtual |
virtual copy constructor
Implements gum::learning::Prior.
References K2Prior().
|
finalvirtualinherited |
returns the type of the prior
Implements gum::learning::Prior.
|
finalvirtualinherited |
indicates whether the prior is tensorly informative
Basically, only the NoPrior is uninformative. However, it may happen that, under some circonstances, an prior, which is usually not equal to the NoPrior, becomes equal to it (e.g., when the weight is equal to zero). In this case, if the prior can detect this case, it shall inform the classes that use it that it is temporarily uninformative. These classes will then be able to speed-up their code by avoiding to take into account the prior in their computations.
Implements gum::learning::Prior.
References isInformative().
Referenced by isInformative().
|
finalvirtual |
dummy set weight function: in K2, weights are always equal to 1
Reimplemented from gum::learning::Prior.
References gum::learning::Prior::weight().
|
inherited |
returns the weight assigned to the prior
Referenced by gum::learning::BDeuPrior::setEffectiveSampleSize(), gum::learning::BDeuPrior::setWeight(), gum::learning::DirichletPriorFromBN< GUM_SCALAR >::setWeight(), gum::learning::DirichletPriorFromDatabase::setWeight(), gum::learning::K2Prior::setWeight(), gum::learning::NoPrior::setWeight(), and setWeight().
|
protectedinherited |
|
protectedinherited |