DBTranslator.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_TRANSLATOR_H
#define GUM_LEARNING_DB_TRANSLATOR_H
 
#include <limits>
#include <string>
#include <utility>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/core/set.h>
#include <agrum/base/database/DBTranslatedValue.h>
#include <agrum/base/variables/variable.h>
 
namespace gum {
 
  namespace learning {
 

    class DBTranslator {
      public:
      // ##########################################################################
      // ##########################################################################



      DBTranslator(DBTranslatedValueType             val_type,
                   const bool                        is_lossless,
                   const std::vector< std::string >& missing_symbols,
                   const bool                        editable_dictionary = true,
                   std::size_t max_dico_entries = std::numeric_limits< std::size_t >::max());


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

      DBTranslator(const DBTranslator& from);

      DBTranslator(DBTranslator&& from);

      virtual DBTranslator* clone() 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 const Bijection< std::size_t, std::string >& getDictionary() const;

      virtual bool needsReordering() const = 0;

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

      const Set< 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;


      bool isLossless() const;

      bool isMissingValue(const DBTranslatedValue& val) const;

      virtual DBTranslatedValue missingValue() const = 0;

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


      DBTranslator& operator=(const DBTranslator& from);

      DBTranslator& operator=(DBTranslator&& from);


      bool is_lossless_;

      bool is_dictionary_dynamic_;

      std::size_t max_dico_entries_;

      Set< std::string > missing_symbols_;


      mutable Bijection< std::size_t, std::string > back_dico_;

      DBTranslatedValueType val_type_;
    };
 
 
  } /* namespace learning */
 
} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/base/database/DBTranslator_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_DB_TRANSLATOR_H */