.TH "mlpack::amf::SimpleToleranceTermination< MatType >" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::amf::SimpleToleranceTermination< MatType > \- 
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSimpleToleranceTermination\fP (const double \fBtolerance\fP=1e-5, const size_t maxIterations=10000, const size_t reverseStepTolerance=3)"
.br
.ti -1c
.RI "const double & \fBIndex\fP ()"
.br
.ti -1c
.RI "void \fBInitialize\fP (const MatType &\fBV\fP)"
.br
.ti -1c
.RI "bool \fBIsConverged\fP (arma::mat &\fBW\fP, arma::mat &\fBH\fP)"
.br
.ti -1c
.RI "const size_t & \fBIteration\fP ()"
.br
.ti -1c
.RI "const size_t & \fBMaxIterations\fP ()"
.br
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "double \fBc_index\fP"
.br
.ti -1c
.RI "double \fBc_indexOld\fP"
.br
.ti -1c
.RI "arma::mat \fBH\fP"
.br
.ti -1c
.RI "bool \fBisCopy\fP"
.br
.ti -1c
.RI "size_t \fBiteration\fP"
.br
.ti -1c
.RI "size_t \fBmaxIterations\fP"
.br
.ti -1c
.RI "double \fBnormOld\fP"
.br
.ti -1c
.RI "double \fBresidue\fP"
.br
.ti -1c
.RI "double \fBresidueOld\fP"
.br
.ti -1c
.RI "size_t \fBreverseStepCount\fP"
.br
.ti -1c
.RI "size_t \fBreverseStepTolerance\fP"
.br
.ti -1c
.RI "double \fBtolerance\fP"
.br
.ti -1c
.RI "const MatType * \fBV\fP"
.br
.ti -1c
.RI "arma::mat \fBW\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<class MatType>class mlpack::amf::SimpleToleranceTermination< MatType >"

.PP
Definition at line 29 of file simple_tolerance_termination\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<class MatType > \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::\fBSimpleToleranceTermination\fP (const doubletolerance = \fC1e-5\fP, const size_tmaxIterations = \fC10000\fP, const size_treverseStepTolerance = \fC3\fP)\fC [inline]\fP"

.PP
Definition at line 32 of file simple_tolerance_termination\&.hpp\&.
.SH "Member Function Documentation"
.PP 
.SS "template<class MatType > const double& \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::Index ()\fC [inline]\fP"

.PP
Definition at line 119 of file simple_tolerance_termination\&.hpp\&.
.PP
References mlpack::amf::SimpleToleranceTermination< MatType >::residue\&.
.SS "template<class MatType > void \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::Initialize (const MatType &V)\fC [inline]\fP"

.PP
Definition at line 39 of file simple_tolerance_termination\&.hpp\&.
.PP
References mlpack::amf::SimpleToleranceTermination< MatType >::c_index, mlpack::amf::SimpleToleranceTermination< MatType >::c_indexOld, mlpack::amf::SimpleToleranceTermination< MatType >::iteration, mlpack::amf::SimpleToleranceTermination< MatType >::residue, mlpack::amf::SimpleToleranceTermination< MatType >::residueOld, mlpack::amf::SimpleToleranceTermination< MatType >::reverseStepCount, and mlpack::amf::SimpleToleranceTermination< MatType >::V\&.
.SS "template<class MatType > bool \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::IsConverged (arma::mat &W, arma::mat &H)\fC [inline]\fP"

.PP
Definition at line 54 of file simple_tolerance_termination\&.hpp\&.
.PP
References mlpack::amf::SimpleToleranceTermination< MatType >::c_index, mlpack::amf::SimpleToleranceTermination< MatType >::c_indexOld, mlpack::amf::SimpleToleranceTermination< MatType >::H, mlpack::amf::SimpleToleranceTermination< MatType >::isCopy, mlpack::amf::SimpleToleranceTermination< MatType >::iteration, mlpack::amf::SimpleToleranceTermination< MatType >::maxIterations, mlpack::amf::SimpleToleranceTermination< MatType >::residue, mlpack::amf::SimpleToleranceTermination< MatType >::residueOld, mlpack::amf::SimpleToleranceTermination< MatType >::reverseStepCount, mlpack::amf::SimpleToleranceTermination< MatType >::reverseStepTolerance, mlpack::amf::SimpleToleranceTermination< MatType >::V, and mlpack::amf::SimpleToleranceTermination< MatType >::W\&.
.SS "template<class MatType > const size_t& \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::Iteration ()\fC [inline]\fP"

.PP
Definition at line 120 of file simple_tolerance_termination\&.hpp\&.
.PP
References mlpack::amf::SimpleToleranceTermination< MatType >::iteration\&.
.SS "template<class MatType > const size_t& \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::MaxIterations ()\fC [inline]\fP"

.PP
Definition at line 121 of file simple_tolerance_termination\&.hpp\&.
.PP
References mlpack::amf::SimpleToleranceTermination< MatType >::maxIterations\&.
.SH "Member Data Documentation"
.PP 
.SS "template<class MatType > double \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::c_index\fC [private]\fP"

.PP
Definition at line 141 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > double \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::c_indexOld\fC [private]\fP"

.PP
Definition at line 140 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > arma::mat \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::H\fC [private]\fP"

.PP
Definition at line 139 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > bool \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::isCopy\fC [private]\fP"

.PP
Definition at line 137 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > size_t \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::iteration\fC [private]\fP"

.PP
Definition at line 129 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged(), and mlpack::amf::SimpleToleranceTermination< MatType >::Iteration()\&.
.SS "template<class MatType > size_t \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::maxIterations\fC [private]\fP"

.PP
Definition at line 125 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged(), and mlpack::amf::SimpleToleranceTermination< MatType >::MaxIterations()\&.
.SS "template<class MatType > double \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::normOld\fC [private]\fP"

.PP
Definition at line 132 of file simple_tolerance_termination\&.hpp\&.
.SS "template<class MatType > double \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::residue\fC [private]\fP"

.PP
Definition at line 131 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Index(), mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > double \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::residueOld\fC [private]\fP"

.PP
Definition at line 130 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > size_t \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::reverseStepCount\fC [private]\fP"

.PP
Definition at line 135 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > size_t \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::reverseStepTolerance\fC [private]\fP"

.PP
Definition at line 134 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > double \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::tolerance\fC [private]\fP"

.PP
Definition at line 124 of file simple_tolerance_termination\&.hpp\&.
.SS "template<class MatType > const MatType* \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::V\fC [private]\fP"

.PP
Definition at line 127 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::Initialize(), and mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.
.SS "template<class MatType > arma::mat \fBmlpack::amf::SimpleToleranceTermination\fP< MatType >::W\fC [private]\fP"

.PP
Definition at line 138 of file simple_tolerance_termination\&.hpp\&.
.PP
Referenced by mlpack::amf::SimpleToleranceTermination< MatType >::IsConverged()\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MLPACK from the source code\&.