AddGradientConst< FunctionType, true, false > Class Template Reference

If we have EvaluateWithGradient() but no existing Gradient(), add a Gradient() without a using directive to make the base Gradient() accessible. More...

Public Member Functions
void	Gradient (const arma::mat &coordinates, arma::mat &gradient) const
	Calculate the gradient and store it in the given matrix. More...

Detailed Description

template<typename FunctionType>
class mlpack::optimization::AddGradientConst< FunctionType, true, false >

If we have EvaluateWithGradient() but no existing Gradient(), add a Gradient() without a using directive to make the base Gradient() accessible.

Definition at line 114 of file add_gradient.hpp.

Member Function Documentation

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

inline

Calculate the gradient and store it in the given matrix.

Parameters

coordinates	Coordinates to evaluate the function at.
gradient	Matrix to store the gradient into.

Definition at line 123 of file add_gradient.hpp.

References AddDecomposableEvaluateWithGradientStatic< FunctionType, HasDecomposableEvaluateGradient, HasDecomposableEvaluateWithGradient >::EvaluateWithGradient().

---

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

• src/mlpack/core/optimizers/function/add_gradient.hpp