add_evaluate.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_OPTIMIZERS_FUNCTION_ADD_EVALUATE_HPP
#define MLPACK_CORE_OPTIMIZERS_FUNCTION_ADD_EVALUATE_HPP

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

namespace mlpack {
namespace optimization {

template<typename FunctionType,
         bool HasEvaluateWithGradient =
             traits::HasEvaluateWithGradient<FunctionType,
                 traits::EvaluateWithGradientForm>::value,
         bool HasEvaluate =
             traits::HasEvaluate<FunctionType, traits::EvaluateForm>::value>
class AddEvaluate
{
 public:
  // Provide a dummy overload so the name 'Evaluate' exists for this object.
  double Evaluate(traits::UnconstructableType&);
};

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

template<typename FunctionType>
class AddEvaluate<FunctionType, true, false>
{
 public:
  double Evaluate(const arma::mat& coordinates)
  {
    arma::mat gradient; // This will be ignored.
    return static_cast<Function<FunctionType>*>(this)->EvaluateWithGradient(
        coordinates, gradient);
  }
};

template<typename FunctionType,
         bool HasEvaluateWithGradient =
             traits::HasEvaluateWithGradient<FunctionType,
                 traits::EvaluateWithGradientConstForm>::value,
         bool HasEvaluate =
             traits::HasEvaluate<FunctionType,
                 traits::EvaluateConstForm>::value>
class AddEvaluateConst
{
 public:
  // Provide a dummy overload so the name 'Evaluate' exists for this object.
  double Evaluate(traits::UnconstructableType&) const;
};

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

template<typename FunctionType>
class AddEvaluateConst<FunctionType, true, false>
{
 public:
  double Evaluate(const arma::mat& coordinates) const
  {
    arma::mat gradient; // This will be ignored.
    return static_cast<
        const Function<FunctionType>*>(this)->EvaluateWithGradient(coordinates,
        gradient);
  }
};

template<typename FunctionType,
         bool HasEvaluateWithGradient =
             traits::HasEvaluateWithGradient<FunctionType,
                 traits::EvaluateWithGradientStaticForm>::value,
         bool HasEvaluate =
             traits::HasEvaluate<FunctionType,
                 traits::EvaluateStaticForm>::value>
class AddEvaluateStatic
{
 public:
  // Provide a dummy overload so the name 'Evaluate' exists for this object.
  static double Evaluate(traits::UnconstructableType&);
};

template<typename FunctionType, bool HasEvaluateWithGradient>
class AddEvaluateStatic<FunctionType, HasEvaluateWithGradient, true>
{
 public:
  // Reflect the existing Evaluate().
  static double Evaluate(const arma::mat& coordinates)
  {
    return FunctionType::Evaluate(coordinates);
  }
};

template<typename FunctionType>
class AddEvaluateStatic<FunctionType, true, false>
{
 public:
  static double Evaluate(const arma::mat& coordinates)
  {
    arma::mat gradient; // This will be ignored.
    return FunctionType::EvaluateWithGradient(coordinates, gradient);
  }
};

} // namespace optimization
} // namespace mlpack

#endif