set_of.hh

// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena 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, version 2 of the License.
//
// Olena 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 Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_CORE_INTERNAL_SET_OF_HH
# define MLN_CORE_INTERNAL_SET_OF_HH


# include <vector>
# include <set>
# include <iterator>
# include <algorithm>

# include <mln/core/contract.hh>
# include <mln/core/internal/force_exact.hh>


namespace mln
{

  namespace internal
  {

    template <typename E>
    class set_of_
    {
    public:


      set_of_<E>& insert(const E& elt);


      set_of_<E>& remove(const E& elt);


      const E& element(unsigned i) const;


      unsigned nelements() const;


      bool has(const E& elt) const;


      bool is_empty() const;


      void clear();


      const std::vector<E>& vect() const;

    protected:

      set_of_();

    private:

      mutable std::vector<E> v_;

    protected:
      std::set<E> s_;

    private:
      void update_() const;

      mutable bool needs_update_;
    };


    // FIXME : ambiguous with site_set operator <<
    //     template <typename E>
    //     std::ostream& operator<<(std::ostream& ostr, const set_of_<E>& s);



# ifndef MLN_INCLUDE_ONLY

    template <typename E>
    inline
    set_of_<E>::set_of_()
    {
      needs_update_ = false;
    }

    template <typename E>
    inline
    set_of_<E>&
    set_of_<E>::insert(const E& elt)
    {
      s_.insert(elt);
      if (needs_update_ == false)
        needs_update_ = true;
      return internal::force_exact< set_of_<E> >(*this);
    }

    template <typename E>
    inline
    set_of_<E>&
    set_of_<E>::remove(const E& elt)
    {
      s_.erase(elt);
      if (needs_update_ == false)
        needs_update_ = true;
      return internal::force_exact< set_of_<E> >(*this);
    }

    template <typename E>
    inline
    const E&
    set_of_<E>::element(unsigned i) const
    {
      if (needs_update_)
        update_();
      mln_precondition(i < v_.size());
      return v_[i];
    }

    template <typename E>
    inline
    unsigned
    set_of_<E>::nelements() const
    {
      if (needs_update_)
        update_();
      return v_.size();
    }

    template <typename E>
    inline
    bool
    set_of_<E>::has(const E& elt) const
    {
      return s_.find(elt) != s_.end();
    }

    template <typename E>
    inline
    bool
    set_of_<E>::is_empty() const
    {
      return nelements() == 0;
    }

    template <typename E>
    inline
    void
    set_of_<E>::clear()
    {
      v_.clear();
      s_.clear();
      needs_update_ = false;
      mln_postcondition(is_empty());
    }

    template <typename E>
    inline
    const std::vector<E>&
    set_of_<E>::vect() const
    {
      if (needs_update_)
        update_();
      return v_;
    }

    template <typename E>
    inline
    void
    set_of_<E>::update_() const
    {
      mln_precondition(needs_update_);
      v_.clear();
      std::copy(s_.begin(), s_.end(), std::back_inserter(v_));
      // no s_.clear() here:
      // - we want to keep information up-to-date in s_
      // - we want to save some execution time
      needs_update_ = false;
    }

    // FIXME : ambiguous with site_set operator <<
    //     template <typename E>
    //     std::ostream& operator<<(std::ostream& ostr,
    //                       const set_of_<E>& s)
    //     {
    //       ostr << '[';
    //       const unsigned n = s.nelements();
    //       for (unsigned i = 0; i < n; ++i)
    //  ostr << s.element(i)
    //       << (i == s.nelements() - 1 ? ']' : ',');
    //       return ostr;
    //     }

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::internal

} // end of namespace mln


#endif // ! MLN_CORE_INTERNAL_SET_OF_HH