mlpack
2.2.5

The multiplicative distance update rules for matrices W and H. More...
Public Member Functions  
NMFMultiplicativeDistanceUpdate ()  
template < typename MatType >  
void  Initialize (const MatType &, const size_t) 
Initialize the factorization. More...  
template < typename Archive >  
void  Serialize (Archive &, const unsigned int) 
Serialize the object (in this case, there is nothing to serialize). More...  
Static Public Member Functions  
template < typename MatType >  
static void  HUpdate (const MatType &V, const arma::mat &W, arma::mat &H) 
The update rule for the encoding matrix H. More...  
template < typename MatType >  
static void  WUpdate (const MatType &V, arma::mat &W, const arma::mat &H) 
The update rule for the basis matrix W. More...  
Detailed Description
The multiplicative distance update rules for matrices W and H.
This follows a method described in the following paper:
This is a multiplicative rule that ensures that the Frobenius norm is nonincreasing between subsequent iterations. Both of the update rules for W and H are defined in this file.
Definition at line 39 of file nmf_mult_dist.hpp.
Constructor & Destructor Documentation
◆ NMFMultiplicativeDistanceUpdate()

inline 
Definition at line 43 of file nmf_mult_dist.hpp.
Member Function Documentation
◆ HUpdate()

inlinestatic 
The update rule for the encoding matrix H.
The formula used is
The function takes in all the matrices and only changes the value of the H matrix.
 Parameters

V Input matrix to be factorized. W Basis matrix. H Encoding matrix to be updated.
Definition at line 92 of file nmf_mult_dist.hpp.
◆ Initialize()

inline 
Initialize the factorization.
These update rules hold no information, so the input parameters are ignored.
Definition at line 50 of file nmf_mult_dist.hpp.
◆ Serialize()

inline 
Serialize the object (in this case, there is nothing to serialize).
Definition at line 101 of file nmf_mult_dist.hpp.
◆ WUpdate()

inlinestatic 
The update rule for the basis matrix W.
The formula used isa
The function takes in all the matrices and only changes the value of the W matrix.
 Parameters

V Input matrix to be factorized. W Basis matrix to be updated. H Encoding matrix.
Definition at line 70 of file nmf_mult_dist.hpp.
The documentation for this class was generated from the following file:
 src/mlpack/methods/amf/update_rules/nmf_mult_dist.hpp
Generated by 1.8.13