sequential.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_LAYER_SEQUENTIAL_HPP
#define MLPACK_METHODS_ANN_LAYER_SEQUENTIAL_HPP

#include <mlpack/prereqs.hpp>

#include "layer.hpp"

namespace mlpack {
namespace ann  {

template <
    typename InputType = arma::mat,
    typename OutputType = arma::mat,
    bool Residual = false
>
class SequentialType : public MultiLayer<InputType, OutputType>
{
 public:
  SequentialType();

  SequentialType(const bool ownsLayers);

  SequentialType(const SequentialType& layer);

  SequentialType& operator=(const SequentialType& layer);

  ~SequentialType();

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

  void Forward(const InputType& input, OutputType& output);

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

  void Gradient(const InputType& input,
                const OutputType& error,
                OutputType& /* gradient */);

  size_t InputShape() const;

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

 private:
  bool reset;

  bool ownsLayers;
}; // class SequentialType

// Standard Sequential layer.
typedef SequentialType<arma::mat, arma::mat, false> Sequential;

// Standard Residual layer.
typedef SequentialType<arma::mat, arma::mat, true> Residual;

} // namespace ann
} // namespace mlpack

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

#endif