idSet.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_LEARNING_ID_SET_H
#define GUM_LEARNING_ID_SET_H

#include <iostream>
#include <sstream>
#include <string>
#include <type_traits>
#include <utility>
#include <vector>

#include <agrum/agrum.h>
#include <agrum/core/sequence.h>
#include <agrum/graphs/graphElements.h>

namespace gum {

  namespace learning {


    template < template < typename > class ALLOC >
    class IdSet;


    template < template < typename > class ALLOC = std::allocator >
    class IdSetIterator {
      public:
      using iterator_category = std::forward_iterator_tag;
      using value_type = NodeId;
      using reference = NodeId&;
      using const_reference = const NodeId&;
      using pointer = NodeId*;
      using const_pointer = const NodeId*;
      using difference_type = std::ptrdiff_t;


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


      IdSetIterator();


      IdSetIterator(const IdSet< ALLOC >& idset);

      IdSetIterator(const IdSetIterator< ALLOC >& from);

      IdSetIterator(IdSetIterator< ALLOC >&& from);

      virtual ~IdSetIterator();



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

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

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

      NodeId operator*() const;

      bool operator!=(const IdSetIterator< ALLOC >& from) const;

      bool operator==(const IdSetIterator< ALLOC >& from) const;

      IdSetIterator< ALLOC >& operator++();

      IdSetIterator< ALLOC >& operator+=(const std::size_t i);

      IdSetIterator< ALLOC > operator+(const std::size_t i);



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

      std::size_t pos() const;



#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      const Sequence< NodeId, ALLOC< NodeId > >* __seq{nullptr};

      std::size_t __index{std::size_t(0)};


      void __gotoEnd();

      friend class IdSet< ALLOC >;

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };


    template < template < typename > class ALLOC = std::allocator >
    class IdSet : private ALLOC< NodeId > {
      public:
      using allocator_type = ALLOC< NodeId >;

      using iterator = IdSetIterator< ALLOC >;
      using const_iterator = IdSetIterator< ALLOC >;
      using iterator_safe = IdSetIterator< ALLOC >;
      using const_iterator_safe = IdSetIterator< ALLOC >;

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

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


      IdSet(const std::vector< NodeId, ALLOC< NodeId > >& ids,
            const bool                                    rhs_ids,
            const bool                                    ordered_ids,
            const allocator_type& alloc = allocator_type());


      IdSet(NodeId                                        var1,
            const std::vector< NodeId, ALLOC< NodeId > >& rhs_ids,
            const bool                                    ordered_rhs_ids = false,
            const allocator_type& alloc = allocator_type());


      IdSet(NodeId                                        var1,
            NodeId                                        var2,
            const std::vector< NodeId, ALLOC< NodeId > >& rhs_ids,
            const bool                                    ordered_lhs_vars,
            const bool                                    ordered_rhs_ids = false,
            const allocator_type& alloc = allocator_type());


      IdSet(NodeId                                        var1,
            NodeId                                        var2,
            NodeId                                        var3,
            const std::vector< NodeId, ALLOC< NodeId > >& rhs_ids,
            const bool                                    ordered_lhs_vars,
            const bool                                    ordered_rhs_ids = false,
            const allocator_type& alloc = allocator_type());

      IdSet(const IdSet< ALLOC >& from);

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

      IdSet(IdSet< ALLOC >&& from);

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

      virtual IdSet< ALLOC >* clone() const;

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

      virtual ~IdSet();



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

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

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

      NodeId operator[](const std::size_t index) const;

      bool operator==(const IdSet< ALLOC >& from) const;

      bool operator!=(const IdSet< ALLOC >& from) const;



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

      iterator_safe beginSafe() const;

      const iterator_safe& endSafe() const;

      iterator begin() const;

      const iterator& end() const;



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

      const Sequence< NodeId, ALLOC< NodeId > >& ids() const;

      IdSet< ALLOC > conditionalIdSet() const;

      std::size_t nbLHSIds() const;

      std::size_t nbRHSIds() const;

      bool contains(const IdSet< ALLOC >& set) const;

      void clear();

      std::size_t size() const;


      std::size_t pos(const NodeId id) const;

      bool exists(const NodeId id) const;


      void erase(const NodeId id);

      bool hasConditioningSet() const;

      bool empty() const;

      std::string toString() const;

      allocator_type getAllocator() const;



#ifndef DOXYGEN_SHOULD_SKIP_THIS

      private:
      Sequence< NodeId, ALLOC< NodeId > > __ids;

      std::size_t __nb_lhs_ids{std::size_t(0)};

      IdSetIterator< ALLOC > __end_safe;

#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };


    template < template < typename > class ALLOC >
    std::ostream& operator<<(std::ostream& stream, const IdSet< ALLOC >& idset);

  } /* namespace learning */


  template < template < typename > class ALLOC >
  class HashFunc< learning::IdSet< ALLOC > >
      : public HashFuncBase< learning::IdSet< ALLOC > > {
    public:
    static Size castToSize(const learning::IdSet< ALLOC >& key);

    virtual Size
       operator()(const learning::IdSet< ALLOC >& key) const override final;
  };


} /* namespace gum */


// always include the template implementation
#include <agrum/learning/scores_and_tests/idSet_tpl.h>

#endif /* GUM_LEARNING_ID_SET_H */