DBRowGenerator.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_DBROW_GENERATOR_H
#define GUM_LEARNING_DBROW_GENERATOR_H

#include <vector>

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

namespace gum {

  namespace learning {

    enum class DBRowGeneratorGoal : char {
      // the generator's goal is only to remove all missing values
      ONLY_REMOVE_MISSING_VALUES,

      // the generator does something else than just missing values
      OTHER_THINGS_THAN_REMOVE_MISSING_VALUES
    };


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

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



      DBRowGenerator(
         const std::vector< DBTranslatedValueType, ALLOC< DBTranslatedValueType > >
                                  column_types,
         const DBRowGeneratorGoal goal,
         const allocator_type&    alloc = allocator_type());

      DBRowGenerator(const DBRowGenerator< ALLOC >& from);

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

      DBRowGenerator(DBRowGenerator< ALLOC >&& from);

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

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

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

      virtual ~DBRowGenerator();



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


      bool hasRows();


      bool setInputRow(const DBRow< DBTranslatedValue, ALLOC >& row);

      virtual const DBRow< DBTranslatedValue, ALLOC >& generate() = 0;


      void decreaseRemainingRows();

      virtual void reset();

      virtual void setColumnsOfInterest(
         const std::vector< std::size_t, ALLOC< std::size_t > >& cols_of_interest);

      virtual void setColumnsOfInterest(
         std::vector< std::size_t, ALLOC< std::size_t > >&& cols_of_interest);

      const std::vector< std::size_t, ALLOC< std::size_t > >&
         columnsOfInterest() const;

      allocator_type getAllocator() const;

      DBRowGeneratorGoal goal() const;



      protected:
      std::size_t _nb_remaining_output_rows{std::size_t(0)};


      std::vector< DBTranslatedValueType, ALLOC< DBTranslatedValueType > >
         _column_types;

      std::vector< std::size_t, ALLOC< std::size_t > > _columns_of_interest;

      DBRowGeneratorGoal _goal{
         DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES};


      DBRowGenerator< ALLOC >& operator=(const DBRowGenerator< ALLOC >&);

      DBRowGenerator< ALLOC >& operator=(DBRowGenerator< ALLOC >&&);

      virtual std::size_t
         _computeRows(const DBRow< DBTranslatedValue, ALLOC >& row) = 0;
    };

  } /* namespace learning */

} /* namespace gum */


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

#endif /* GUM_LEARNING_DBROW_GENERATOR_H */