DBRow.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_ROW_H
#define GUM_LEARNING_DB_ROW_H
 
#include <cstddef>
#include <cstring>
#include <memory>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <initializer_list>
 
namespace gum {
 
  namespace learning {

    template < typename T_DATA >
    class DBRow {
      public:
      // ##########################################################################
      // ##########################################################################


      DBRow();

      DBRow(const std::size_t size, const double weight = 1.0);

      DBRow(const std::size_t size, const T_DATA default_value, const double weight);

      DBRow(std::initializer_list< T_DATA > list, const double weight = 1.0);

      DBRow(const std::vector< T_DATA >& cells, const double weight = 1.0);

      DBRow(std::vector< T_DATA >&& cells, const double weight = 1.0);

      DBRow(const DBRow< T_DATA >& from);

      DBRow(DBRow< T_DATA >&& from);

      DBRow< T_DATA >* clone() const;

      ~DBRow();

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


      DBRow< T_DATA >& operator=(const DBRow< T_DATA >& from);

      DBRow< T_DATA >& operator=(DBRow< T_DATA >&& from);


      T_DATA& operator[](const std::size_t i);


      const T_DATA& operator[](const std::size_t i) const;

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


      const std::vector< T_DATA >& row() const noexcept;

      std::vector< T_DATA >& row() noexcept;

      const double& weight() const noexcept;

      double& weight() noexcept;

      void setRow(const std::vector< T_DATA >& new_row);

      void setRow(std::vector< T_DATA >&& new_row);

      void setWeight(const double new_weight);

      std::size_t size() const noexcept;

      void resize(const std::size_t new_size);

      void reserve(const std::size_t new_size);

      void pushBack(const T_DATA& elt);

      void pushBack(T_DATA&& elt);

 
 
      protected:
      std::vector< T_DATA > row_;

      double weight_{1.0f};
    };
 
  } /* namespace learning */
 
} /* namespace gum */

#include <agrum/base/database/DBRow_tpl.h>
 
#endif /* GUM_LEARNING_DB_ROW_H */