cross_entropy_error.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_CROSS_ENTROPY_ERROR_HPP
#define MLPACK_METHODS_ANN_LAYER_CROSS_ENTROPY_ERROR_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class CrossEntropyError
{
 public:
  CrossEntropyError(double eps = 1e-10);

  /*
   * Computes the cross-entropy function.
   *
   * @param input Input data used for evaluating the specified function.
   * @param output Resulting output activation.
   */
  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; }

  double Eps() const { return eps; }
  double& Eps() { return eps; }

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

 private:
  OutputDataType delta;

  InputDataType inputParameter;

  OutputDataType outputParameter;

  double eps;
}; // class CrossEntropyError

} // namespace ann
} // namespace mlpack

// Include implementation.
#include "cross_entropy_error_impl.hpp"

#endif