MLPACK  1.0.10
Public Member Functions | List of all members
mlpack::optimization::test::SGDTestFunction Class Reference

Very, very simple test function which is the composite of three other functions. More...

Public Member Functions

 SGDTestFunction ()
 Nothing to do for the constructor. More...
 
double Evaluate (const arma::mat &coordinates, const size_t i) const
 Evaluate a function. More...
 
arma::mat GetInitialPoint () const
 Get the starting point. More...
 
void Gradient (const arma::mat &coordinates, const size_t i, arma::mat &gradient) const
 Evaluate the gradient of a function. More...
 
size_t NumFunctions () const
 Return 3 (the number of functions). More...
 

Detailed Description

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.

Definition at line 35 of file test_function.hpp.

Constructor & Destructor Documentation

mlpack::optimization::test::SGDTestFunction::SGDTestFunction ( )
inline

Nothing to do for the constructor.

Definition at line 39 of file test_function.hpp.

Member Function Documentation

double mlpack::optimization::test::SGDTestFunction::Evaluate ( const arma::mat &  coordinates,
const size_t  i 
) const

Evaluate a function.

arma::mat mlpack::optimization::test::SGDTestFunction::GetInitialPoint ( ) const
inline

Get the starting point.

Definition at line 45 of file test_function.hpp.

void mlpack::optimization::test::SGDTestFunction::Gradient ( const arma::mat &  coordinates,
const size_t  i,
arma::mat &  gradient 
) const

Evaluate the gradient of a function.

size_t mlpack::optimization::test::SGDTestFunction::NumFunctions ( ) const
inline

Return 3 (the number of functions).

Definition at line 42 of file test_function.hpp.


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