DBTranslator.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_TRANSLATOR_H
#define GUM_LEARNING_DB_TRANSLATOR_H

#include <string>
#include <limits>
#include <vector>
#include <utility>

#include <agrum/agrum.h>
#include <agrum/core/bijection.h>
#include <agrum/core/set.h>
#include <agrum/variables/variable.h>
#include <agrum/learning/database/DBTranslatedValue.h>


namespace gum {

  namespace learning {


    template < template < typename > class ALLOC = std::allocator >
    class DBTranslator : private ALLOC< DBTranslatedValue > {
      public:
      using allocator_type = ALLOC< DBTranslatedValue >;

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



      template < template < typename > class XALLOC >
      DBTranslator(
         DBTranslatedValueType                                    val_type,
         const std::vector< std::string, XALLOC< std::string > >& missing_symbols,
         const bool  editable_dictionary = true,
         std::size_t max_dico_entries = std::numeric_limits< std::size_t >::max(),
         const allocator_type& alloc = allocator_type());


      DBTranslator(
         DBTranslatedValueType val_type,
         const bool            editable_dictionary = true,
         std::size_t max_dico_entries = std::numeric_limits< std::size_t >::max(),
         const allocator_type& alloc = allocator_type());

      DBTranslator(const DBTranslator< ALLOC >& from);

      DBTranslator(const DBTranslator< ALLOC >& from, const allocator_type& alloc);

      DBTranslator(DBTranslator< ALLOC >&& from);

      DBTranslator(DBTranslator< ALLOC >&& from, const allocator_type& alloc);

      virtual DBTranslator< ALLOC >* clone() const = 0;

      virtual DBTranslator< ALLOC >* clone(const allocator_type& alloc) const = 0;

      virtual ~DBTranslator();



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


      DBTranslatedValue operator<<(const std::string& str);

      std::string operator>>(const DBTranslatedValue translated_val);



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



      virtual DBTranslatedValue translate(const std::string& str) = 0;


      virtual std::string
         translateBack(const DBTranslatedValue translated_val) const = 0;


      virtual std::size_t domainSize() const = 0;

      virtual bool hasEditableDictionary() const;

      virtual void setEditableDictionaryMode(bool new_mode);

      virtual bool needsReordering() const = 0;

      virtual HashTable< std::size_t,
                         std::size_t,
                         ALLOC< std::pair< std::size_t, std::size_t > > >
         reorder() = 0;

      const Set< std::string, ALLOC< std::string > >& missingSymbols() const;

      bool isMissingSymbol(const std::string& str) const;

      virtual const Variable* variable() const = 0;

      void setVariableName(const std::string& str) const;

      void setVariableDescription(const std::string& str) const;


      DBTranslatedValueType getValType() const;

      allocator_type getAllocator() const;

      bool isMissingValue(const DBTranslatedValue& val) const;

      virtual DBTranslatedValue missingValue() const = 0;



      protected:
      // ##########################################################################
      // ##########################################################################


      DBTranslator< ALLOC >& operator=(const DBTranslator< ALLOC >& from);

      DBTranslator< ALLOC >& operator=(DBTranslator< ALLOC >&& from);



      bool _is_dictionary_dynamic;

      std::size_t _max_dico_entries;

      Set< std::string, ALLOC< std::string > > _missing_symbols;


      mutable Bijection< std::size_t,
                         std::string,
                         ALLOC< std::pair< float, std::string > > >
         _back_dico;

      DBTranslatedValueType _val_type;
    };


  } /* namespace learning */

} /* namespace gum */

// always include the template implementation
#include <agrum/learning/database/DBTranslator_tpl.h>

#endif /* GUM_LEARNING_DB_TRANSLATOR_H */