gum::BNdistance< GUM_SCALAR > Class Template Reference

#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 More...
	BNdistance (const BNdistance< GUM_SCALAR > &kl)
	copy constructor More...
virtual	~BNdistance ()
	destructor More...
Complexity	difficulty () const
	return KL::Complexity::Heavy,KL::Complexity::Difficult,KL::Complexity::Correct depending on the BNs __p and __q More...
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 Attributes
const IBayesNet< GUM_SCALAR > &	_p
const IBayesNet< GUM_SCALAR > &	_q
GUM_SCALAR	_klPQ
GUM_SCALAR	_klQP
GUM_SCALAR	_hellinger
GUM_SCALAR	_bhattacharya
GUM_SCALAR	_jsd
Size	_errorPQ
Size	_errorQP

Protected Member Functions
virtual void	_computeKL ()
void	_process ()

Detailed Description

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

Definition at line 68 of file BNdistance.h.

Constructor & Destructor Documentation

BNdistance() [1/2]

template<typename 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 38 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::__checkCompatibility(), gum::BNdistance< GUM_SCALAR >::__difficulty, gum::BNdistance< GUM_SCALAR >::_p, gum::Correct, gum::Difficult, GAP_COMPLEXITY_KL_DIFFICULT_CORRECT, GAP_COMPLEXITY_KL_HEAVY_DIFFICULT, and gum::Heavy.

                                                                         :
      _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;
  }

Here is the call graph for this function:

BNdistance() [2/2]

template<typename GUM_SCALAR >

gum::BNdistance< GUM_SCALAR >::BNdistance

(

const BNdistance< GUM_SCALAR > &

kl

)

copy constructor

Definition at line 57 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);
  }

~BNdistance()

template<typename GUM_SCALAR >

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

virtual

destructor

Definition at line 65 of file BNdistance_tpl.h.

                                        {
    GUM_DESTRUCTOR(BNdistance);
  }

Member Function Documentation

__checkCompatibility()

template<typename GUM_SCALAR >

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

private

