MLPACK  1.0.10
Public Member Functions | Public Attributes | List of all members
mlpack::amf::SimpleResidueTermination Class Reference

Public Member Functions

 SimpleResidueTermination (const double minResidue=1e-10, const size_t maxIterations=10000)
 
const double & Index ()
 
template<typename MatType >
void Initialize (const MatType &V)
 
bool IsConverged (arma::mat &W, arma::mat &H)
 
const size_t & Iteration ()
 
const size_t & MaxIterations ()
 

Public Attributes

size_t iteration
 
size_t maxIterations
 
double minResidue
 
size_t nm
 
double normOld
 
double residue
 

Detailed Description

Definition at line 28 of file simple_residue_termination.hpp.

Constructor & Destructor Documentation

mlpack::amf::SimpleResidueTermination::SimpleResidueTermination ( const double  minResidue = 1e-10,
const size_t  maxIterations = 10000 
)
inline

Definition at line 31 of file simple_residue_termination.hpp.

Member Function Documentation

const double& mlpack::amf::SimpleResidueTermination::Index ( )
inline

Definition at line 70 of file simple_residue_termination.hpp.

References residue.

template<typename MatType >
void mlpack::amf::SimpleResidueTermination::Initialize ( const MatType &  V)
inline

Definition at line 36 of file simple_residue_termination.hpp.

References iteration, minResidue, nm, normOld, and residue.

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

Definition at line 48 of file simple_residue_termination.hpp.

References iteration, maxIterations, nm, normOld, and residue.

const size_t& mlpack::amf::SimpleResidueTermination::Iteration ( )
inline

Definition at line 71 of file simple_residue_termination.hpp.

References iteration.

const size_t& mlpack::amf::SimpleResidueTermination::MaxIterations ( )
inline

Definition at line 72 of file simple_residue_termination.hpp.

References maxIterations.

Member Data Documentation

size_t mlpack::amf::SimpleResidueTermination::iteration

Definition at line 79 of file simple_residue_termination.hpp.

Referenced by Initialize(), IsConverged(), and Iteration().

size_t mlpack::amf::SimpleResidueTermination::maxIterations

Definition at line 76 of file simple_residue_termination.hpp.

Referenced by IsConverged(), and MaxIterations().

double mlpack::amf::SimpleResidueTermination::minResidue

Definition at line 75 of file simple_residue_termination.hpp.

Referenced by Initialize().

size_t mlpack::amf::SimpleResidueTermination::nm

Definition at line 82 of file simple_residue_termination.hpp.

Referenced by Initialize(), and IsConverged().

double mlpack::amf::SimpleResidueTermination::normOld

Definition at line 80 of file simple_residue_termination.hpp.

Referenced by Initialize(), and IsConverged().

double mlpack::amf::SimpleResidueTermination::residue

Definition at line 78 of file simple_residue_termination.hpp.

Referenced by Index(), Initialize(), and IsConverged().


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