DBRowGeneratorIdentity.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_IDENTITY_H
#define GUM_LEARNING_DBROW_GENERATOR_IDENTITY_H

#include <agrum/agrum.h>
#include <agrum/learning/database/DBRowGenerator.h>

namespace gum {

  namespace learning {

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

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


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

      DBRowGeneratorIdentity(const DBRowGeneratorIdentity< ALLOC >& from);

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

      DBRowGeneratorIdentity(DBRowGeneratorIdentity< ALLOC >&& from);

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

      virtual DBRowGeneratorIdentity< ALLOC >* clone() const override final;

      virtual DBRowGeneratorIdentity< ALLOC >*
         clone(const allocator_type& alloc) const override final;

      ~DBRowGeneratorIdentity();



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


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

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



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


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

      allocator_type getAllocator() const;



      protected:
      virtual std::size_t
         _computeRows(const DBRow< DBTranslatedValue, ALLOC >& row) final;


#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      const DBRow< DBTranslatedValue, ALLOC >* __input_row{nullptr};

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */


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

#endif /* GUM_LEARNING_DBROW_GENERATOR_IDENTITY_H */