DiscreteDistribution.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------

 * GTSAM Copyright 2010, Georgia Tech Research Corporation,
 * Atlanta, Georgia 30332-0415
 * All Rights Reserved
 * Authors: Frank Dellaert, et al. (see THANKS for the full author list)

 * See LICENSE for the license information

 * -------------------------------------------------------------------------- */

#pragma once

#include <gtsam/discrete/DiscreteConditional.h>

#include <string>
#include <vector>

namespace gtsam {

class GTSAM_EXPORT DiscreteDistribution : public DiscreteConditional {
 public:
  using Base = DiscreteConditional;


  DiscreteDistribution() {}

  explicit DiscreteDistribution(const DecisionTreeFactor& f)
      : Base(f.size(), f) {}

  explicit DiscreteDistribution(const Signature& s) : Base(s) {}

  DiscreteDistribution(const DiscreteKey& key, const std::vector<double>& spec)
      : DiscreteDistribution(Signature(key, {}, Signature::Table{spec})) {}

  DiscreteDistribution(const DiscreteKey& key, const std::string& spec)
      : DiscreteDistribution(Signature(key, {}, spec)) {}


  void print(
      const std::string& s = "Discrete Prior: ",
      const KeyFormatter& formatter = DefaultKeyFormatter) const override;


  double operator()(size_t value) const;

  // TODO(dellaert): does not play well with wrapper!
  // using Base::operator();

  std::vector<double> pmf() const;

};
// DiscreteDistribution

// traits
template <>
struct traits<DiscreteDistribution> : public Testable<DiscreteDistribution> {};

}  // namespace gtsam