bernoulli_distribution.hpp

Go to the documentation of this file.

#ifndef MLPACK_METHODS_ANN_DISTRIBUTIONS_BERNOULLI_DISTRIBUTION_HPP
#define MLPACK_METHODS_ANN_DISTRIBUTIONS_BERNOULLI_DISTRIBUTION_HPP

#include <mlpack/prereqs.hpp>
#include "../activation_functions/logistic_function.hpp"

namespace mlpack {
namespace ann  {

template <typename DataType = arma::mat>
class BernoulliDistribution
{
 public:
  BernoulliDistribution();

  BernoulliDistribution(const DataType&& param,
                        const bool applyLogistic = true,
                        const double eps = 1e-10);

  double Probability(const DataType&& observation) const
  {
    return std::exp(LogProbability(observation));
  }

  double LogProbability(const DataType&& observation) const;

  void LogProbBackward(const DataType&& observation, DataType&& output) const;

  DataType Sample() const;

  const DataType& Probability() const { return probability; }

  DataType& Probability() { return probability; }

  const DataType& Logits() const { return logits; }

  DataType& Logits() { return logits; }

  template<typename Archive>
  void serialize(Archive& ar, const unsigned int /* version */)
  {
    // We just need to serialize each of the members.
    ar & BOOST_SERIALIZATION_NVP(probability);
    ar & BOOST_SERIALIZATION_NVP(logits);
    ar & BOOST_SERIALIZATION_NVP(applyLogistic);
    ar & BOOST_SERIALIZATION_NVP(eps);
  }

 private:
  DataType probability;

  DataType logits;

  bool applyLogistic;

  double eps;
}; // class BernoulliDistribution

} // namespace ann
} // namespace mlpack

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

#endif