.TH "mlpack::optimization::test::SGDTestFunction" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::optimization::test::SGDTestFunction \- 
.PP
Very, very simple test function which is the composite of three other functions\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSGDTestFunction\fP ()"
.br
.RI "\fINothing to do for the constructor\&. \fP"
.ti -1c
.RI "double \fBEvaluate\fP (const arma::mat &coordinates, const size_t i) const "
.br
.RI "\fIEvaluate a function\&. \fP"
.ti -1c
.RI "arma::mat \fBGetInitialPoint\fP () const "
.br
.RI "\fIGet the starting point\&. \fP"
.ti -1c
.RI "void \fBGradient\fP (const arma::mat &coordinates, const size_t i, arma::mat &gradient) const "
.br
.RI "\fIEvaluate the gradient of a function\&. \fP"
.ti -1c
.RI "size_t \fBNumFunctions\fP () const "
.br
.RI "\fIReturn 3 (the number of functions)\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 
Very, very simple test function which is the composite of three other functions\&. 

It turns out that although this function is very simple, optimizing it fully can take a very long time\&. It seems to take in excess of 10 million iterations with a step size of 0\&.0005\&. 
.PP
Definition at line 35 of file test_function\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "mlpack::optimization::test::SGDTestFunction::SGDTestFunction ()\fC [inline]\fP"

.PP
Nothing to do for the constructor\&. 
.PP
Definition at line 39 of file test_function\&.hpp\&.
.SH "Member Function Documentation"
.PP 
.SS "double mlpack::optimization::test::SGDTestFunction::Evaluate (const arma::mat &coordinates, const size_ti) const"

.PP
Evaluate a function\&. 
.SS "arma::mat mlpack::optimization::test::SGDTestFunction::GetInitialPoint () const\fC [inline]\fP"

.PP
Get the starting point\&. 
.PP
Definition at line 45 of file test_function\&.hpp\&.
.SS "void mlpack::optimization::test::SGDTestFunction::Gradient (const arma::mat &coordinates, const size_ti, arma::mat &gradient) const"

.PP
Evaluate the gradient of a function\&. 
.SS "size_t mlpack::optimization::test::SGDTestFunction::NumFunctions () const\fC [inline]\fP"

.PP
Return 3 (the number of functions)\&. 
.PP
Definition at line 42 of file test_function\&.hpp\&.

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