continuousVariable.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_CONTINUOUS_VARIABLE_H
#define GUM_CONTINUOUS_VARIABLE_H

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

#include <agrum/agrum.h>
#include <agrum/variables/IContinuousVariable.h>

namespace gum {

  template < typename GUM_SCALAR = float >
  class ContinuousVariable : public IContinuousVariable {
    public:
    // ##########################################################################
    // ##########################################################################



    ContinuousVariable(
       const std::string& aName,
       const std::string& aDesc,
       GUM_SCALAR lower_bound = -std::numeric_limits< GUM_SCALAR >::infinity(),
       GUM_SCALAR upper_bound = std::numeric_limits< GUM_SCALAR >::infinity());

    ContinuousVariable(const ContinuousVariable< GUM_SCALAR >& from);

    template < typename TX_VAL >
    ContinuousVariable(const ContinuousVariable< TX_VAL >& from);

    ContinuousVariable(ContinuousVariable< GUM_SCALAR >&& from);

    virtual ~ContinuousVariable();

    virtual ContinuousVariable< GUM_SCALAR >* clone() const;



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


    ContinuousVariable< GUM_SCALAR >&
       operator=(const ContinuousVariable< GUM_SCALAR >& from);

    template < typename TX_VAL >
    ContinuousVariable< GUM_SCALAR >&
       operator=(const ContinuousVariable< TX_VAL >& from);

    ContinuousVariable< GUM_SCALAR >&
       operator=(ContinuousVariable< GUM_SCALAR >&& from);


    GUM_SCALAR operator[](const std::string& str) const;



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


    GUM_SCALAR lowerBound() const;

    virtual double lowerBoundAsDouble() const;

    GUM_SCALAR upperBound() const;

    virtual double upperBoundAsDouble() const;


    void setLowerBound(const GUM_SCALAR& new_bound);


    virtual void setLowerBoundFromDouble(const double new_bound);


    void setUpperBound(const GUM_SCALAR& new_bound);


    virtual void setUpperBoundFromDouble(const double new_bound);


    virtual std::string label(const GUM_SCALAR& value) const;

    bool belongs(const GUM_SCALAR& value) const;

    virtual const std::string domain() const;

    virtual VarType varType() const;

    const std::string toString() const;

    const std::string toStringWithDescription() const;



    private:
    // the lower bound.
    GUM_SCALAR __lower_bound;

    // the upper bound.
    GUM_SCALAR __upper_bound;

    template < typename TX_VAL >
    friend class ContinuousVariable;
  };


  template < typename T_VAL >
  std::ostream& operator<<(std::ostream&, const ContinuousVariable< T_VAL >&);


  // specialized operator[] for real numbers
  template <>
  float ContinuousVariable< float >::operator[](const std::string& str) const;

  template <>
  double ContinuousVariable< double >::operator[](const std::string& str) const;


} /* namespace gum */

// always include the template implementation
#include <agrum/variables/continuousVariable_tpl.h>

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

#endif /* GUM_CONTINUOUS_VARIABLE_H */