#include <BNdistance.h>

Inheritance diagram for gum::BNdistance< GUM_SCALAR >:

Collaboration diagram for gum::BNdistance< GUM_SCALAR >:

Public Member Functions
	BNdistance (const IBayesNet< GUM_SCALAR > &P, const IBayesNet< GUM_SCALAR > &Q)
	constructor must give 2 BNs
	BNdistance (const BNdistance< GUM_SCALAR > &kl)
	copy constructor
virtual	~BNdistance ()
	destructor
Complexity	difficulty () const
	return KL::Complexity::Heavy,KL::Complexity::Difficult,KL::Complexity::Correct depending on the BNs p and q
Accessors to results. The first call do the computations. The
others do not.
double	klPQ ()
Size	errorPQ ()
double	klQP ()
Size	errorQP ()
double	hellinger ()
double	bhattacharya ()
double	jsd ()
const IBayesNet< GUM_SCALAR > &	p () const
const IBayesNet< GUM_SCALAR > &	q () const

Protected Member Functions
virtual void	computeKL_ ()
void	process_ ()

Protected Attributes
const IBayesNet< GUM_SCALAR > &	p_
const IBayesNet< GUM_SCALAR > &	q_
GUM_SCALAR	klPQ_
GUM_SCALAR	klQP_
Size	errorPQ_
Size	errorQP_
GUM_SCALAR	hellinger_
GUM_SCALAR	bhattacharya_
GUM_SCALAR	jsd_

Private Member Functions
bool	_checkCompatibility_ () const

Private Attributes
Complexity	_difficulty_
bool	_done_

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::BNdistance< GUM_SCALAR >

Definition at line 86 of file BNdistance.h.

Constructor & Destructor Documentation

◆ BNdistance() [1/2]

template<GUM_Numeric GUM_SCALAR>

gum::BNdistance< GUM_SCALAR >::BNdistance	(	const IBayesNet< GUM_SCALAR > &	P,
		const IBayesNet< GUM_SCALAR > &	Q )

constructor must give 2 BNs

Exceptions

gum::OperationNotAllowed if the 2 BNs have not the same domainSize or compatible node sets.

Definition at line 60 of file BNdistance_tpl.h.

                                                                         :
      p_(P), q_(Q), klPQ_(0.0), klQP_(0.0), errorPQ_(0), errorQP_(0),
      _difficulty_(Complexity::Heavy), _done_(false) {
    _checkCompatibility_();   // may throw OperationNotAllowed
    GUM_CONSTRUCTOR(BNdistance);
 
    double diff = p_.log10DomainSize();
 
    if (diff > GAP_COMPLEXITY_KL_HEAVY_DIFFICULT) _difficulty_ = Complexity::Heavy;
    else if (diff > GAP_COMPLEXITY_KL_DIFFICULT_CORRECT) _difficulty_ = Complexity::Difficult;
    else _difficulty_ = Complexity::Correct;
  }

References BNdistance(), _checkCompatibility_(), _difficulty_, _done_, gum::Correct, gum::Difficult, errorPQ_, errorQP_, GAP_COMPLEXITY_KL_DIFFICULT_CORRECT, GAP_COMPLEXITY_KL_HEAVY_DIFFICULT, gum::Heavy, klPQ_, klQP_, p_, and q_.

Referenced by BNdistance(), BNdistance(), gum::ExactBNdistance< GUM_SCALAR >::ExactBNdistance(), gum::ExactBNdistance< GUM_SCALAR >::ExactBNdistance(), gum::GibbsBNdistance< GUM_SCALAR >::GibbsBNdistance(), gum::GibbsBNdistance< GUM_SCALAR >::GibbsBNdistance(), and ~BNdistance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ BNdistance() [2/2]

template<GUM_Numeric GUM_SCALAR>

gum::BNdistance< GUM_SCALAR >::BNdistance ( const BNdistance< GUM_SCALAR > & kl )

copy constructor

Definition at line 75 of file BNdistance_tpl.h.

                                                                         :
      p_(kl.p_), q_(kl.q_), klPQ_(kl.klPQ_), klQP_(kl.klQP_), errorPQ_(kl.errorPQ_),
      errorQP_(kl.errorQP_), _difficulty_(kl._difficulty_), _done_(kl._done_) {
    GUM_CONSTRUCTOR(BNdistance);
  }

References BNdistance(), _difficulty_, _done_, errorPQ_, errorQP_, klPQ_, klQP_, p_, and q_.

Here is the call graph for this function:

◆ ~BNdistance()

template<GUM_Numeric GUM_SCALAR>

gum::BNdistance< GUM_SCALAR >::~BNdistance ( )

virtual

destructor

Definition at line 82 of file BNdistance_tpl.h.

                                        {
    GUM_DESTRUCTOR(BNdistance);
  }

References BNdistance().

