OpenANN::CG Class Reference

Conjugate Gradient. More...

#include <CG.h>

Inheritance diagram for OpenANN::CG:

Public Member Functions
	CG ()
	~CG ()
virtual void	setOptimizable (Optimizable &opt)
	Pass the objective function. More...
virtual void	setStopCriteria (const StoppingCriteria &stop)
	Pass the stop criteria. More...
virtual bool	step ()
	Execute one optimization step. More...
virtual void	optimize ()
	Optimize until the optimization meets the stop criteria. More...
virtual Eigen::VectorXd	result ()
	Determine the best result. More...
virtual std::string	name ()
	Get the name of the optimization algorithm. More...
Public Member Functions inherited from OpenANN::Optimizer
virtual	~Optimizer ()

Detailed Description

Conjugate Gradient.

The nonlinear conjugate gradient method is a generalization of the conjugate gradient method that finds the minimum of a quadratic function.

Constructor & Destructor Documentation

OpenANN::CG::CG

(

)

OpenANN::CG::~CG

(

)

Member Function Documentation

virtual std::string OpenANN::CG::name ( )

virtual

Get the name of the optimization algorithm.

Returns

name of the optimization algorithm

Implements OpenANN::Optimizer.

virtual void OpenANN::CG::optimize ( )

virtual

Optimize until the optimization meets the stop criteria.

Implements OpenANN::Optimizer.

virtual Eigen::VectorXd OpenANN::CG::result ( )

virtual

Determine the best result.

Returns

the best parameter the algorithm found

Implements OpenANN::Optimizer.

virtual void OpenANN::CG::setOptimizable ( Optimizable &  optimizable)

virtual

Pass the objective function.

Parameters

optimizable

objective function, e. g. error function of an ANN

Implements OpenANN::Optimizer.

virtual void OpenANN::CG::setStopCriteria ( const StoppingCriteria &  sc)

virtual

Pass the stop criteria.

Parameters

sc	the parameters used to stop the optimization

Implements OpenANN::Optimizer.

virtual bool OpenANN::CG::step ( )

virtual

Execute one optimization step.

Implements OpenANN::Optimizer.

---

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

• OpenANN/optimization/CG.h