DBTranslatorSet.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_SET_H
#define GUM_LEARNING_DB_TRANSLATOR_SET_H
 
#include <limits>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/DBTranslatorUtils.h>
 
#include <type_traits>
 
namespace gum {
 
  namespace learning {

    class DBTranslatorSet final {
      public:
      // ##########################################################################
      // ##########################################################################


      DBTranslatorSet();

      DBTranslatorSet(const DBTranslatorSet& from);

      DBTranslatorSet(DBTranslatorSet&& from);

      virtual DBTranslatorSet* clone() const;

      virtual ~DBTranslatorSet();

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


      DBTranslatorSet& operator=(const DBTranslatorSet& from);

      DBTranslatorSet& operator=(DBTranslatorSet&& from);


      DBTranslator& operator[](const std::size_t k);


      const DBTranslator& operator[](const std::size_t k) const;

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



      std::size_t insertTranslator(const DBTranslator& translator,
                                   const std::size_t   column,
                                   const bool          unique_column = true);

      std::size_t insertTranslator(const Variable&                   var,
                                   const std::size_t                 column,
                                   const std::vector< std::string >& missing_symbols,
                                   const bool                        unique_column = true);

      std::size_t insertTranslator(const Variable&   var,
                                   const std::size_t column,
                                   const bool        unique_column = true);


      template < class Translator >
      void changeTranslator(const Translator& new_translator, const std::size_t pos);

      void eraseTranslator(const std::size_t k, const bool k_is_input_col = false);


      DBTranslator& translator(const std::size_t k);


      const DBTranslator& translator(const std::size_t k) const;


      DBTranslator& translatorSafe(const std::size_t k);


      const DBTranslator& translatorSafe(const std::size_t k) const;


      DBTranslatedValue translate(const std::vector< std::string >& row, const std::size_t k) const;

      DBTranslatedValue translateSafe(const std::vector< std::string >& row,
                                      const std::size_t                 k) const;


      std::string translateBack(const DBTranslatedValue translated_val, const std::size_t k) const;

      std::string translateBackSafe(const DBTranslatedValue translated_val,
                                    const std::size_t       k) const;

      bool isMissingValue(const DBTranslatedValue translated_val, const std::size_t k) const;

      bool isMissingValueSafe(const DBTranslatedValue translated_val, const std::size_t k) const;


      std::size_t domainSize(const std::size_t k) const;


      std::size_t domainSizeSafe(const std::size_t k) const;


      const Variable& variable(const std::size_t k) const;


      const Variable& variableSafe(const std::size_t k) const;

      bool needsReordering(const std::size_t k) const;


      bool needsReorderingSafe(const std::size_t k) const;

      HashTable< std::size_t, std::size_t > reorder(const std::size_t k);


      HashTable< std::size_t, std::size_t > reorderSafe(const std::size_t k);

      std::size_t inputColumn(const std::size_t k) const;

      std::size_t inputColumnSafe(const std::size_t k) const;

      std::size_t highestInputColumn() const;

      void clear();

      std::size_t nbTranslators() const;

      std::size_t size() const;

      const std::vector< DBTranslator* >& translators() const;

 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
      private:
      // the set of all the translators
      std::vector< DBTranslator* > _translators_;
 
      // a vector indicating which column of the original database each
      // translator should translate
      std::vector< std::size_t > _columns_;
 
      // the highest column index read by the translators
      std::size_t _highest_column_{std::size_t(0)};

      void _copy_(const DBTranslatorSet& from);
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
// always include templated implementation
#include <agrum/base/database/DBTranslatorSet_tpl.h>
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/database/DBTranslatorSet_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_DB_TRANSLATOR_SET_H */