softmax.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_SOFTMAX_HPP
#define MLPACK_METHODS_ANN_LAYER_SOFTMAX_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class Softmax
{
 public:
  Softmax();

  template<typename InputType, typename OutputType>
  void Forward(const InputType& input, OutputType& output);

  template<typename eT>
  void Backward(const arma::Mat<eT>& input,
                const arma::Mat<eT>& gy,
                arma::Mat<eT>& g);

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

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

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

 private:
  OutputDataType delta;

  OutputDataType outputParameter;
}; // class Softmax

} // namespace ann
} // namespace mlpack

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

#endif