Here is the call graph for this function:

Member Function Documentation

◆ _checkCompatibility_()

template<GUM_Numeric GUM_SCALAR>

bool gum::BNdistance< GUM_SCALAR >::_checkCompatibility_ ( ) const

private

Definition at line 145 of file BNdistance_tpl.h.

                                                            {
    // should not be used
    if (p_.size() != q_.size())
      GUM_ERROR(OperationNotAllowed,
                "BNdistance : the 2 BNs are not compatible (not the same size)")
 
    for (auto node: p_.nodes()) {
      const DiscreteVariable& vp = p_.variable(node);
      if (!q_.exists(vp.name())) {
        GUM_ERROR(OperationNotAllowed,
                  "BNdistance : the 2 BNs are not compatible (variable : " + vp.name() + ")");
      }
      const DiscreteVariable& vq = q_.variableFromName(vp.name());
      if (vp != vq)
        GUM_ERROR(OperationNotAllowed,
                  "BNdistance : the 2 BNs are not compatible "
                  "(not the same variable for the same name : "
                      + vp.toString() + "and " + vq.toString() + ")");
    }
 
    if (std::fabs(p_.log10DomainSize() - q_.log10DomainSize()) > 1e-14) {
      GUM_ERROR(OperationNotAllowed,
                "BNdistance : the 2 BNs are not compatible (not the same domainSize) : p="
                    << p_.log10DomainSize() << " q=" << q_.log10DomainSize() << " => "
                    << p_.log10DomainSize() - q_.log10DomainSize());
    }
 
    return true;
  }

References GUM_ERROR, gum::Variable::name(), p_, q_, and gum::DiscreteVariable::toString().

Referenced by BNdistance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bhattacharya()

template<GUM_Numeric GUM_SCALAR>

double gum::BNdistance< GUM_SCALAR >::bhattacharya ( )

