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

Constructor & Destructor Documentation

template<class TerminationPolicy >

mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::IncompleteIncrementalTermination ( TerminationPolicy tPolicy = TerminationPolicy() )

inline

Empty constructor.

Parameters

tPolicy object of wrapped class.

Definition at line 36 of file incomplete_incremental_termination.hpp.

Member Function Documentation

template<class TerminationPolicy >

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

inline

Get current value of residue.

Definition at line 75 of file incomplete_incremental_termination.hpp.

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

template<class TerminationPolicy >

template<class MatType >

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

inline

Initializes the termination policy before stating the factorization.

Parameters

V	Input matrix to be factorized.

Definition at line 46 of file incomplete_incremental_termination.hpp.

References mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::incrementalIndex, mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::iteration, and mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy.

template<class TerminationPolicy >

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

inline

Check if termination criterio is met.

Parameters

W	Basis matrix of output.
H	Encoding matrix of output.

Definition at line 61 of file incomplete_incremental_termination.hpp.

References mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::incrementalIndex, mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::iteration, and mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::tPolicy.

template<class TerminationPolicy >

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

inline

Get current iteration count.

Definition at line 78 of file incomplete_incremental_termination.hpp.

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

template<class TerminationPolicy >

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

inline

Access maximum number of iterations.

Definition at line 81 of file incomplete_incremental_termination.hpp.

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

template<class TerminationPolicy >

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

inline

Modify maximum number of iterations.

Definition at line 83 of file incomplete_incremental_termination.hpp.

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

template<class TerminationPolicy >

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

inline

Access the wrapped termination policy.

Definition at line 86 of file incomplete_incremental_termination.hpp.

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

template<class TerminationPolicy >

TerminationPolicy& mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::TPolicy ( )

inline

Modify the wrapped termination policy.

Definition at line 88 of file incomplete_incremental_termination.hpp.

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

Member Data Documentation

template<class TerminationPolicy >

size_t mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::incrementalIndex

private

Number of iterations after which wrapped class object will be called.

Definition at line 95 of file incomplete_incremental_termination.hpp.

Referenced by mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Initialize(), and mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::IsConverged().

template<class TerminationPolicy >

size_t mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::iteration

private

Current iteration count.

Definition at line 97 of file incomplete_incremental_termination.hpp.

Referenced by mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Initialize(), mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::IsConverged(), and mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Iteration().

template<class TerminationPolicy >

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

private

Wrapped termination policy.

Definition at line 92 of file incomplete_incremental_termination.hpp.

Referenced by mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Index(), mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::Initialize(), mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::IsConverged(), mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::MaxIterations(), and mlpack::amf::IncompleteIncrementalTermination< TerminationPolicy >::TPolicy().

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

src/mlpack/methods/amf/termination_policies/incomplete_incremental_termination.hpp

Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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