SimpleDiscreteDistribution.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_NUMERIC_PROB_SIMPLEDISCRETEDISTRIBUTION_H
#define BPP_NUMERIC_PROB_SIMPLEDISCRETEDISTRIBUTION_H


#include "AbstractDiscreteDistribution.h"

// From the STL:
#include <map>

namespace bpp
{
class SimpleDiscreteDistribution :
  public AbstractDiscreteDistribution
{
private:
  std::map<size_t, std::vector<double>> givenRanges_;

public:
  SimpleDiscreteDistribution(const std::map<double, double>& distribution, double precision = NumConstants::TINY(), bool fixed = false);

  SimpleDiscreteDistribution(const std::vector<double>& values, const std::vector<double>& probas, double prec = NumConstants::TINY(), bool fixed = false);

  SimpleDiscreteDistribution(const std::vector<double>& values, const std::map<size_t, std::vector<double>>& ranges, const std::vector<double>& probas, double prec = NumConstants::TINY(), bool fixed = false);

  virtual ~SimpleDiscreteDistribution() {}

  SimpleDiscreteDistribution(const SimpleDiscreteDistribution&);

  SimpleDiscreteDistribution& operator=(const SimpleDiscreteDistribution&);

  SimpleDiscreteDistribution* clone() const { return new SimpleDiscreteDistribution(*this); }

public:
  /*
   *@brief Returns the map of the given ranges for the values.
   *
   */
  const std::map<size_t, std::vector<double>> getRanges() const { return givenRanges_;}

  std::string getName() const {return "Simple";}

  void discretize();

  void fireParameterChanged(const ParameterList& parameters);

  double getLowerBound() const
  {
    return distribution_.begin()->first;
  }

  double getUpperBound() const
  {
    return distribution_.rbegin()->first;
  }

  double qProb(double x) const;

  double pProb(double x) const;

  double Expectation(double a) const;

  void restrictToConstraint(const ConstraintInterface& c);
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_PROB_SIMPLEDISCRETEDISTRIBUTION_H