DBRowGenerator_inl.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                           *
 *                                                                          *
 ****************************************************************************/
#pragma once
 

#include <agrum/base/database/DBRowGenerator.h>
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
namespace gum {
 
  namespace learning {

    INLINE DBRowGenerator::DBRowGenerator(const std::vector< DBTranslatedValueType >& column_types,
                                          const DBRowGeneratorGoal                    goal) :
        column_types_(column_types), goal_(goal) {
      GUM_CONSTRUCTOR(DBRowGenerator);
    }

    INLINE DBRowGenerator::DBRowGenerator(const DBRowGenerator& from) :
        nb_remaining_output_rows_(from.nb_remaining_output_rows_),
        column_types_(from.column_types_), columns_of_interest_(from.columns_of_interest_),
        goal_(from.goal_) {
      GUM_CONS_CPY(DBRowGenerator);
    }

    INLINE DBRowGenerator::DBRowGenerator(DBRowGenerator&& from) :
        nb_remaining_output_rows_(from.nb_remaining_output_rows_),
        column_types_(std::move(from.column_types_)),
        columns_of_interest_(std::move(from.columns_of_interest_)), goal_(from.goal_) {
      GUM_CONS_MOV(DBRowGenerator);
    }

    INLINE DBRowGenerator::~DBRowGenerator() { GUM_DESTRUCTOR(DBRowGenerator); }

    INLINE DBRowGenerator& DBRowGenerator::operator=(const DBRowGenerator& from) {
      nb_remaining_output_rows_ = from.nb_remaining_output_rows_;
      column_types_             = from.column_types_;
      columns_of_interest_      = from.columns_of_interest_;
      goal_                     = from.goal_;
      return *this;
    }

    INLINE DBRowGenerator& DBRowGenerator::operator=(DBRowGenerator&& from) {
      nb_remaining_output_rows_ = from.nb_remaining_output_rows_;
      column_types_             = std::move(from.column_types_);
      columns_of_interest_      = std::move(from.columns_of_interest_);
      goal_                     = from.goal_;
      return *this;
    }

    INLINE bool DBRowGenerator::hasRows() { return nb_remaining_output_rows_ != std::size_t(0); }

    INLINE bool DBRowGenerator::setInputRow(const DBRow< DBTranslatedValue >& row) {
      nb_remaining_output_rows_ = computeRows_(row);
      return hasRows();
    }

    INLINE void DBRowGenerator::decreaseRemainingRows() { --nb_remaining_output_rows_; }

    INLINE void DBRowGenerator::reset() { nb_remaining_output_rows_ = 0; }
 
    // sets the columns of interest: the output DBRow needs only
    // contain values fot these columns
    INLINE void
        DBRowGenerator::setColumnsOfInterest(const std::vector< std::size_t >& cols_of_interest) {
      columns_of_interest_ = cols_of_interest;
    }
 
    // sets the columns of interest: the output DBRow needs only
    // contain values fot these columns
    INLINE void
        DBRowGenerator::setColumnsOfInterest(std::vector< std::size_t >&& cols_of_interest) {
      columns_of_interest_ = std::move(cols_of_interest);
    }

    INLINE const std::vector< std::size_t >& DBRowGenerator::columnsOfInterest() const {
      return columns_of_interest_;
    }

    INLINE DBRowGeneratorGoal DBRowGenerator::goal() const { return goal_; }
 
 
  } /* namespace learning */
 
} /* namespace gum */
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */