labelizedVariable.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_LABELIZED_DISCRETE_VARIABLE_H
#define GUM_LABELIZED_DISCRETE_VARIABLE_H

#include <iostream>
#include <sstream>
#include <string>

#include <agrum/agrum.h>

#include <agrum/core/sequence.h>
#include <agrum/variables/discreteVariable.h>

namespace gum {
  /* =========================================================================*/
  /* =========================================================================*/
  /* ===                        GUM_LABELIZED_VARIABLE === */
  /* =========================================================================*/
  /* =========================================================================*/
  /* =========================================================================*/

  class LabelizedVariable : public DiscreteVariable {
    public:
    // ############################################################################
    // ############################################################################

    LabelizedVariable(const std::string& aName,
                      const std::string& aDesc = "",
                      const Size         nbrLabel = 2);

    LabelizedVariable(const std::string&                aName,
                      const std::string&                aDesc,
                      const std::vector< std::string >& labels);


    LabelizedVariable(const LabelizedVariable& aLDRV);


    virtual ~LabelizedVariable();

    virtual LabelizedVariable* clone() const;


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


    LabelizedVariable& operator=(const LabelizedVariable& aLDRV);



    virtual Idx index(const std::string& label) const;


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

    bool isLabel(const std::string& aLabel) const;


    LabelizedVariable& addLabel(const std::string& aLabel);


    void changeLabel(Idx pos, const std::string& aLabel) const;

    void eraseLabels();


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

    Idx posLabel(const std::string& label) const;

    virtual double numerical(Idx indice) const;

    virtual Size domainSize() const;

    virtual VarType varType() const;

    virtual const std::string domain() const;


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


    void _copy(const LabelizedVariable& aLDRV);

    private:
    mutable Sequence< std::string > __labels;
  };

} /* namespace gum */

/* ==============================================================================
 */
/* ==============================================================================
 */
/* ===                    LabelizedVariable IMPLEMENTATION === */
/* ==============================================================================
 */
/* ==============================================================================
 */
#ifndef GUM_NO_INLINE
#  include <agrum/variables/labelizedVariable_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_LABELIZED_DISCRETE_VARIABLE_H */