rangeVariable.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_RANGE_VARIABLE_H
#define GUM_RANGE_VARIABLE_H
 
#include <ostream>
#include <sstream>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {

 
  class RangeVariable final: public DiscreteVariable {
    public:

    RangeVariable(const std::string& aName, const std::string& aDesc, long minVal, long maxVal);

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

    RangeVariable(const RangeVariable& aDRV);

    ~RangeVariable() final;

    RangeVariable* clone() const final;



    Size domainSize() const final;

 
    VarType varType() const final;
 
    // returns the variable in fast syntax
    std::string toFast() const final;

    std::string label(Idx index) const final;

    double numerical(Idx index) const final;

    long minVal() const;

    void setMinVal(long minVal);

    long maxVal() const;

    void setMaxVal(long maxVal);

    bool belongs(long val) const;

    Idx index(const std::string&) const final;

    Idx closestIndex(double val) const final;



    RangeVariable& operator=(const RangeVariable& aRV);

 
    std::string domain() const final;

    std::string stype() const final { return "Range"; };
 
    private:

    bool _checkSameDomain_(const Variable& aRV) const final;

    long _minBound_;

    long _maxBound_;

  };
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/variables/rangeVariable_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_RANGE_VARIABLE_H */