rangeVariable_inl.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                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

#include <cmath>
#include <sstream>
 
// to ease IDE parsing
#include <agrum/base/variables/rangeVariable.h>
 
namespace gum {
 
  // Copy Factory.
  // @return Returns a pointer on a new copy of this.
  INLINE RangeVariable* RangeVariable::clone() const { return new RangeVariable(*this); }
 
  // returns the size of the random discrete variable domain
  INLINE Size RangeVariable::domainSize() const {
    return (_maxBound_ < _minBound_) ? Size(0) : Size(_maxBound_ + 1 - _minBound_);
  }
 
  // Get the indice-th label. This method is pure virtual.
  // @param indice the index of the label we wish to return
  // @throw OutOfBound
  INLINE std::string RangeVariable::label(Idx indice) const {
    long target = static_cast< long >(indice) + _minBound_;
    if (belongs(target)) {
      return std::to_string(target);
    } else {
      GUM_ERROR(OutOfBounds, "Indice out of bounds.")
    }
  }
 
  INLINE
  double RangeVariable::numerical(Idx indice) const {
    return double(_minBound_ + static_cast< long >(indice));
  }
 
  INLINE Idx RangeVariable::index(std::string_view label) const {
    std::istringstream i(std::string{label});
    long               target;
 
    if (!(i >> target)) { GUM_ERROR(NotFound, "Bad label : " << label << " for " << *this) }
 
    if (!belongs(target)) { GUM_ERROR(NotFound, "Bad label : " << label << " for " << *this) }
 
    return static_cast< Idx >(target - _minBound_);
  }
 
  INLINE Idx RangeVariable::closestIndex(double val) const {
    // std::rint uses round-half-to-even (IEEE default) which is platform-dependent at .5
    // boundaries. Use floor + explicit > 0.5 check to implement round-half-down deterministically.
    long res = static_cast< long >(std::floor(val));
    if (val - static_cast< double >(res) > 0.5) ++res;
 
    if (res < _minBound_) {
      return 0;
    } else if (res > _maxBound_) {
      return domainSize() - 1;
    } else {
      return static_cast< Idx >(res - _minBound_);
    }
  }
 
  // Returns the lower bound.
  INLINE long RangeVariable::minVal() const { return _minBound_; }
 
  // Set a new value for the lower bound.
  INLINE void RangeVariable::setMinVal(long minVal) { _minBound_ = minVal; }
 
  // Returns the upper bound.
  INLINE long RangeVariable::maxVal() const { return _maxBound_; }
 
  // Set a new value of the upper bound.
  INLINE void RangeVariable::setMaxVal(long maxVal) { _maxBound_ = maxVal; }
 
  // Returns true if the param belongs to the variable's interval.
  INLINE bool RangeVariable::belongs(long val) const {
    return ((_minBound_ <= val) && (val <= _maxBound_));
  }
 
  // Copy operator
  // @param aRV to be copied
  // @return a ref to *this
  INLINE RangeVariable& RangeVariable::operator=(const RangeVariable& aRV) = default;
 
  INLINE VarType RangeVariable::varType() const { return VarType::RANGE; }
 
  INLINE bool RangeVariable::_checkSameDomain_(const gum::Variable& aRV) const {
    // we can assume that aRV is a RangeVariable
    const auto& cv = static_cast< const RangeVariable& >(aRV);
    if (_minBound_ != cv._minBound_) return false;
    if (_maxBound_ != cv._maxBound_) return false;
    return true;
  }
 
  INLINE std::string RangeVariable::stype() const { return "Range"; }
} /* namespace gum */