DBHandler.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_HANDLER_H
#define GUM_LEARNING_DB_HANDLER_H

#include <cstddef>
#include <utility>
#include <memory>
#include <vector>
#include <string>

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

namespace gum {

  namespace learning {

    template < typename T_DATA,
               template < typename > class ALLOC = std::allocator >
    class DBHandler {
      public:
      using iterator_category = std::random_access_iterator_tag;
      using value_type = DBRow< T_DATA, ALLOC >;
      using reference = value_type&;
      using const_reference = const value_type&;
      using pointer = value_type*;
      using const_pointer = const value_type*;
      using size_type = std::size_t;
      using difference_type = std::ptrdiff_t;
      using allocator_type = ALLOC< void >;

      template < typename TX_DATA >
      using DBVector = std::vector< TX_DATA, ALLOC< TX_DATA > >;


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



      virtual std::size_t size() const = 0;

      virtual std::size_t DBSize() const = 0;


      virtual const_reference rowSafe() const = 0;


      virtual reference rowSafe() = 0;


      virtual const_reference row() const = 0;


      virtual reference row() = 0;


      virtual void nextRow() = 0;


      virtual std::size_t numRow() const = 0;


      virtual bool hasRows() const = 0;

      virtual void reset() = 0;


      virtual void setRange(std::size_t begin, std::size_t end) = 0;


      virtual std::pair< std::size_t, std::size_t > range() const = 0;

      virtual const DBVector< std::string >& variableNames() const = 0;

      virtual std::size_t nbVariables() const = 0;



#ifndef DOXYGEN_SHOULD_SKIP_THIS

      protected:
      // the cache used to avoid cacheline problems due to parallelism
      static constexpr int _cache_size{128};

      // a buffer to avoid cacheline problems due to parallelism
      char _align[_cache_size];

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };

  } /* namespace learning */

} /* namespace gum */

#endif /* GUM_LEARNING_DB_HANDLER_H */