bnmf-algs
Public Member Functions | Public Attributes | List of all members
bnmf_algs::bld::EMResult< T > Struct Template Reference

Structure holding the results of EM procedures. More...

#include <online_EM_defs.hpp>

Public Member Functions

 EMResult ()=default
 Default constructor. More...
 
 EMResult (matrix_t< T > S_pjk, matrix_t< T > S_ipk, matrix_t< T > X_full, matrix_t< T > logW, matrix_t< T > logH, vector_t< T > EM_bound)
 Initialization constructor. More...
 

Public Attributes

matrix_t< T > S_pjk
 Sum of the hidden tensor \(S\) along its first dimension, i.e. \(S_{+jk}\). More...
 
matrix_t< T > S_ipk
 Sum of the hidden tensor \(S\) along its second dimension, i.e. \(S_{i+k}\). More...
 
matrix_t< T > X_full
 Completed version of the incomplete matrix given as input to an EM algorithm. More...
 
matrix_t< double > logW
 Matrix whose \((i, j)^{th}\) entry contains \(\log{W_{ij}}\). More...
 
matrix_t< double > logH
 Matrix whose \((i, j)^{th}\) entry contains \(log{H_{ij}}\). More...
 
vector_t< double > log_PS
 Vector containing EM bound computed after every iteration. More...
 

Detailed Description

template<typename T>
struct bnmf_algs::bld::EMResult< T >

Structure holding the results of EM procedures.

Template Parameters
TType of the matrix/tensor entries.

Constructor & Destructor Documentation

template<typename T>
bnmf_algs::bld::EMResult< T >::EMResult ( )
default

Default constructor.

Default constructor constructs every matrix/vector as empty.

template<typename T>
bnmf_algs::bld::EMResult< T >::EMResult ( matrix_t< T >  S_pjk,
matrix_t< T >  S_ipk,
matrix_t< T >  X_full,
matrix_t< T >  logW,
matrix_t< T >  logH,
vector_t< T >  EM_bound 
)
inline

Initialization constructor.

Every element is move initialized with the given value.

Member Data Documentation

template<typename T>
vector_t<double> bnmf_algs::bld::EMResult< T >::log_PS

Vector containing EM bound computed after every iteration.

template<typename T>
matrix_t<double> bnmf_algs::bld::EMResult< T >::logH

Matrix whose \((i, j)^{th}\) entry contains \(log{H_{ij}}\).

template<typename T>
matrix_t<double> bnmf_algs::bld::EMResult< T >::logW

Matrix whose \((i, j)^{th}\) entry contains \(\log{W_{ij}}\).

template<typename T>
matrix_t<T> bnmf_algs::bld::EMResult< T >::S_ipk

Sum of the hidden tensor \(S\) along its second dimension, i.e. \(S_{i+k}\).

template<typename T>
matrix_t<T> bnmf_algs::bld::EMResult< T >::S_pjk

Sum of the hidden tensor \(S\) along its first dimension, i.e. \(S_{+jk}\).

template<typename T>
matrix_t<T> bnmf_algs::bld::EMResult< T >::X_full

Completed version of the incomplete matrix given as input to an EM algorithm.

EM algorithms take incomplete matrices (NaN entries are not known), and find the optimal values for those empty values. This is the matrix that contains the completed values for those entries.


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