mlpack  2.2.5
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...

 

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 28 of file incomplete_incremental_termination.hpp.

Constructor & Destructor Documentation

◆ IncompleteIncrementalTermination()

IncompleteIncrementalTermination ( TerminationPolicy  tPolicy = TerminationPolicy())
inline

Empty constructor.

Parameters
tPolicyobject of wrapped class.

Definition at line 36 of file incomplete_incremental_termination.hpp.

Member Function Documentation

◆ Index()

const double& Index ( ) const
inline

Get current value of residue.

Definition at line 75 of file incomplete_incremental_termination.hpp.

◆ Initialize()

void Initialize ( const MatType &  V)
inline

Initializes the termination policy before stating the factorization.

Parameters
VInput matrix to be factorized.

Definition at line 46 of file incomplete_incremental_termination.hpp.

◆ IsConverged()

bool IsConverged ( arma::mat &  W,
arma::mat &  H 
)
inline

Check if termination criterio is met.

Parameters
WBasis matrix of output.
HEncoding matrix of output.

Definition at line 61 of file incomplete_incremental_termination.hpp.

◆ Iteration()

const size_t& Iteration ( ) const
inline

Get current iteration count.

Definition at line 78 of file incomplete_incremental_termination.hpp.

◆ MaxIterations() [1/2]

size_t MaxIterations ( ) const
inline

Access maximum number of iterations.

Definition at line 81 of file incomplete_incremental_termination.hpp.

◆ MaxIterations() [2/2]

size_t& MaxIterations ( )
inline

Modify maximum number of iterations.

Definition at line 83 of file incomplete_incremental_termination.hpp.

◆ TPolicy() [1/2]

const TerminationPolicy& TPolicy ( ) const
inline

Access the wrapped termination policy.

Definition at line 86 of file incomplete_incremental_termination.hpp.

◆ TPolicy() [2/2]

TerminationPolicy& TPolicy ( )
inline

Modify the wrapped termination policy.

Definition at line 88 of file incomplete_incremental_termination.hpp.


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