aGrUM  0.14.1
gum::learning::AprioriDirichletFromDatabase< ALLOC > Class Template Reference

A dirichlet priori: computes its N'_ijk from a database. More...

#include <agrum/learning/database/aprioriDirichletFromDatabase.h>

+ Inheritance diagram for gum::learning::AprioriDirichletFromDatabase< ALLOC >:
+ Collaboration diagram for gum::learning::AprioriDirichletFromDatabase< ALLOC >:

Public Member Functions

Constructors / Destructors
 AprioriDirichletFromDatabase (const DatabaseTable< ALLOC > &learning_db, const DBRowGeneratorParser< ALLOC > &apriori_parser, const Bijection< NodeId, std::size_t, ALLOC< std::size_t > > &nodeId2columns=Bijection< NodeId, std::size_t, ALLOC< std::size_t > >(), const allocator_type &alloc=allocator_type())
 default constructor More...
 
 AprioriDirichletFromDatabase (const AprioriDirichletFromDatabase< ALLOC > &from)
 copy constructor More...
 
 AprioriDirichletFromDatabase (const AprioriDirichletFromDatabase< ALLOC > &from, const allocator_type &alloc)
 copy constructor with a given allocator More...
 
 AprioriDirichletFromDatabase (AprioriDirichletFromDatabase< ALLOC > &&from)
 move constructor More...
 
 AprioriDirichletFromDatabase (AprioriDirichletFromDatabase< ALLOC > &&from, const allocator_type &alloc)
 move constructor with a given allocator More...
 
virtual AprioriDirichletFromDatabase< ALLOC > * clone () const
 virtual copy constructor More...
 
virtual AprioriDirichletFromDatabase< ALLOC > * clone (const allocator_type &alloc) const
 virtual copy constructor with a given allocator More...
 
virtual ~AprioriDirichletFromDatabase ()
 destructor More...
 
Operators
AprioriDirichletFromDatabase< ALLOC > & operator= (const AprioriDirichletFromDatabase< ALLOC > &from)
 copy operator More...
 
AprioriDirichletFromDatabase< ALLOC > & operator= (AprioriDirichletFromDatabase< ALLOC > &&from)
 move operator More...
 
Accessors / Modifiers
virtual bool isOfType (const std::string &type) final
 indicates whether an apriori is of a certain type More...
 
virtual const std::string & getType () const final
 returns the type of the apriori More...
 
virtual bool isInformative () const final
 indicates whether the apriori is potentially informative More...
 
virtual void setWeight (const double weight) final
 sets the weight of the a priori (kind of effective sample size) More...
 
virtual void addAllApriori (const IdSet< ALLOC > &idset, std::vector< double, ALLOC< double > > &counts) final
 adds the apriori to a counting vector corresponding to the idset More...
 
virtual void addConditioningApriori (const IdSet< ALLOC > &idset, std::vector< double, ALLOC< double > > &counts) final
 adds the apriori to a counting vectordefined over the right hand side of the idset More...
 
Accessors / Modifiers
double weight () const
 returns the weight assigned to the apriori More...
 
allocator_type getAllocator () const
 returns the allocator used by the internal apriori More...
 

Public Types

using type = AprioriDirichletType
 the type of the a priori More...
 
using allocator_type = ALLOC< NodeId >
 type for the allocators passed in arguments of methods More...
 

Protected Attributes

double _weight {1.0}
 the weight of the apriori More...
 
const DatabaseTable< ALLOC > * _database
 a reference to the database in order to have access to its variables More...
 
Bijection< NodeId, std::size_t, ALLOC< std::size_t > > _nodeId2columns
 a mapping from the NodeIds of the variables to the indices of the columns in the database More...
 

Detailed Description

template<template< typename > class ALLOC = std::allocator>
class gum::learning::AprioriDirichletFromDatabase< ALLOC >

A dirichlet priori: computes its N'_ijk from a database.

Definition at line 44 of file aprioriDirichletFromDatabase.h.

Member Typedef Documentation

◆ allocator_type

template<template< typename > class ALLOC = std::allocator>
using gum::learning::AprioriDirichletFromDatabase< ALLOC >::allocator_type = ALLOC< NodeId >

