integerVariable_inl.h

Go to the documentation of this file.

/**
 *
 *   Copyright (c) 2005-2021 by Pierre-Henri WUILLEMIN(@LIP6) & Christophe GONZALES(@AMU)
 *   info_at_agrum_dot_org
 *
 *  This library is free software: you can redistribute it and/or modify
 *  it under the terms of 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.
 *
 *  This library 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


/** @file
 * @brief Base class for Integer discrete random variables
 *
 * @author Christophe GONZALES(@AMU) & Pierre-Henri WUILLEMIN(@LIP6)
 */
#include <ostream>
#include <sstream>
#include <string>
#include <algorithm>

#include <agrum/agrum.h>

#include <agrum/tools/core/hashTable.h>
#include <agrum/tools/variables/discreteVariable.h>

// to ease IDE parsers
#include <agrum/tools/variables/integerVariable.h>

#ifndef DOXYGEN_SHOULD_SKIP_THIS

namespace gum {

  /// Default constructor
  INLINE IntegerVariable::IntegerVariable(const std::string& aName,
                                          const std::string& aDesc) :
      DiscreteVariable(aName, aDesc) {
    // for debugging purposes
    GUM_CONSTRUCTOR(IntegerVariable);
  }


  /// copy constructor
  INLINE IntegerVariable::IntegerVariable(const IntegerVariable& from) :
      DiscreteVariable(from), _domain_(from._domain_) {
    // for debugging purposes
    GUM_CONS_CPY(IntegerVariable);
  }


  /// move constructor
  INLINE IntegerVariable::IntegerVariable(IntegerVariable&& from) :
      DiscreteVariable(std::move(from)), _domain_(std::move(from._domain_)) {
    from._domain_.clear();
    // for debugging purposes
    GUM_CONSTRUCTOR(IntegerVariable);
  }


  /// virtual copy constructor
  INLINE IntegerVariable* IntegerVariable::clone() const {
    return new IntegerVariable(*this);
  }


  /// destructor
  INLINE IntegerVariable::~IntegerVariable() {
    GUM_DESTRUCTOR(IntegerVariable);
  }


  /// copy operator
  INLINE IntegerVariable& IntegerVariable::operator=(const IntegerVariable& from) {
    // avoid self assignment
    if (&from != this) {
      DiscreteVariable::operator=(from);
      _domain_ = from._domain_;
    }

    return *this;
  }


  /// move operator
  INLINE IntegerVariable& IntegerVariable::operator=(IntegerVariable&& from) {
    // avoid self assignment
    if (&from != this) {
      DiscreteVariable::operator=(std::move(from));
      _domain_ = std::move(from._domain_);
      from._domain_.clear();
    }

    return *this;
  }


  /// inequality operator
  INLINE bool IntegerVariable::operator!=(const Variable& var) const {
    return !operator==(var);
  }


  /// returns the domain size of the discrete random variable
  INLINE Size IntegerVariable::domainSize() const {
    return _domain_.size();
  }


  /// returns the type of variable
  INLINE VarType IntegerVariable::varType() const {
    return VarType::Integer;
  }


  /// returns the index of a given label
  INLINE Idx IntegerVariable::index(const std::string& aLabel) const {
    try {
      return _domain_.pos(std::stoi(aLabel));
    } catch (...) {
      GUM_ERROR(NotFound, "label '" << aLabel << "' is unknown in " << this->toString());
    }
  }


  /// returns the ith label
  INLINE std::string IntegerVariable::label(Idx i) const {
    // note that if i is outside the domain, Sequence _domain_ will raise
    // an exception
    return std::to_string(_domain_[i]);
  }


  /// get a numerical representation of the indice-th value.
  INLINE double IntegerVariable::numerical(Idx i) const {
    return double(_domain_[i]);
  }


  /// returns the domain as a sequence of values
  INLINE const Sequence< int >& IntegerVariable::integerDomain() const {
     return _domain_;
  }


  /// substitute a value by another one
  INLINE void IntegerVariable::changeValue(int old_value, int new_value) {
    if (! _domain_.exists(old_value)) return;
    if (_domain_.exists(new_value)) {
      GUM_ERROR(DuplicateElement,
                "Value" << new_value << " already belongs to the domain of the variable");
    }

    eraseValue(old_value);
    addValue(new_value);
  }


  /// erase a value from the domain of the variable
  INLINE void IntegerVariable::eraseValue(int value) {
    _domain_.erase(value);
  }


  /// clear the domain of the variable
  INLINE void IntegerVariable::eraseValues() {
    _domain_.clear();
  }


} /* namespace gum */

#endif /* DOXYGEN SHOULD SKIP THIS */