mlpack  2.0.1
Public Member Functions | Private Attributes | List of all members
mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy > Class Template Reference

This class acts as a wrapper for basic termination policies to be used by SVDIncompleteIncrementalLearning. More...

Public Member Functions

 IncompleteIncrementalTermination (TerminationPolicy tPolicy=TerminationPolicy())
 Empty constructor. More...
 
const double & Index () const
 Get current value of residue. More...
 
template<class MatType >
void Initialize (const MatType &V)
 Initializes the termination policy before stating the factorization. More...
 
bool IsConverged (arma::mat &W, arma::mat &H)
 Check if termination criterio is met. More...
 
const size_t & Iteration () const
 Get current iteration count. More...
 
size_t MaxIterations () const
 Access maximum number of iterations. More...
 
size_t & MaxIterations ()
 Modify maximum number of iterations. More...
 
const TerminationPolicy & TPolicy () const
 Access the wrapped termination policy. More...
 
TerminationPolicy & TPolicy ()
 Modify the wrapped termination policy. More...
 

Private Attributes

size_t incrementalIndex
 Number of iterations after which wrapped class object will be called. More...
 
size_t iteration
 Current iteration count. More...
 
TerminationPolicy tPolicy
 Wrapped termination policy. More...
 

Detailed Description

template<class TerminationPolicy>
class mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >

This class acts as a wrapper for basic termination policies to be used by SVDIncompleteIncrementalLearning.

This class calls the wrapped class functions after every n calls to main class functions where n is the number of rows.

See also
AMF, SVDIncompleteIncrementalLearning

Definition at line 30 of file incomplete_incremental_termination.hpp.

Constructor & Destructor Documentation

◆ IncompleteIncrementalTermination()

template<class TerminationPolicy >
mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::IncompleteIncrementalTermination ( TerminationPolicy  tPolicy = TerminationPolicy())
inline

Empty constructor.

Parameters
tPolicyobject of wrapped class.

Definition at line 38 of file incomplete_incremental_termination.hpp.

Member Function Documentation

◆ Index()

template<class TerminationPolicy >
const double& mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Index ( ) const
inline

◆ Initialize()

template<class TerminationPolicy >
template<class MatType >
void mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Initialize ( const MatType &  V)
inline

◆ IsConverged()

template<class TerminationPolicy >
bool mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::IsConverged ( arma::mat &  W,
arma::mat &  H 
)
inline

◆ Iteration()

template<class TerminationPolicy >
const size_t& mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Iteration ( ) const
inline

◆ MaxIterations() [1/2]

template<class TerminationPolicy >
size_t mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::MaxIterations ( ) const
inline

Access maximum number of iterations.

Definition at line 83 of file incomplete_incremental_termination.hpp.

References mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy.

◆ MaxIterations() [2/2]

template<class TerminationPolicy >
size_t& mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::MaxIterations ( )
inline

Modify maximum number of iterations.

Definition at line 85 of file incomplete_incremental_termination.hpp.

References mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy.

◆ TPolicy() [1/2]

template<class TerminationPolicy >
const TerminationPolicy& mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::TPolicy ( ) const
inline

Access the wrapped termination policy.

Definition at line 88 of file incomplete_incremental_termination.hpp.

References mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy.

◆ TPolicy() [2/2]

template<class TerminationPolicy >
TerminationPolicy& mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::TPolicy ( )
inline

Modify the wrapped termination policy.

Definition at line 90 of file incomplete_incremental_termination.hpp.

References mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy.

Member Data Documentation

◆ incrementalIndex

template<class TerminationPolicy >
size_t mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::incrementalIndex
private

◆ iteration

template<class TerminationPolicy >
size_t mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::iteration
private

◆ tPolicy

template<class TerminationPolicy >
TerminationPolicy mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy
private

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