type for the allocators passed in arguments of methods

Definition at line 50 of file aprioriDirichletFromDatabase.h.

◆ type

template<template< typename > class ALLOC = std::allocator>
using gum::learning::AprioriDirichletFromDatabase< ALLOC >::type = AprioriDirichletType

the type of the a priori

Definition at line 47 of file aprioriDirichletFromDatabase.h.

Constructor & Destructor Documentation

◆ AprioriDirichletFromDatabase() [1/5]

template<template< typename > class ALLOC = std::allocator>
gum::learning::AprioriDirichletFromDatabase< ALLOC >::AprioriDirichletFromDatabase ( const DatabaseTable< ALLOC > &  learning_db,
const DBRowGeneratorParser< ALLOC > &  apriori_parser,
const Bijection< NodeId, std::size_t, ALLOC< std::size_t > > &  nodeId2columns = BijectionNodeId, std::size_t, ALLOC< std::size_t > >(),
const allocator_type alloc = allocator_type() 
)

default constructor

Parameters
learning_dbthe database from which learning is performed. This is useful to get access to the random variables
apriori_parserthe parser used to parse the apriori database
nodeId2Columnsa mapping from the ids of the nodes in the graphical model to the corresponding column in learning_db. 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.
allocthe allocator used to allocate the structures within the RecordCounter.
Exceptions
DatabaseErrorThe apriori database may differ from the learning database, i.e., the apriori may have more nodes than the learning one. However, a check is performed to ensure that the variables within the apriori database that correspond to those in the learning database (they have the same names) are exactly identical. If this is not the case, then a DatabaseError exception is raised.

◆ AprioriDirichletFromDatabase() [2/5]

template<template< typename > class ALLOC = std::allocator>
gum::learning::AprioriDirichletFromDatabase< ALLOC >::AprioriDirichletFromDatabase ( const AprioriDirichletFromDatabase< ALLOC > &  from)

copy constructor

◆ AprioriDirichletFromDatabase() [3/5]

template<template< typename > class ALLOC = std::allocator>
gum::learning::AprioriDirichletFromDatabase< ALLOC >::AprioriDirichletFromDatabase ( const AprioriDirichletFromDatabase< ALLOC > &  from,
const allocator_type alloc 
)

copy constructor with a given allocator

◆ AprioriDirichletFromDatabase() [4/5]

template<template< typename > class ALLOC = std::allocator>
gum::learning::AprioriDirichletFromDatabase< ALLOC >::AprioriDirichletFromDatabase ( AprioriDirichletFromDatabase< ALLOC > &&  from)

move constructor

◆ AprioriDirichletFromDatabase() [5/5]

template<template< typename > class ALLOC = std::allocator>
gum::learning::AprioriDirichletFromDatabase< ALLOC >::AprioriDirichletFromDatabase ( AprioriDirichletFromDatabase< ALLOC > &&  from,
const allocator_type alloc 
)

move constructor with a given allocator

◆ ~AprioriDirichletFromDatabase()

template<template< typename > class ALLOC = std::allocator>
virtual gum::learning::AprioriDirichletFromDatabase< ALLOC >::~AprioriDirichletFromDatabase ( )
virtual

destructor

Member Function Documentation

◆ addAllApriori()

template<template< typename > class ALLOC = std::allocator>
virtual void gum::learning::AprioriDirichletFromDatabase< ALLOC >::addAllApriori ( const IdSet< ALLOC > &  idset,
std::vector< double, ALLOC< double > > &  counts 
)
finalvirtual

adds the apriori to a counting vector corresponding to the idset

adds the apriori 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.

Warning
the method assumes that the size of the vector is exactly the domain size of the joint variables set.

Implements gum::learning::Apriori< ALLOC >.

◆ addConditioningApriori()

template<template< typename > class ALLOC = std::allocator>
virtual void gum::learning::AprioriDirichletFromDatabase< ALLOC >::addConditioningApriori ( const IdSet< ALLOC > &  idset,
std::vector< double, ALLOC< double > > &  counts 
)
finalvirtual

adds the apriori to a counting vectordefined over the right hand side of the idset

