softshrink.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_SOFTSHRINK_HPP
#define MLPACK_METHODS_ANN_LAYER_SOFTSHRINK_HPP

#include <mlpack/prereqs.hpp>

namespace mlpack {
namespace ann  {

template <
    typename InputDataType = arma::mat,
    typename OutputDataType = arma::mat
>
class SoftShrink
{
 public:
  SoftShrink(const double lambda = 0.5);

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

  template<typename DataType>
  void Backward(const DataType& input,
                DataType& gy,
                DataType& g);

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

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

  double const& Lambda() const { return lambda; }
  double& Lambda() { return lambda; }

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

 private:
  OutputDataType delta;

  OutputDataType outputParameter;

  double lambda;
}; // class SoftShrink

} // namespace ann
} // namespace mlpack

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

#endif