mlpack  git-master
AddGradient< FunctionType, true, false > Class Template Reference

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

Public Member Functions

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

 

Detailed Description


template
<
typename
FunctionType
>

class mlpack::optimization::AddGradient< FunctionType, true, false >

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

Definition at line 59 of file add_gradient.hpp.

Member Function Documentation

◆ Gradient()

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

Calculate the gradient and store it in the given matrix.

Parameters
coordinatesCoordinates to evaluate the function at.
gradientMatrix to store the gradient into.

Definition at line 68 of file add_gradient.hpp.

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


The documentation for this class was generated from the following file:
  • /var/www/www.mlpack.org/mlpack-git/src/mlpack/core/optimizers/function/add_gradient.hpp