DBRowGeneratorParser.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_DB_ROW_GENERATOR_PARSER_H
#define GUM_LEARNING_DB_ROW_GENERATOR_PARSER_H

#include <limits>

#include <agrum/agrum.h>
#include <agrum/learning/database/DBHandler.h>
#include <agrum/learning/database/databaseTable.h>
#include <agrum/learning/database/DBRowGeneratorSet.h>

namespace gum {

  namespace learning {

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


      DBRowGeneratorParser( const typename DatabaseTable<ALLOC>::Handler& handler,
                            const DBRowGeneratorSet<ALLOC>& generator_set,
                            const allocator_type& alloc = allocator_type () );

      DBRowGeneratorParser( const DBRowGeneratorParser<ALLOC>& from );

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

      DBRowGeneratorParser(DBRowGeneratorParser<ALLOC>&& filter);

      DBRowGeneratorParser(DBRowGeneratorParser<ALLOC>&& filter,
                           const allocator_type& alloc );

      virtual DBRowGeneratorParser<ALLOC>* clone () const;

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

      virtual ~DBRowGeneratorParser();


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


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

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


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


      bool hasRows();


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

      void reset();

      typename DatabaseTable<ALLOC>::Handler& handler();

      const typename DatabaseTable<ALLOC>::Handler& handler() const;

      const DatabaseTable<ALLOC>& database () const;

      DBRowGeneratorSet<ALLOC>& generatorSet();

      const DBRowGeneratorSet<ALLOC>& generatorSet() const;


      void setRange(std::size_t begin, std::size_t end);

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

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


      template < typename GUM_SCALAR >
      void setBayesNet (const BayesNet<GUM_SCALAR>& new_bn);

      allocator_type getAllocator () const;


      
    private:
      
      typename DatabaseTable<ALLOC>::Handler __handler;

      DBRowGeneratorSet<ALLOC> __generator_set;

      std::size_t __generator_size;

    };

  } /* namespace learning */

} /* namespace gum */

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

#endif /* GUM_LEARNING_DB_ROW_GENERATOR_PARSER_H */