linear3d.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_LINEAR3D_HPP
#define MLPACK_METHODS_ANN_LAYER_LINEAR3D_HPP

#include <mlpack/prereqs.hpp>
#include <mlpack/methods/ann/regularizer/no_regularizer.hpp>

#include "layer.hpp"

namespace mlpack {
namespace ann  {

template<
    typename MatType = arma::mat,
    typename RegularizerType = NoRegularizer
>
class Linear3DType : public Layer<MatType>
{
 public:
  Linear3DType();

  Linear3DType(const size_t outSize,
               RegularizerType regularizer = RegularizerType());

  Linear3DType* Clone() const { return new Linear3DType(*this); }

  // Virtual destructor.
  virtual ~Linear3DType() { }

  Linear3DType(const Linear3DType& other);
  Linear3DType(Linear3DType&& other);
  Linear3DType& operator=(const Linear3DType& other);
  Linear3DType& operator=(Linear3DType&& other);

  /*
   * Reset the layer parameter.
   */
  void SetWeights(typename MatType::elem_type* weightsPtr);

  void Forward(const MatType& input, MatType& output);

  void Backward(const MatType& /* input */,
                const MatType& gy,
                MatType& g);

  void Gradient(const MatType& input,
                const MatType& error,
                MatType& gradient);

  MatType const& Parameters() const { return weights; }
  MatType& Parameters() { return weights; }

  MatType const& Weight() const { return weight; }
  MatType& Weight() { return weight; }

  MatType const& Bias() const { return bias; }
  MatType& Bias() { return bias; }

  size_t WeightSize() const { return outSize * (this->inputDimensions[0] + 1); }

  void ComputeOutputDimensions();

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

 private:
  size_t outSize;

  MatType weights;

  MatType weight;

  MatType bias;

  RegularizerType regularizer;
}; // class Linear

// Standard Linear3D layer.
typedef Linear3DType<arma::mat, NoRegularizer> Linear3D;

} // namespace ann
} // namespace mlpack

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

#endif