DiscreteDistribution.h

Go to the documentation of this file.

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

#ifndef BPP_NUMERIC_PROB_DISCRETEDISTRIBUTION_H
#define BPP_NUMERIC_PROB_DISCRETEDISTRIBUTION_H


#include "../../Exceptions.h"
#include "../../Io/OutputStream.h"
#include "../NumConstants.h"
#include "../ParameterAliasable.h"
#include "../VectorTools.h"

namespace bpp
{
class DiscreteDistributionInterface :
  public virtual ParameterAliasable
{
public:
  DiscreteDistributionInterface() {}
  virtual ~DiscreteDistributionInterface() {}


  DiscreteDistributionInterface* clone() const = 0;

public:
  virtual std::string getName() const = 0;

  virtual size_t getNumberOfCategories() const = 0;


  virtual void setNumberOfCategories(size_t nbClasses) = 0;

  virtual double getValueCategory(double value) const = 0;

  virtual size_t getCategoryIndex(double value) const = 0;

  virtual double getCategory(size_t categoryIndex) const = 0;

  virtual double getProbability(size_t categoryIndex) const = 0;

  virtual double getProbability(double category) const = 0;

  virtual Vdouble getCategories() const = 0;
  virtual Vdouble getProbabilities() const = 0;

  virtual void set(double category, double probability) = 0;

  virtual void add(double category, double probability) = 0;

  virtual double getInfCumulativeProbability(double category) const = 0;
  virtual double getIInfCumulativeProbability(double category) const = 0;
  virtual double getSupCumulativeProbability(double category) const = 0;
  virtual double getSSupCumulativeProbability(double category) const = 0;

  virtual double rand() const = 0;

  virtual double randC() const = 0;

  virtual double qProb(double x) const = 0;

  virtual double pProb(double x) const = 0;

  virtual double Expectation(double a) const = 0;

  virtual void setMedian(bool median) = 0;

  virtual void discretize() = 0;

  virtual Vdouble getBounds() const = 0;

  virtual double getBound(size_t) const = 0;

  virtual double getLowerBound() const
  {
    return -NumConstants::VERY_BIG();
  }

  virtual double getUpperBound() const
  {
    return NumConstants::VERY_BIG();
  }

  virtual bool strictLowerBound() const
  {
    return true;
  }

  virtual bool strictUpperBound() const
  {
    return true;
  }

  virtual void restrictToConstraint(const ConstraintInterface& c) = 0;

  virtual void print(OutputStream& out) const = 0;
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_PROB_DISCRETEDISTRIBUTION_H