Warning
the method assumes that the size of the vector is exactly the domain size of the joint RHS variables of the idset.

Implements gum::learning::Apriori< ALLOC >.

◆ clone() [1/2]

template<template< typename > class ALLOC = std::allocator>
virtual AprioriDirichletFromDatabase< ALLOC >* gum::learning::AprioriDirichletFromDatabase< ALLOC >::clone ( ) const
virtual

virtual copy constructor

Implements gum::learning::Apriori< ALLOC >.

◆ clone() [2/2]

template<template< typename > class ALLOC = std::allocator>
virtual AprioriDirichletFromDatabase< ALLOC >* gum::learning::AprioriDirichletFromDatabase< ALLOC >::clone ( const allocator_type alloc) const
virtual

virtual copy constructor with a given allocator

Implements gum::learning::Apriori< ALLOC >.

◆ getAllocator()

template<template< typename > class ALLOC = std::allocator>
allocator_type gum::learning::Apriori< ALLOC >::getAllocator ( ) const
inherited

returns the allocator used by the internal apriori

◆ getType()

template<template< typename > class ALLOC = std::allocator>
virtual const std::string& gum::learning::AprioriDirichletFromDatabase< ALLOC >::getType ( ) const
finalvirtual

returns the type of the apriori

Implements gum::learning::Apriori< ALLOC >.

◆ isInformative()

template<template< typename > class ALLOC = std::allocator>
virtual bool gum::learning::AprioriDirichletFromDatabase< ALLOC >::isInformative ( ) const
finalvirtual

indicates whether the apriori is potentially informative

Basically, only the NoApriori is uninformative. However, it may happen that, under some circonstances, an apriori, which is usually not equal to the NoApriori, becomes equal to it (e.g., when the weight is equal to zero). In this case, if the apriori 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 apriori in their computations.

Implements gum::learning::Apriori< ALLOC >.

◆ isOfType()

template<template< typename > class ALLOC = std::allocator>
virtual bool gum::learning::AprioriDirichletFromDatabase< ALLOC >::isOfType ( const std::string &  type)
finalvirtual

indicates whether an apriori is of a certain type

Implements gum::learning::Apriori< ALLOC >.

◆ operator=() [1/2]

template<template< typename > class ALLOC = std::allocator>
AprioriDirichletFromDatabase< ALLOC >& gum::learning::AprioriDirichletFromDatabase< ALLOC >::operator= ( const AprioriDirichletFromDatabase< ALLOC > &  from)

copy operator

◆ operator=() [2/2]

template<template< typename > class ALLOC = std::allocator>
AprioriDirichletFromDatabase< ALLOC >& gum::learning::AprioriDirichletFromDatabase< ALLOC >::operator= ( AprioriDirichletFromDatabase< ALLOC > &&  from)

move operator

◆ setWeight()

template<template< typename > class ALLOC = std::allocator>
virtual void gum::learning::AprioriDirichletFromDatabase< ALLOC >::setWeight ( const double  weight)
finalvirtual

sets the weight of the a priori (kind of effective sample size)

Reimplemented from gum::learning::Apriori< ALLOC >.

◆ weight()

template<template< typename > class ALLOC = std::allocator>
double gum::learning::Apriori< ALLOC >::weight ( ) const
inherited

returns the weight assigned to the apriori

Member Data Documentation

◆ _database

template<template< typename > class ALLOC = std::allocator>
const DatabaseTable< ALLOC >* gum::learning::Apriori< ALLOC >::_database
protectedinherited

a reference to the database in order to have access to its variables

Definition at line 143 of file apriori.h.

◆ _nodeId2columns

template<template< typename > class ALLOC = std::allocator>
Bijection< NodeId, std::size_t, ALLOC< std::size_t > > gum::learning::Apriori< ALLOC >::_nodeId2columns
protectedinherited

a mapping from the NodeIds of the variables to the indices of the columns in the database

Definition at line 147 of file apriori.h.

◆ _weight

template<template< typename > class ALLOC = std::allocator>
double gum::learning::Apriori< ALLOC >::_weight {1.0}
protectedinherited

the weight of the apriori

Definition at line 140 of file apriori.h.


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