Definition at line 128 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_p, gum::BNdistance< GUM_SCALAR >::_q, gum::DiscreteVariable::domainSize(), GUM_ERROR, gum::DiscreteVariable::label(), and gum::Variable::name().

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

                                                            {
    for (auto node : _p.nodes()) {
      const DiscreteVariable& vp = _p.variable(node);

      try {
        const DiscreteVariable& vq = _q.variableFromName(vp.name());

        if (vp.domainSize() != vq.domainSize())
          GUM_ERROR(OperationNotAllowed,
                    "BNdistance : the 2 BNs are not compatible "
                    "(not the same domainSize for "
                       + vp.name() + ")");

        for (Idx i = 0; i < vp.domainSize(); i++) {
          try {
            vq[vp.label(i)];
            vp[vq.label(i)];

          } catch (OutOfBounds&) {
            GUM_ERROR(OperationNotAllowed,
                      "BNdistance : the 2 BNs are not compatible F(not the same "
                      "labels for "
                         + vp.name() + ")");
          }
        }
      } catch (NotFound&) {
        GUM_ERROR(OperationNotAllowed,
                  "BNdistance : the 2 BNs are not compatible (not the same vars : "
                     + vp.name() + ")");
      }
    }

    // should not be used
    if (_p.size() != _q.size())
      GUM_ERROR(OperationNotAllowed,
                "BNdistance : the 2 BNs are not compatible (not the same size)");

    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;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

_computeKL()

template<typename GUM_SCALAR >

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

protectedvirtual

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

Definition at line 187 of file BNdistance_tpl.h.

References GUM_ERROR.

Referenced by gum::BNdistance< GUM_SCALAR >::_process().

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

Here is the caller graph for this function:

_process()

template<typename GUM_SCALAR >

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

protected

Definition at line 178 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::__done, and gum::BNdistance< GUM_SCALAR >::_computeKL().

Referenced by gum::BNdistance< GUM_SCALAR >::bhattacharya(), gum::BNdistance< GUM_SCALAR >::errorPQ(), gum::BNdistance< GUM_SCALAR >::errorQP(), gum::BNdistance< GUM_SCALAR >::hellinger(), gum::BNdistance< GUM_SCALAR >::jsd(), gum::BNdistance< GUM_SCALAR >::klPQ(), and gum::BNdistance< GUM_SCALAR >::klQP().

                                          {
    if (!__done) {
      _computeKL();
      __done = true;
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bhattacharya()

template<typename GUM_SCALAR >

INLINE double gum::BNdistance< GUM_SCALAR >::bhattacharya

(

)

Returns

Bhattacharya distance (

See also

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

Definition at line 93 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_bhattacharya, and gum::BNdistance< GUM_SCALAR >::_process().

                                                       {
    _process();
    return _bhattacharya;
  }

Here is the call graph for this function:

difficulty()

template<typename 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 70 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::__difficulty.

                                                        {
    return __difficulty;
  }

errorPQ()

template<typename GUM_SCALAR >

INLINE Size gum::BNdistance< GUM_SCALAR >::errorPQ

(

)

Returns

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

Definition at line 105 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_errorPQ, and gum::BNdistance< GUM_SCALAR >::_process().

                                                {
    _process();
    return _errorPQ;
  }

Here is the call graph for this function:

errorQP()

template<typename GUM_SCALAR >

INLINE Size gum::BNdistance< GUM_SCALAR >::errorQP

(

)

Returns

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

Definition at line 111 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_errorQP, and gum::BNdistance< GUM_SCALAR >::_process().

                                                {
    _process();
    return _errorQP;
  }

Here is the call graph for this function:

hellinger()

template<typename GUM_SCALAR >

INLINE double gum::BNdistance< GUM_SCALAR >::hellinger

(

)

Returns

hellinger distance (

See also

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

Definition at line 87 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_hellinger, and gum::BNdistance< GUM_SCALAR >::_process().

                                                    {
    _process();
    return _hellinger;
  }

Here is the call graph for this function:

jsd()

template<typename GUM_SCALAR >

INLINE 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 99 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_jsd, and gum::BNdistance< GUM_SCALAR >::_process().

                                              {
    _process();
    return _jsd;
  }

Here is the call graph for this function:

klPQ()

template<typename GUM_SCALAR >

INLINE double gum::BNdistance< GUM_SCALAR >::klPQ

(

)

Returns

divergence KL(P||Q)

Definition at line 75 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_klPQ, and gum::BNdistance< GUM_SCALAR >::_process().

                                               {
    _process();
    return _klPQ;
  }

Here is the call graph for this function:

klQP()

template<typename GUM_SCALAR >

INLINE double gum::BNdistance< GUM_SCALAR >::klQP

(

)

Returns

divergence KL(Q||P)

Definition at line 81 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_klQP, and gum::BNdistance< GUM_SCALAR >::_process().

                                               {
    _process();
    return _klQP;
  }

Here is the call graph for this function:

p()

template<typename GUM_SCALAR >

INLINE const IBayesNet< GUM_SCALAR > & gum::BNdistance< GUM_SCALAR >::p

(

)

const

Returns

p

Definition at line 117 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_p.

                                                                          {
    return _p;
  }

q()

template<typename GUM_SCALAR >

INLINE const IBayesNet< GUM_SCALAR > & gum::BNdistance< GUM_SCALAR >::q

(

)

const

Returns

q

Definition at line 122 of file BNdistance_tpl.h.

References gum::BNdistance< GUM_SCALAR >::_q.

                                                                          {
    return _q;
  }

Member Data Documentation

__difficulty

template<typename GUM_SCALAR>

Complexity gum::BNdistance< GUM_SCALAR >::__difficulty

private

Definition at line 150 of file BNdistance.h.

Referenced by gum::BNdistance< GUM_SCALAR >::BNdistance(), and gum::BNdistance< GUM_SCALAR >::difficulty().

__done

template<typename GUM_SCALAR>

bool gum::BNdistance< GUM_SCALAR >::__done

private

Definition at line 151 of file BNdistance.h.

Referenced by gum::BNdistance< GUM_SCALAR >::_process().

_bhattacharya

template<typename GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::_bhattacharya

protected

Definition at line 142 of file BNdistance.h.

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

_errorPQ

template<typename GUM_SCALAR>

Size gum::BNdistance< GUM_SCALAR >::_errorPQ

protected

Definition at line 145 of file BNdistance.h.

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

_errorQP

template<typename GUM_SCALAR>

Size gum::BNdistance< GUM_SCALAR >::_errorQP

protected

Definition at line 146 of file BNdistance.h.

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

_hellinger

template<typename GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::_hellinger

protected

Definition at line 141 of file BNdistance.h.

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

_jsd

template<typename GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::_jsd

protected

Definition at line 143 of file BNdistance.h.

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

_klPQ

template<typename GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::_klPQ

protected

Definition at line 139 of file BNdistance.h.

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

_klQP

template<typename GUM_SCALAR>

GUM_SCALAR gum::BNdistance< GUM_SCALAR >::_klQP

protected

Definition at line 140 of file BNdistance.h.

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

_p

template<typename GUM_SCALAR>

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

protected

Definition at line 136 of file BNdistance.h.

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

_q

template<typename GUM_SCALAR>

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

protected

Definition at line 137 of file BNdistance.h.

Referenced by gum::BNdistance< GUM_SCALAR >::__checkCompatibility(), gum::ExactBNdistance< GUM_SCALAR >::_computeKL(), gum::GibbsBNdistance< GUM_SCALAR >::_computeKL(), and gum::BNdistance< GUM_SCALAR >::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