DBCell.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_LEARNING_DB_CELL_H
#define GUM_LEARNING_DB_CELL_H

#include <cstring>
#include <stdexcept>
#include <string>
#include <type_traits>
#include <utility>

#include <agrum/agrum.h>
#include <agrum/core/bijection.h>

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);


      template < template < typename > class ALLOC = std::allocator >
      static EltType bestType(
         const std::string&                                      str,
         const std::vector< std::string, ALLOC< std::string > >& missingVals);


      template < template < typename > class ALLOC = std::allocator >
      static DBCell bestDBCell(
         const std::string&                                      str,
         const std::vector< std::string, ALLOC< std::string > >& missingVals);


      template < template < typename > class ALLOC = std::allocator >
      std::string toString(const std::vector< std::string, ALLOC< std::string > >&
                              missingVals) const;

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

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

      template < template < typename > class ALLOC = std::allocator >
      static bool isMissing(
         const std::string&                                      str,
         const std::vector< std::string, ALLOC< 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/learning/database/DBCell_inl.h>
#endif /* GUM_NO_INLINE */

#include <agrum/learning/database/DBCell_tpl.h>

#endif /* GUM_LEARNING_DB_CELL_H */