DBHandler.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_LEARNING_DB_HANDLER_H
#define GUM_LEARNING_DB_HANDLER_H
 
#include <cstddef>
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/DBRow.h>
 
namespace gum {
 
  namespace learning {

    template < typename T_DATA >
    class DBHandler {
      public:
      using iterator_category = std::random_access_iterator_tag;
      using value_type        = DBRow< T_DATA >;
      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;

      template < typename TX_DATA >
      using DBVector = std::vector< 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 */