kl_divergence.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LOSS_FUNCTION_KL_DIVERGENCE_HPP
#define MLPACK_METHODS_ANN_LOSS_FUNCTION_KL_DIVERGENCE_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
        typename InputDataType = arma::mat,
        typename OutputDataType = arma::mat
>
class KLDivergence
{
 public:
  KLDivergence(const bool takeMean = false);

  template<typename InputType, typename TargetType>
  double Forward(const InputType&& input, const TargetType&& target);

  template<typename InputType, typename TargetType, typename OutputType>
  void Backward(const InputType&& input,
                const TargetType&& target,
                OutputType&& output);

  InputDataType& InputParameter() const { return inputParameter; }
  InputDataType& InputParameter() { return inputParameter; }

  OutputDataType& OutputParameter() const { return outputParameter; }
  OutputDataType& OutputParameter() { return outputParameter; }

  OutputDataType& Delta() const { return delta; }
  OutputDataType& Delta() { return delta; }

  bool TakeMean() const { return takeMean; }
  bool& TakeMean() { return takeMean; }

  template<typename Archive>
  void serialize(Archive& ar, const unsigned int /* version */);

 private:
  OutputDataType delta;

  InputDataType inputParameter;

  OutputDataType outputParameter;

  bool takeMean;
}; // class KLDivergence

} // namespace ann
} // namespace mlpack

// include implementation
#include "kl_divergence_impl.hpp"

#endif