DBTranslator4ContinuousVariable.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {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_4_CONTINUOUS_VARIABLE_H
#define GUM_LEARNING_DB_TRANSLATOR_4_CONTINUOUS_VARIABLE_H

#include <string>

#include <agrum/agrum.h>
#include <agrum/core/hashTable.h>
#include <agrum/learning/database/DBTranslator.h>
#include <agrum/variables/continuousVariable.h>


namespace gum {

  namespace learning {


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


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



      template < template < typename > class XALLOC >
      DBTranslator4ContinuousVariable(
         const std::vector< std::string, XALLOC< std::string > >& missing_symbols,
         const bool            fit_range = false,
         const allocator_type& alloc = allocator_type());


      DBTranslator4ContinuousVariable(
         const bool            fit_range = false,
         const allocator_type& alloc = allocator_type());


      template < typename GUM_SCALAR, template < typename > class XALLOC >
      DBTranslator4ContinuousVariable(
         const ContinuousVariable< GUM_SCALAR >&                  var,
         const std::vector< std::string, XALLOC< std::string > >& missing_symbols,
         const bool            fit_range = false,
         const allocator_type& alloc = allocator_type());

      template < typename GUM_SCALAR >
      DBTranslator4ContinuousVariable(
         const ContinuousVariable< GUM_SCALAR >& var,
         const bool                              fit_range = false,
         const allocator_type&                   alloc = allocator_type());


      template < template < typename > class XALLOC >
      DBTranslator4ContinuousVariable(
         const IContinuousVariable&                               var,
         const std::vector< std::string, XALLOC< std::string > >& missing_symbols,
         const bool            fit_range = false,
         const allocator_type& alloc = allocator_type());

      DBTranslator4ContinuousVariable(
         const IContinuousVariable& var,
         const bool                 fit_range = false,
         const allocator_type&      alloc = allocator_type());

      DBTranslator4ContinuousVariable(
         const DBTranslator4ContinuousVariable< ALLOC >& from);

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

      DBTranslator4ContinuousVariable(
         DBTranslator4ContinuousVariable< ALLOC >&& from);

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

      virtual DBTranslator4ContinuousVariable< ALLOC >* clone() const;

      virtual DBTranslator4ContinuousVariable< ALLOC >*
         clone(const allocator_type& alloc) const;

      virtual ~DBTranslator4ContinuousVariable();



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


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

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



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



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


      virtual std::string
         translateBack(const DBTranslatedValue translated_val) const final;

      virtual std::size_t domainSize() const final;

      virtual bool needsReordering() const final;

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

      virtual const IContinuousVariable* variable() const final;

      virtual DBTranslatedValue missingValue() const final;



#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      // the ContinuousVariable really used by the translator. As its values
      // are floats, this speeds-up translations
      ContinuousVariable< float > __variable;

      // the ContinuousVariablee returned by method variable ()
      // We must return a IContinuousVariable because the user may have
      // saved into the translator a ContinuousVariable<X>, with X != float
      IContinuousVariable* __real_variable;

      // assign to each float missing symbol a Boolean indicating whether
      // we already translated it or not. If we translated it, then we cannot
      // change the range of the variable so that this range contains the symbol.
      HashTable< std::string, bool, ALLOC< std::pair< float, bool > > >
         __status_float_missing_symbols;

      // a string containing a non real missing symbol
      // (useful for back translations)
      std::string __nonfloat_missing_symbol;

      // indicates whether we should fit the range of the observed values
      bool __fit_range;

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */


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

#endif /* GUM_LEARNING_DB_TRANSLATOR_4_CONTINUOUS_VARIABLE_H */