DBCell.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_LEARNING_DB_CELL_H
#define GUM_LEARNING_DB_CELL_H
 
#include <cstring>
#include <stdexcept>
#include <string>
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/bijection.h>
 
#include <type_traits>
 
namespace gum {
 
  namespace learning {

    class DBCell {
      public:
      enum class EltType : unsigned char { REAL, INTEGER, STRING, MISSING };
 
      // ##########################################################################
      // ##########################################################################


      DBCell();

      DBCell(const float nb);

      DBCell(const int nb);

      DBCell(const std::string& str);

      DBCell(const DBCell& from);

      DBCell(DBCell&& from);

      ~DBCell();

 
 
      // ##########################################################################
      // ##########################################################################


      DBCell& operator=(const DBCell& from);

      DBCell& operator=(DBCell&& from);

      DBCell& operator=(const float x);

      DBCell& operator=(const int x);

      DBCell& operator=(const std::string& x);

      bool operator==(const DBCell& from) const;

      bool operator!=(const DBCell& from) const;

 
 
      // ##########################################################################
      // ##########################################################################


      EltType type() const noexcept;


      bool convertType(const EltType newtype);


      float real() const;

      void setReal(const float x);


      void setReal(const std::string& elt);


      int integer() const;

      void setInteger(const int x);


      void setInteger(const std::string& elt);


      const std::string& string() const;

      int stringIndex() const;

      void setString(const std::string& elt);

      void setMissingState();

      bool isMissing() const;

 
 
      // ##########################################################################
      // ##########################################################################



      static const std::string& string(const int index);


      static EltType bestType(const std::string&                str,
                              const std::vector< std::string >& missingVals);


      static DBCell bestDBCell(const std::string&                str,
                               const std::vector< std::string >& missingVals);


      std::string toString(const std::vector< std::string >& missingVals) const;

      static bool isInteger(const std::string& str);

      static bool isReal(const std::string& str);

      static bool isMissing(const std::string& str, const std::vector< std::string >& missingVals);

 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
      private:
      // the real type of the last element read from the database
      EltType _type_{EltType::MISSING};
 
      // the element read from the database
      union {
        int   _val_index_;     // stores string indices. Basically, it should have
        int   _val_integer_;   // been an Idx, but int are shorter than Idx.
        float _val_real_;
      };
 
      // determine the longest type of the union. This is used for fast
      // copying/moving DBCells
      using UnionType = typename std::conditional< sizeof(int) < sizeof(float), float, int >::type;
 
      // raises an appropriate exception when encountering a type error
      std::string _typeErrorMsg_(const std::string& real_type) const;
 
 
      // a bijection assigning to each string index its corresponding string
      static Bijection< std::string, int >& _strings_();
 
      // the last index used so far
      static int _string_max_index_;
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };
 
  } /* namespace learning */
 
} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/base/database/DBCell_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_DB_CELL_H */