rawDatabaseTable.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_RAW_DATABASE_TABLE_H
#define GUM_RAW_DATABASE_TABLE_H
 
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/IDatabaseTable.h>
 
namespace gum {
 
  namespace learning {

    class RawDatabaseTable: public IDatabaseTable< DBCell > {
      public:
      template < typename TX_DATA >
      using DBVector = std::vector< TX_DATA >;

      template < typename TX_DATA >
      using Row = DBRow< TX_DATA >;

      template < typename TX_DATA >
      using Matrix = DBVector< Row< TX_DATA > >;
 
      using MissingValType = std::vector< std::string >;

      using Handler = typename IDatabaseTable< DBCell >::Handler;

      using HandlerSafe = typename IDatabaseTable< DBCell >::HandlerSafe;
 
      using IsMissing = typename IDatabaseTable< DBCell >::IsMissing;

      using value_type      = Row< DBCell >;
      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 iterator        = Handler;
      using iterator_safe   = HandlerSafe;
 
 
      // ##########################################################################
      // ##########################################################################

      RawDatabaseTable(const MissingValType&             missing_symbols,
                       const std::vector< std::string >& var_names);

      RawDatabaseTable(const MissingValType& missing_symbols);

      RawDatabaseTable();

      RawDatabaseTable(const RawDatabaseTable& from);

      RawDatabaseTable(RawDatabaseTable&& from);

      virtual RawDatabaseTable* clone() const final;

      virtual ~RawDatabaseTable();

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

      RawDatabaseTable& operator=(const RawDatabaseTable& from);

      RawDatabaseTable& operator=(RawDatabaseTable&& from);

 
 
      // ##########################################################################
      // ##########################################################################
 
      using IDatabaseTable< DBCell >::setVariableNames;


      void setVariableNames(const std::vector< std::string >& names,
                            const bool                        from_external_object = true) final;


      void ignoreColumn(const std::size_t k, const bool from_external_object = true) final;

      const DBVector< std::size_t > ignoredColumns() const final;

      const DBVector< std::size_t > inputColumns() const final;
 
      using IDatabaseTable< DBCell >::insertRow;


      void insertRow(const std::vector< std::string >& new_row) final;

      virtual void clear() final;

 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
      private:
      // the set of ignored columns, sorted by increasing order
      DBVector< std::size_t > _ignored_cols_;

      DBCell _convert_(const std::string& elt) const;
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };
 
  } /* namespace learning */
 
} /* namespace gum */
 
// include the inlined functions if necessary
#ifndef GUM_NO_INLINE
#  include <agrum/base/database/rawDatabaseTable_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_RAW_DATABASE_TABLE_H */