DiscreteDistribution.h

Go to the documentation of this file.

//
// File: DiscreteDistribution.h
// Created by: Julien Dutheil
// Created on: ?
//

/*
  Copyright or © or Copr. Bio++ Development Team, (November 19, 2004)

  This software is a computer program whose purpose is to provide classes
  for numerical calculus.

  This software is governed by the CeCILL  license under French law and
  abiding by the rules of distribution of free software.  You can  use, 
  modify and/ or redistribute the software under the terms of the CeCILL
  license as circulated by CEA, CNRS and INRIA at the following URL
  "http://www.cecill.info". 

  As a counterpart to the access to the source code and  rights to copy,
  modify and redistribute granted by the license, users are provided only
  with a limited warranty  and the software's author,  the holder of the
  economic rights,  and the successive licensors  have only  limited
  liability. 

  In this respect, the user's attention is drawn to the risks associated
  with loading,  using,  modifying and/or developing or reproducing the
  software by the user in light of its specific status of free software,
  that may mean  that it is complicated to manipulate,  and  that  also
  therefore means  that it is reserved for developers  and  experienced
  professionals having in-depth computer knowledge. Users are therefore
  encouraged to load and test the software's suitability as regards their
  requirements in conditions enabling the security of their systems and/or 
  data to be ensured and,  more generally, to use and operate it in the 
  same conditions as regards security. 

  The fact that you are presently reading this means that you have had
  knowledge of the CeCILL license and that you accept its terms.
*/

#ifndef _DISCRETEDISTRIBUTION_H_
#define _DISCRETEDISTRIBUTION_H_

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

namespace bpp
{

  class DiscreteDistribution:
    public virtual ParameterAliasable
  {
  public:
    DiscreteDistribution() {}
    virtual ~DiscreteDistribution() {}

  
#ifndef NO_VIRTUAL_COV
    DiscreteDistribution* clone() const = 0;
#endif

  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 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 throw (Exception) = 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 Constraint& c) = 0;
          
    virtual void print(OutputStream& out) const = 0;

  };

} //end of namespace bpp.

#endif  //_DISCRETEDISTRIBUTION_H_