discreteVariable.h

Go to the documentation of this file.

#ifndef GUM_DISCRETE_VARIABLE_H
#define GUM_DISCRETE_VARIABLE_H

#include <ostream>
#include <string>

#include <agrum/agrum.h>

#include <agrum/core/hashFunc.h>
#include <agrum/variables/variable.h>

namespace gum {

  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===                         GUM_DISCRETE_VARIABLE                       ===
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */
  /* ===========================================================================
   */

  class DiscreteVariable : public Variable {
    public:
    // ############################################################################
    // ############################################################################


    DiscreteVariable(const std::string& aName, const std::string& aDesc);


    DiscreteVariable(const DiscreteVariable& aDRV);


    virtual ~DiscreteVariable();


    virtual DiscreteVariable* clone() const = 0;


    // ############################################################################
    // ############################################################################


    bool empty() const;


    virtual Size domainSize() const = 0;

    std::vector< std::string > labels() const;

    virtual double numerical(Idx indice) const = 0;


    virtual VarType varType() const = 0;

    // ############################################################################
    // ############################################################################


    DiscreteVariable& operator=(const DiscreteVariable& aRV);

    virtual bool operator==(const DiscreteVariable& aRV) const;


    virtual bool operator!=(const DiscreteVariable& aRV) const;


    Idx operator[](const std::string& label) const { return index(label); };
    virtual Idx index(const std::string& label) const = 0;


    virtual std::string label(Idx i) const = 0;

    const std::string toString() const;

    const std::string toStringWithDescription() const;

    virtual const std::string domain() const = 0;

    protected:
    DiscreteVariable() { GUM_CONSTRUCTOR(DiscreteVariable); };
  };


  std::ostream& operator<<(std::ostream&, const DiscreteVariable&);

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/variables/discreteVariable_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_DISCRETE_VARIABLE_H */