discretizedVariable.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_DISCRETIZED_VARIABLE_H
#define GUM_DISCRETIZED_VARIABLE_H

#include <iostream>
#include <limits>
#include <sstream>
#include <vector>

#include <agrum/agrum.h>

#include <agrum/variables/IDiscretizedVariable.h>

namespace gum {
  template < typename T_TICKS >
  class DiscretizedVariable : public IDiscretizedVariable {
    private:
    std::vector< T_TICKS > __ticks;   // Array from 0 to domainSize-2
    Size                   __ticks_size;

    protected:
    void _copy(const DiscretizedVariable< T_TICKS >& aDRV);

    Idx _dichotomy(const T_TICKS& target, Idx min, Idx max) const;

    Idx _pos(const T_TICKS& target) const;

    public:
    DiscretizedVariable(const std::string& aName, const std::string& aDesc);

    DiscretizedVariable(const std::string&            aName,
                        const std::string&            aDesc,
                        const std::vector< T_TICKS >& ticks);

    DiscretizedVariable(const DiscretizedVariable< T_TICKS >& aDRV);

    virtual ~DiscretizedVariable();


    virtual DiscretizedVariable< T_TICKS >* clone() const;


    virtual VarType varType() const;

    DiscretizedVariable< T_TICKS >&
       operator=(const DiscretizedVariable< T_TICKS >& aDRV);

    bool isTick(const T_TICKS& aTick) const;

    DiscretizedVariable& addTick(const T_TICKS& aTick);

    void eraseTicks();

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

    virtual double numerical(Idx indice) const;

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

    virtual Size              domainSize() const;
    virtual const std::string domain() const;

    const T_TICKS& tick(Idx i) const;

    const std::vector< T_TICKS >& ticks() const;

    virtual std::vector< double > ticksAsDoubles() const;
  };

} /* namespace gum */

#include <agrum/variables/discretizedVariable_tpl.h>

#endif /* GUM_DISCRETIZED_VARIABLE_H */