planc::HALSNMF< T > Class Template Reference

#include <hals.hpp>

Public Member Functions
	HALSNMF (const T &A, int lowrank)
	HALSNMF (const T &A, const MAT &llf, const MAT &rlf)
void	computeNMF ()
	~HALSNMF ()
MAT	getLeftLowRankFactor ()
	Returns the left low rank factor matrix W. More...
MAT	getRightLowRankFactor ()
	Returns the right low rank factor matrix H. More...
void	computeObjectiveError ()
void	computeObjectiveError (const T &At, const MAT &WtW, const MAT &HtH)
void	num_iterations (const int it)
	Sets number of iterations for the NMF algorithms. More...
const unsigned int	num_iterations () const
	Returns the number of iterations. More...
void	regW (const FVEC &iregW)
	Sets the regularization on left low rank factor W. More...
FVEC	regW ()
	Returns the L2 and L1 regularization parameters of W as a vector. More...
void	regH (const FVEC &iregH)
	Sets the regularization on right low rank H. More...
FVEC	regH ()
	Returns the L2 and L1 regularization parameters of W as a vector. More...
void	clear ()
	Clear the memory for input matrix A, right low rank factor W and left low rank factor H. More...

Detailed Description

template<class T>
class planc::HALSNMF< T >

Definition at line 11 of file hals.hpp.

Inheritance diagram for planc::HALSNMF< T >:

Constructor & Destructor Documentation

HALSNMF() [1/2]

template<class T>

planc::HALSNMF< T >::HALSNMF ( const T &  A, int  lowrank  )

inline

Definition at line 40 of file hals.hpp.

HALSNMF() [2/2]

template<class T>

planc::HALSNMF< T >::HALSNMF ( const T &  A, const MAT &  llf, const MAT &  rlf  )

inline

Definition at line 45 of file hals.hpp.

~HALSNMF()

template<class T>

planc::HALSNMF< T >::~HALSNMF ( )

inline

Definition at line 116 of file hals.hpp.

Member Function Documentation

clear()

template<class T>

void planc::NMF< T >::clear ( )

inlineinherited

Clear the memory for input matrix A, right low rank factor W and left low rank factor H.

Definition at line 355 of file nmf.hpp.

computeNMF()

template<class T>

void planc::HALSNMF< T >::computeNMF ( )

inlinevirtual

Implements planc::NMF< T >.

Definition at line 50 of file hals.hpp.

computeObjectiveError() [1/2]

template<class T>

void planc::NMF< T >::computeObjectiveError ( )

inlineinherited

Definition at line 238 of file nmf.hpp.

computeObjectiveError() [2/2]

template<class T>

void planc::NMF< T >::computeObjectiveError ( const T &  At, const MAT &  WtW, const MAT &  HtH  )

inlineinherited

Definition at line 330 of file nmf.hpp.

getLeftLowRankFactor()

template<class T>

MAT planc::NMF< T >::getLeftLowRankFactor ( )

inlineinherited

Returns the left low rank factor matrix W.

Definition at line 167 of file nmf.hpp.

getRightLowRankFactor()

template<class T>

MAT planc::NMF< T >::getRightLowRankFactor ( )

inlineinherited

Returns the right low rank factor matrix H.

Definition at line 169 of file nmf.hpp.

num_iterations() [1/2]

template<class T>

void planc::NMF< T >::num_iterations ( const int  it )

inlineinherited

Sets number of iterations for the NMF algorithms.

Definition at line 340 of file nmf.hpp.

num_iterations() [2/2]

template<class T>

const unsigned int planc::NMF< T >::num_iterations ( ) const

inlineinherited

Returns the number of iterations.

Definition at line 350 of file nmf.hpp.

regH() [1/2]

template<class T>

void planc::NMF< T >::regH ( const FVEC &  iregH )

inlineinherited

Sets the regularization on right low rank H.

Definition at line 344 of file nmf.hpp.

regH() [2/2]

template<class T>

FVEC planc::NMF< T >::regH ( )

inlineinherited

Returns the L2 and L1 regularization parameters of W as a vector.

Definition at line 348 of file nmf.hpp.

regW() [1/2]

template<class T>

void planc::NMF< T >::regW ( const FVEC &  iregW )

inlineinherited

Sets the regularization on left low rank factor W.

Definition at line 342 of file nmf.hpp.

regW() [2/2]

template<class T>

FVEC planc::NMF< T >::regW ( )

inlineinherited

Returns the L2 and L1 regularization parameters of W as a vector.

Definition at line 346 of file nmf.hpp.

---

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

• /Users/rnu/Documents/research/nmflibrary/nmf/hals.hpp