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

    INLINE DBCell::DBCell() : _val_index_(0) {
      GUM_CONSTRUCTOR(DBCell);
      ;
    }

    INLINE DBCell::DBCell(const float nb) : _type_(DBCell::EltType::REAL), _val_real_(nb) {
      GUM_CONSTRUCTOR(DBCell);
    }

    INLINE DBCell::DBCell(const int nb) : _type_(DBCell::EltType::INTEGER), _val_integer_(nb) {
      GUM_CONSTRUCTOR(DBCell);
    }

    INLINE DBCell::DBCell(const std::string& str) : _type_(DBCell::EltType::STRING) {
      // store the string into the static list of strings
      if (!_strings_().existsFirst(str)) {
        _strings_().insert(str, _string_max_index_);
        _val_index_ = _string_max_index_;
        ++_string_max_index_;
      } else {
        _val_index_ = _strings_().second(str);
      }
 
      GUM_CONSTRUCTOR(DBCell);
    }

    INLINE DBCell::DBCell(const DBCell& from) : _type_(from._type_) {
      std::memcpy(&_val_index_, &(from._val_index_), sizeof(UnionType));
 
      // for debugging
      GUM_CONS_CPY(DBCell);
    }

    INLINE DBCell::DBCell(DBCell&& from) : _type_(from._type_) {
      std::memcpy(&_val_index_, &(from._val_index_), sizeof(UnionType));
 
      // for debugging
      GUM_CONS_MOV(DBCell);
    }

    INLINE DBCell::~DBCell() {
      GUM_DESTRUCTOR(DBCell);
      ;
    }

    INLINE DBCell& DBCell::operator=(const DBCell& from) {
      if (this != &from) {
        _type_ = from._type_;
        std::memcpy(&_val_index_, &(from._val_index_), sizeof(UnionType));
      }
 
      return *this;
    }

    INLINE DBCell& DBCell::operator=(DBCell&& from) {
      if (this != &from) {
        _type_ = from._type_;
        std::memcpy(&_val_index_, &(from._val_index_), sizeof(UnionType));
      }
 
      return *this;
    }

    INLINE DBCell& DBCell::operator=(const float x) {
      _type_     = EltType::REAL;
      _val_real_ = x;
      return *this;
    }

    INLINE DBCell& DBCell::operator=(const int x) {
      _type_        = EltType::INTEGER;
      _val_integer_ = x;
      return *this;
    }

    INLINE DBCell& DBCell::operator=(const std::string& str) {
      if (!_strings_().existsFirst(str)) {
        _strings_().insert(str, _string_max_index_);
        _val_index_ = _string_max_index_;
        ++_string_max_index_;
      } else {
        _val_index_ = _strings_().second(str);
      }
      _type_ = EltType::STRING;
 
      return *this;
    }

    INLINE bool DBCell::operator==(const DBCell& from) const {
      return (_type_ == from._type_)
          && ((_type_ == EltType::MISSING)
              || ((_type_ == EltType::REAL) && (_val_real_ == from._val_real_))
              || (_val_integer_ == from._val_integer_));
    }

    INLINE DBCell::EltType DBCell::type() const noexcept { return _type_; }

    INLINE float DBCell::real() const {
      if (_type_ == EltType::REAL) return _val_real_;
      else GUM_ERROR(TypeError, _typeErrorMsg_("a real number"))
    }

    INLINE void DBCell::setReal(const float x) {
      _type_     = EltType::REAL;
      _val_real_ = x;
    }

    INLINE void DBCell::setReal(std::string_view elt) {
      if (!isReal(elt)) GUM_ERROR(TypeError, "the string does not contain a real number")
      _val_real_ = std::stof(std::string(elt));
      _type_     = EltType::REAL;
    }

    INLINE int DBCell::integer() const {
      if (_type_ == EltType::INTEGER) return _val_integer_;
      else GUM_ERROR(TypeError, _typeErrorMsg_("an integer"))
    }

    INLINE void DBCell::setInteger(const int x) {
      _type_        = EltType::INTEGER;
      _val_integer_ = x;
    }

    INLINE void DBCell::setInteger(std::string_view elt) {
      if (!isInteger(elt)) GUM_ERROR(TypeError, "the string does not contain an integer")
      _val_integer_ = std::stoi(std::string(elt));
      _type_        = EltType::INTEGER;
    }

    INLINE const std::string& DBCell::string() const {
      if (_type_ == EltType::STRING) return _strings_().first(_val_index_);
      else GUM_ERROR(TypeError, _typeErrorMsg_("a string"))
    }

    INLINE int DBCell::stringIndex() const {
      if (_type_ == EltType::STRING) return _val_index_;
      else GUM_ERROR(TypeError, _typeErrorMsg_("a string"))
    }

    INLINE const std::string& DBCell::string(const int index) { return _strings_().first(index); }

    INLINE void DBCell::setString(const std::string& str) {
      if (!_strings_().existsFirst(str)) {
        _strings_().insert(str, _string_max_index_);
        _val_index_ = _string_max_index_;
        ++_string_max_index_;
      } else {
        _val_index_ = _strings_().second(str);
      }
      _type_ = EltType::STRING;
    }

    INLINE void DBCell::setMissingState() { _type_ = EltType::MISSING; }

    INLINE bool DBCell::isMissing() const { return _type_ == EltType::MISSING; }
 
    // checks whether a string correspond to a missing value
    INLINE bool DBCell::isMissing(std::string_view                  str,
                                  const std::vector< std::string >& missingVals) {
      for (const auto& missing: missingVals) {
        if (str == missing) return true;
      }
      return false;
    }
 
    // returns the best type to store a given element encoded as a string
    INLINE DBCell::EltType DBCell::bestType(std::string_view                  str,
                                            const std::vector< std::string >& missingVals) {
      if (isMissing(str, missingVals)) return EltType::MISSING;
      if (isInteger(str)) return EltType::INTEGER;
      if (isReal(str)) return EltType::REAL;
      return EltType::STRING;
    }
 
    // returns the DBCell with the best type for an element encoded as a string
    INLINE DBCell DBCell::bestDBCell(std::string_view                  str,
                                     const std::vector< std::string >& missingVals) {
      if (isMissing(str, missingVals)) return {};
      if (isInteger(str)) return DBCell(std::stoi(std::string(str)));
      if (isReal(str)) return DBCell(std::stof(std::string(str)));
 
      return DBCell(std::string(str));
    }
 
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */