mlpack-doxygen/gradient__descent_2test__function_8hpp_source.html

 #ifndef MLPACK_CORE_OPTIMIZERS_GD_TEST_FUNCTION_HPP
 #define MLPACK_CORE_OPTIMIZERS_GD_TEST_FUNCTION_HPP

 #include <mlpack/prereqs.hpp>

 namespace mlpack {
 namespace optimization {
 namespace test {

 class GDTestFunction
 {
  public:
   GDTestFunction() { }

   arma::mat GetInitialPoint() const { return arma::mat("1; 3; 2"); }

   double Evaluate(const arma::mat& coordinates) const;

   void Gradient(const arma::mat& coordinates, arma::mat& gradient) const;
 };

 } // namespace test
 } // namespace optimization
 } // namespace mlpack

 #endif
mlpack
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: binarize.hpp:18

prereqs.hpp
The core includes that mlpack expects; standard C++ includes and Armadillo.

mlpack::optimization::test::GDTestFunction::GDTestFunction
GDTestFunction()
Nothing to do for the constructor.
Definition: test_function.hpp:29

mlpack::optimization::test::GDTestFunction::Gradient
void Gradient(const arma::mat &coordinates, arma::mat &gradient) const
Evaluate the gradient of a function.

mlpack::optimization::test::GDTestFunction
Very, very simple test function which is the composite of three other functions.
Definition: test_function.hpp:25

mlpack::optimization::test::GDTestFunction::Evaluate
double Evaluate(const arma::mat &coordinates) const
Evaluate a function.

mlpack::optimization::test::GDTestFunction::GetInitialPoint
arma::mat GetInitialPoint() const
Get the starting point.
Definition: test_function.hpp:32