DBTranslator4NumericalDiscreteVariable_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 <agrum/base/database/DBTranslator4NumericalDiscreteVariable.h>   // to ease IDE parser
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#  include <agrum/base/database/DBTranslator4NumericalDiscreteVariable.h>
 
namespace gum {
 
  namespace learning {

    INLINE DBTranslator4NumericalDiscreteVariable::~DBTranslator4NumericalDiscreteVariable() {
      // for debugging purposes
      GUM_DESTRUCTOR(DBTranslator4NumericalDiscreteVariable);
    }

    INLINE DBTranslatedValue
        DBTranslator4NumericalDiscreteVariable::translate(std::string_view str) {
      // try to get the index of str within the NumericalDiscrete variable.
      double     d;
      const bool b = isNumericalWithResult(str, &d);
      if (b) {
        const std::string cstr = compact_tostr(d);
        if (this->back_dico_.existsSecond(cstr)) return {this->back_dico_.first(cstr)};
      }
 
      if (this->isMissingSymbol(str))
        return DBTranslatedValue{std::numeric_limits< std::size_t >::max()};
 
      if (!b) {
        GUM_ERROR(TypeError,
                  "String \"" << str << "\" cannot be translated because it is not a number");
      } else {
        GUM_ERROR(UnknownLabelInDatabase,
                  "The translation of \"" << str << "\" could not be found for " << _variable_)
      }
    }

    INLINE std::string DBTranslator4NumericalDiscreteVariable::translateBack(
        const DBTranslatedValue translated_val) const {
      if (this->back_dico_.existsFirst(translated_val.discr_val))
        return this->back_dico_.second(translated_val.discr_val);
 
      // check if this is a missing value
      if ((translated_val.discr_val == std::numeric_limits< std::size_t >::max())
          && !this->missing_symbols_.empty()) {
        return *(this->missing_symbols_.begin());
      }
 
      GUM_ERROR(UnknownLabelInDatabase,
                "The back translation of \"" << translated_val.discr_val
                                             << "\" could not be found");
    }

    INLINE bool DBTranslator4NumericalDiscreteVariable::hasEditableDictionary() const {
      return false;
    }

    INLINE void DBTranslator4NumericalDiscreteVariable::setEditableDictionaryMode(bool) {}

    INLINE bool DBTranslator4NumericalDiscreteVariable::needsReordering() const { return false; }

    INLINE HashTable< std::size_t, std::size_t > DBTranslator4NumericalDiscreteVariable::reorder() {
      return HashTable< std::size_t, std::size_t >();
    }

    INLINE std::size_t DBTranslator4NumericalDiscreteVariable::domainSize() const {
      return _variable_.domainSize();
    }

    INLINE const NumericalDiscreteVariable*
        DBTranslator4NumericalDiscreteVariable::variable() const {
      return &_variable_;
    }

    INLINE DBTranslatedValue DBTranslator4NumericalDiscreteVariable::missingValue() const {
      return DBTranslatedValue{std::numeric_limits< std::size_t >::max()};
    }
 
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */