rawDatabaseTable.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_RAW_DATABASE_TABLE_H
#define GUM_RAW_DATABASE_TABLE_H


#include <agrum/agrum.h>
#include <agrum/learning/database/DBCell.h>
#include <agrum/learning/database/IDatabaseTable.h>

namespace gum {

  namespace learning {

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

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

      template < typename TX_DATA >
      using Matrix = DBVector< Row< TX_DATA > >;

      template < template < typename > class XALLOC >
      using MissingValType = std::vector< std::string, XALLOC< std::string > >;

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

      using HandlerSafe = typename IDatabaseTable< DBCell, ALLOC >::HandlerSafe;

      using IsMissing = typename IDatabaseTable< DBCell, ALLOC >::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;
      using allocator_type = ALLOC< DBCell >;


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

      template < template < typename > class VARALLOC,
                 template < typename >
                 class MISSALLOC >
      RawDatabaseTable(
         const MissingValType< MISSALLOC >& missing_symbols,
         const std::vector< std::string, VARALLOC< std::string > >& var_names,
         const allocator_type& alloc = allocator_type());

      template < template < typename > class MISSALLOC >
      RawDatabaseTable(const MissingValType< MISSALLOC >& missing_symbols,
                       const allocator_type& alloc = allocator_type());

      RawDatabaseTable(const allocator_type& alloc = allocator_type());

      RawDatabaseTable(const RawDatabaseTable< ALLOC >& from);

      RawDatabaseTable(const RawDatabaseTable< ALLOC >& from,
                       const allocator_type&            alloc);

      RawDatabaseTable(RawDatabaseTable< ALLOC >&& from);

      RawDatabaseTable(RawDatabaseTable< ALLOC >&& from,
                       const allocator_type&       alloc);

      virtual RawDatabaseTable< ALLOC >* clone() const final;

      virtual RawDatabaseTable< ALLOC >*
         clone(const allocator_type& alloc) const final;

      virtual ~RawDatabaseTable();



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

      RawDatabaseTable< ALLOC >& operator=(const RawDatabaseTable< ALLOC >& from);

      RawDatabaseTable< ALLOC >& operator=(RawDatabaseTable< ALLOC >&& from);



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

      using IDatabaseTable< DBCell, ALLOC >::setVariableNames;


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


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

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

      virtual const DBVector< std::size_t > inputColumns() const final;

      using IDatabaseTable< DBCell, ALLOC >::insertRow;


      virtual void insertRow(
         const std::vector< std::string, ALLOC< 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 <agrum/learning/database/rawDatabaseTable_tpl.h>

#endif /* GUM_RAW_DATABASE_TABLE_H */