continuousVariable.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_CONTINUOUS_VARIABLE_H
#define GUM_CONTINUOUS_VARIABLE_H
 
#include <iostream>
#include <limits>
#include <sstream>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/variables/IContinuousVariable.h>
 
#include <string_view>
 
namespace gum {

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



    ContinuousVariable(std::string_view aName,
                       std::string_view 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);

    ~ContinuousVariable() override;

    [[nodiscard]] ContinuousVariable< GUM_SCALAR >* clone() const override;

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


    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[](std::string_view str) const;

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


    GUM_SCALAR lowerBound() const;

    double lowerBoundAsDouble() const override;

    GUM_SCALAR upperBound() const;

    double upperBoundAsDouble() const override;


    void setLowerBound(const GUM_SCALAR& new_bound);


    void setLowerBoundFromDouble(const double new_bound) override;


    void setUpperBound(const GUM_SCALAR& new_bound);


    void setUpperBoundFromDouble(const double new_bound) override;


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

    bool belongs(const GUM_SCALAR& value) const;

    std::string domain() const final;

    VarType varType() const override;

    std::string toString() const;

    std::string toStringWithDescription() const;

 
 
    private:

    bool _checkSameDomain_(const Variable& aRV) const final;
 
    // the lower bound.
    GUM_SCALAR _lower_bound_;
 
    // the upper bound.
    GUM_SCALAR _upper_bound_;
 
    template < GUM_Numeric 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[](std::string_view str) const;
 
  template <>
  double ContinuousVariable< double >::operator[](std::string_view str) const;
 
 
} /* namespace gum */
 
// always include the template implementation
#include <agrum/base/variables/continuousVariable_tpl.h>
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/variables/continuousVariable_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_CONTINUOUS_VARIABLE_H */