add_gradient.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_OPTIMIZERS_FUNCTION_ADD_GRADIENT_HPP
#define MLPACK_CORE_OPTIMIZERS_FUNCTION_ADD_GRADIENT_HPP

#include <mlpack/prereqs.hpp>
#include "traits.hpp"

namespace mlpack {
namespace optimization {

template<typename FunctionType,
         bool HasEvaluateWithGradient =
             traits::HasEvaluateWithGradient<FunctionType,
                 traits::EvaluateWithGradientForm>::value,
         bool HasGradient = traits::HasGradient<FunctionType,
             traits::GradientForm>::value>
class AddGradient
{
 public:
  // Provide a dummy overload so the name 'Gradient' exists for this object.
  void Gradient(traits::UnconstructableType&) { }
};

template<typename FunctionType, bool HasEvaluateWithGradient>
class AddGradient<FunctionType, HasEvaluateWithGradient, true>
{
 public:
  // Reflect the existing Gradient().
  void Gradient(const arma::mat& coordinates, arma::mat& gradient)
  {
    static_cast<FunctionType*>(static_cast<Function<FunctionType>*>(
        this))->Gradient(coordinates, gradient);
  }
};

template<typename FunctionType>
class AddGradient<FunctionType, true, false>
{
 public:
  void Gradient(const arma::mat& coordinates, arma::mat& gradient)
  {
    // The returned objective value will be ignored.
    (void) static_cast<Function<FunctionType>*>(this)->EvaluateWithGradient(
        coordinates, gradient);
  }
};

template<typename FunctionType,
         bool HasEvaluateWithGradient =
             traits::HasEvaluateWithGradient<FunctionType,
                 traits::EvaluateWithGradientConstForm>::value,
         bool HasGradient = traits::HasGradient<FunctionType,
             traits::GradientConstForm>::value>
class AddGradientConst
{
 public:
  // Provide a dummy overload so the name 'Gradient' exists for this object.
  void Gradient(traits::UnconstructableType&) const { }
};

template<typename FunctionType, bool HasEvaluateWithGradient>
class AddGradientConst<FunctionType, HasEvaluateWithGradient, true>
{
 public:
  // Reflect the existing Gradient().
  void Gradient(const arma::mat& coordinates, arma::mat& gradient) const
  {
    static_cast<const FunctionType*>(static_cast<const
Function<FunctionType>*>(this))->Gradient(coordinates,
        gradient);
  }
};

template<typename FunctionType>
class AddGradientConst<FunctionType, true, false>
{
 public:
  void Gradient(const arma::mat& coordinates, arma::mat& gradient) const
  {
    // The returned objective value will be ignored.
    (void) static_cast<
        const Function<FunctionType>*>(this)->EvaluateWithGradient(coordinates,
        gradient);
  }
};

template<typename FunctionType,
         bool HasEvaluateWithGradient =
             traits::HasEvaluateWithGradient<FunctionType,
                 traits::EvaluateWithGradientStaticForm>::value,
         bool HasGradient = traits::HasGradient<FunctionType,
             traits::GradientStaticForm>::value>
class AddGradientStatic
{
 public:
  // Provide a dummy overload so the name 'Gradient' exists for this object.
  static void Gradient(traits::UnconstructableType&) { }
};

template<typename FunctionType, bool HasEvaluateWithGradient>
class AddGradientStatic<FunctionType, HasEvaluateWithGradient, true>
{
 public:
  // Reflect the existing Gradient().
  static void Gradient(const arma::mat& coordinates, arma::mat& gradient)
  {
    FunctionType::Gradient(coordinates, gradient);
  }
};

template<typename FunctionType>
class AddGradientStatic<FunctionType, true, false>
{
 public:
  static void Gradient(const arma::mat& coordinates, arma::mat& gradient)
  {
    // The returned objective value will be ignored.
    (void) FunctionType::EvaluateWithGradient(coordinates, gradient);
  }
};

} // namespace optimization
} // namespace mlpack

#endif