IDBInitializer.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_IDB_INITILIALIZER_H
#define GUM_LEARNING_IDB_INITILIALIZER_H

#include <vector>
#include <string>

#include <agrum/agrum.h>
#include <agrum/learning/database/DBCell.h>
#include <agrum/learning/database/DBRow.h>


namespace gum {

  namespace learning {

    template < template < typename > class ALLOC >
    class IDBInitializer {
      public:
      enum class InputType : char { STRING, DBCELL };

      using allocator_type = ALLOC< std::string >;

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


      IDBInitializer(const InputType type, const allocator_type& alloc);

      IDBInitializer(const IDBInitializer< ALLOC >& from);

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

      IDBInitializer(IDBInitializer< ALLOC >&& from);

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

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

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

      virtual ~IDBInitializer();



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

      const std::vector< std::string, ALLOC< std::string > >& variableNames();


      template < template < template < typename > class > class DATABASE >
      void fillDatabase(DATABASE< ALLOC >& database,
                        const bool         retry_insertion = false);

      std::size_t throwingColumn() const;

      allocator_type getAllocator() const;



      protected:
      IDBInitializer< ALLOC >& operator=(const IDBInitializer< ALLOC >& from);

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

      virtual std::vector< std::string, ALLOC< std::string > >
         _variableNames() = 0;


      virtual const std::vector< std::string, ALLOC< std::string > >&
         _currentStringRow();


      virtual const DBRow< DBCell, ALLOC >& _currentDBCellRow();

      virtual bool _nextRow() = 0;


#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      // the names of the variables
      std::vector< std::string, ALLOC< std::string > > __var_names;

      // the types of the input data read to fill the database
      InputType __input_type;

      // indicates whether an exception was raised when adding the last row
      // into the database. If so, when filling again the database, we may
      // try to insert again the same row
      bool __last_insertion_failed{false};


      template < template < template < typename > class > class DATABASE >
      void __fillDatabaseFromStrings(DATABASE< ALLOC >& database,
                                     const bool         retry_insertion);

      template < template < template < typename > class > class DATABASE >
      void __fillDatabaseFromDBCells(DATABASE< ALLOC >& database,
                                     const bool         retry_insertion);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */

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

#endif /* GUM_LEARNING_IDB_INITILIALIZER_H */