Returns: Bhattacharya distance (

See also: http://en.wikipedia.org/wiki/Bhattacharya_distance)

Definition at line 110 of file BNdistance_tpl.h.

                                                {
    process_();
    return bhattacharya_;
  }

References bhattacharya_, and process_().

Here is the call graph for this function:

◆ computeKL_()

template<GUM_Numeric GUM_SCALAR>

void gum::BNdistance< GUM_SCALAR >::computeKL_ ( )

protectedvirtual

Reimplemented in gum::ExactBNdistance< GUM_SCALAR >, and gum::GibbsBNdistance< GUM_SCALAR >.

Definition at line 186 of file BNdistance_tpl.h.

                                            {
    GUM_ERROR(OperationNotAllowed, "No default computations")
  }

References GUM_ERROR.

Referenced by process_().

Here is the caller graph for this function:

◆ difficulty()

template<GUM_Numeric GUM_SCALAR>

Complexity gum::BNdistance< GUM_SCALAR >::difficulty ( ) const

return KL::Complexity::Heavy,KL::Complexity::Difficult,KL::Complexity::Correct depending on the BNs p and q

Definition at line 87 of file BNdistance_tpl.h.

                                                        {
    return _difficulty_;
  }

References _difficulty_.

◆ errorPQ()

template<GUM_Numeric GUM_SCALAR>

Size gum::BNdistance< GUM_SCALAR >::errorPQ ( )

Returns: the number of errors while processing divergence KL(P||Q)

Definition at line 122 of file BNdistance_tpl.h.

                                         {
    process_();
    return errorPQ_;
  }

References errorPQ_, and process_().

Here is the call graph for this function:

◆ errorQP()

template<GUM_Numeric GUM_SCALAR>

Size gum::BNdistance< GUM_SCALAR >::errorQP ( )

Returns: the number of errors while processing divergence KL(Q||P)

Definition at line 128 of file BNdistance_tpl.h.

                                         {
    process_();
    return errorQP_;
  }

References errorQP_, and process_().

Here is the call graph for this function:

◆ hellinger()

template<GUM_Numeric GUM_SCALAR>

double gum::BNdistance< GUM_SCALAR >::hellinger ( )

Returns: hellinger distance (

See also: http://en.wikipedia.org/wiki/Hellinger_distance)

Definition at line 104 of file BNdistance_tpl.h.

                                             {
    process_();
    return hellinger_;
  }

References hellinger_, and process_().

Here is the call graph for this function:

◆ jsd()

template<GUM_Numeric GUM_SCALAR>

double gum::BNdistance< GUM_SCALAR >::jsd ( )

Returns: Jensen-Shannon divergence(

See also: https://en.wikipedia.org/wiki/Jensen%E2%80%93Shannon_divergence)

Definition at line 116 of file BNdistance_tpl.h.

                                       {
    process_();
    return jsd_;
  }

References jsd_, and process_().

Here is the call graph for this function:

◆ klPQ()

template<GUM_Numeric GUM_SCALAR>

double gum::BNdistance< GUM_SCALAR >::klPQ ( )

Returns: divergence KL(P||Q)

Definition at line 92 of file BNdistance_tpl.h.

                                        {
    process_();
    return klPQ_;
  }

References klPQ_, and process_().

Here is the call graph for this function:

◆ klQP()

template<GUM_Numeric GUM_SCALAR>

double gum::BNdistance< GUM_SCALAR >::klQP ( )

Returns: divergence KL(Q||P)

Definition at line 98 of file BNdistance_tpl.h.

                                        {
    process_();
    return klQP_;
  }

References klQP_, and process_().

Here is the call graph for this function:

◆ p()

template<GUM_Numeric GUM_SCALAR>

const IBayesNet< GUM_SCALAR > & gum::BNdistance< GUM_SCALAR >::p ( ) const

Returns: p

Definition at line 134 of file BNdistance_tpl.h.

                                                                   {
    return p_;
  }

References p_.

Referenced by gum::GibbsBNdistance< GUM_SCALAR >::GibbsBNdistance().

Here is the caller graph for this function:

◆ process_()

template<GUM_Numeric GUM_SCALAR>

void gum::BNdistance< GUM_SCALAR >::process_ ( )

protected

Definition at line 177 of file BNdistance_tpl.h.

                                          {
    if (!_done_) {
      computeKL_();
      _done_ = true;
    }
  }

References _done_, and computeKL_().

Referenced by bhattacharya(), errorPQ(), errorQP(), hellinger(), jsd(), klPQ(), and klQP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ q()

template<GUM_Numeric GUM_SCALAR>

const IBayesNet< GUM_SCALAR > & gum::BNdistance< GUM_SCALAR >::q ( ) const

Returns: q

Definition at line 139 of file BNdistance_tpl.h.

                                                                   {
    return q_;
  }

References q_.

Member Data Documentation

◆ _difficulty_

template<GUM_Numeric GUM_SCALAR>

Complexity gum::BNdistance< GUM_SCALAR >::_difficulty_

private

Definition at line 171 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), and difficulty().

◆ _done_

template<GUM_Numeric GUM_SCALAR>

bool gum::BNdistance< GUM_SCALAR >::_done_

private

Definition at line 172 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), and process_().

◆ bhattacharya_

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::bhattacharya_

protected

Definition at line 166 of file BNdistance.h.

Referenced by bhattacharya(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), and gum::GibbsBNdistance< GUM_SCALAR >::computeKL_().

◆ errorPQ_

template<GUM_Numeric GUM_SCALAR>

Size gum::BNdistance< GUM_SCALAR >::errorPQ_

protected

Definition at line 162 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and errorPQ().

◆ errorQP_

template<GUM_Numeric GUM_SCALAR>

Size gum::BNdistance< GUM_SCALAR >::errorQP_

protected

Definition at line 163 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and errorQP().

◆ hellinger_

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::hellinger_

protected

Definition at line 165 of file BNdistance.h.

Referenced by gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and hellinger().

◆ jsd_

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::jsd_

protected

Definition at line 167 of file BNdistance.h.

Referenced by gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and jsd().

◆ klPQ_

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::klPQ_

protected

Definition at line 159 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and klPQ().

◆ klQP_

template<GUM_Numeric GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::klQP_

protected

Definition at line 160 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and klQP().

◆ p_

template<GUM_Numeric GUM_SCALAR>

const IBayesNet< GUM_SCALAR >& gum::BNdistance< GUM_SCALAR >::p_

protected

Definition at line 156 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), _checkCompatibility_(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and p().

◆ q_

template<GUM_Numeric GUM_SCALAR>

const IBayesNet< GUM_SCALAR >& gum::BNdistance< GUM_SCALAR >::q_

protected

Definition at line 157 of file BNdistance.h.

Referenced by BNdistance(), BNdistance(), _checkCompatibility_(), gum::ExactBNdistance< GUM_SCALAR >::computeKL_(), gum::GibbsBNdistance< GUM_SCALAR >::computeKL_(), and q().

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

agrum/BN/algorithms/divergence/BNdistance.h
agrum/BN/algorithms/divergence/BNdistance_tpl.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BNdistance() [1/2]

◆ BNdistance() [2/2]

◆ ~BNdistance()

Member Function Documentation

◆ _checkCompatibility_()

◆ bhattacharya()

◆ computeKL_()

◆ difficulty()

◆ errorPQ()

◆ errorQP()

◆ hellinger()

◆ jsd()

◆ klPQ()

◆ klQP()

◆ p()

◆ process_()

◆ q()

Member Data Documentation

◆ _difficulty_

◆ _done_

◆ bhattacharya_

◆ errorPQ_

◆ errorQP_

◆ hellinger_

◆ jsd_

◆ klPQ_

◆ klQP_

◆ p_

◆ q_