DBRowGenerator.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_DBROW_GENERATOR_H
#define GUM_LEARNING_DBROW_GENERATOR_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/DBRow.h>
#include <agrum/base/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
    };

    class DBRowGenerator {
      public:
      // ##########################################################################
      // ##########################################################################



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

      DBRowGenerator(const DBRowGenerator& from);

      DBRowGenerator(DBRowGenerator&& from);

      virtual DBRowGenerator* clone() const = 0;

      virtual ~DBRowGenerator();

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


      bool hasRows();


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

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


      void decreaseRemainingRows();

      virtual void reset();

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

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

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

      DBRowGeneratorGoal goal() const;

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


      std::vector< DBTranslatedValueType > column_types_;

      std::vector< std::size_t > columns_of_interest_;

      DBRowGeneratorGoal goal_{DBRowGeneratorGoal::OTHER_THINGS_THAN_REMOVE_MISSING_VALUES};
 

      DBRowGenerator& operator=(const DBRowGenerator&);

      DBRowGenerator& operator=(DBRowGenerator&&);

      virtual std::size_t computeRows_(const DBRow< DBTranslatedValue >& row) = 0;
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/database/DBRowGenerator_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_DBROW_GENERATOR_H */