attached_list.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#ifndef __H__UG__attached_list__
#define __H__UG__attached_list__
 
#include <iterator>
#include "attachment_pipe.h"
 
namespace ug
{
 
//  predeclarations
template <class TAAEntry> class ConstAttachedElementListIterator;
 
template <class TAAEntry>
class AttachedElementListIterator : public std::iterator<
                      std::bidirectional_iterator_tag,
                      typename TAAEntry::element>
{
  public:
    typedef typename TAAEntry::element        element;
    typedef AttachedElementListIterator<TAAEntry> iterator;
 
    AttachedElementListIterator() : m_curElem(NULL) {}
    AttachedElementListIterator(element curElem, const TAAEntry& aaEntry) :
      m_aaEntry(aaEntry), m_curElem(curElem)  {}
    AttachedElementListIterator(const AttachedElementListIterator& cpy) :
      m_aaEntry(cpy.m_aaEntry), m_curElem(cpy.m_curElem)  {}
 
    const iterator& operator=(const iterator& iter)
    {
      m_aaEntry = iter.m_aaEntry;
      m_curElem = iter.m_curElem;
      return *this;
    }
 
    element operator*() const {return m_curElem;}
    element* operator->() const {return &m_curElem;}
 
    iterator operator++()   {m_curElem = m_aaEntry[m_curElem].next; return *this;}
    iterator operator++(int)
    {// post-increment
      iterator iter = *this;
      m_curElem = m_aaEntry[m_curElem].next;
      return iter;
    }
 
    iterator operator--()   {m_curElem = m_aaEntry[m_curElem].prev; return *this;}
    iterator operator--(int)
    {
      iterator iter = *this;
      m_curElem = m_aaEntry[m_curElem].prev;
      return iter;
    }
 
  //  note that each element may only be in the list once.
    bool operator==(const iterator& iter) const {return m_curElem == iter.m_curElem;}
    bool operator!=(const iterator& iter) const {return m_curElem != iter.m_curElem;}
 
  private:
    TAAEntry  m_aaEntry;
    element   m_curElem;
 
  friend class ConstAttachedElementListIterator<TAAEntry>;
};
 
template <class TAAEntry>
class ConstAttachedElementListIterator : public std::iterator<
                      std::bidirectional_iterator_tag,
                      const typename TAAEntry::element>
{
  public:
    typedef typename TAAEntry::element          element;
    typedef ConstAttachedElementListIterator<TAAEntry>  iterator;
 
    ConstAttachedElementListIterator() : m_curElem(NULL)  {}
    ConstAttachedElementListIterator(element curElem, const TAAEntry& aaEntry) :
      m_aaEntry(aaEntry), m_curElem(curElem)  {}
    ConstAttachedElementListIterator(const ConstAttachedElementListIterator& it) :
      m_aaEntry(it.m_aaEntry), m_curElem(it.m_curElem)  {}
    ConstAttachedElementListIterator(const AttachedElementListIterator<TAAEntry>& it) :
      m_aaEntry(it.m_aaEntry), m_curElem(it.m_curElem)  {}
 
    const iterator& operator=(const iterator& iter)
    {
      m_aaEntry = iter.m_aaEntry;
      m_curElem = iter.m_curElem;
      return *this;
    }
 
    element operator*() const     {return m_curElem;}
    const element* operator->() const {return &m_curElem;}
 
    iterator operator++()   {m_curElem = m_aaEntry[m_curElem].next; return *this;}
    iterator operator++(int)
    {// post-increment
      iterator iter = *this;
      m_curElem = m_aaEntry[m_curElem].next;
      return iter;
    }
 
    iterator operator--()   {m_curElem = m_aaEntry[m_curElem].prev; return *this;}
    iterator operator--(int)
    {
      iterator iter = *this;
      m_curElem = m_aaEntry[m_curElem].prev;
      return iter;
    }
 
  //  note that each element may only be in the list once.
    bool operator==(const iterator& iter) const {return m_curElem == iter.m_curElem;}
    bool operator!=(const iterator& iter) const {return m_curElem != iter.m_curElem;}
 
  private:
    TAAEntry  m_aaEntry;
    element   m_curElem;
};
 
 
template <class TAttachmentPipe>
class AttachedElementList
{
  public:
    typedef typename TAttachmentPipe::element   element;
 
    struct Entry{
      Entry() : prev(NULL), next(NULL)  {}
      Entry(const element& p, const element& n) : prev(p), next(n) {}
      element prev;
      element next;
    };
 
    typedef Attachment<Entry> AEntry;
    typedef typename TAttachmentPipe::ElementHandler ElemHandler;
    typedef AttachmentAccessor<element, AEntry, ElemHandler> AAEntry;
 
    typedef AttachedElementListIterator<AAEntry>    iterator;
    typedef ConstAttachedElementListIterator<AAEntry> const_iterator;
 
  public:
    AttachedElementList(TAttachmentPipe* pipe = NULL) :
      m_pipe(NULL),
      m_aEntry("AttachedElementList_Entry", false),
      m_front(NULL),
      m_back(NULL),
      m_bSharedAttachment(false)
    {
      if(pipe)
        set_pipe(pipe);
    }
 
    AttachedElementList(AEntry aEntry) :
      m_pipe(NULL),
      m_aEntry(aEntry),
      m_front(NULL),
      m_back(NULL),
      m_bSharedAttachment(false)
    {}
 
    AttachedElementList(TAttachmentPipe* pipe, AEntry aEntry) :
      m_pipe(NULL),
      m_aEntry(aEntry),
      m_front(NULL),
      m_back(NULL),
      m_bSharedAttachment(true)
    {
      if(pipe)
        set_pipe(pipe);
    }
 
    AttachedElementList(const AttachedElementList& ael) : m_pipe(NULL)
    {
      m_bSharedAttachment = ael.m_bSharedAttachment;
      if(m_bSharedAttachment)
        m_aEntry = ael.m_aEntry;
 
      set_pipe(ael.m_pipe);
      if(ael.m_front){
        iterator iter(ael.m_front, m_aaEntry);
        while(*iter){
          push_back(*iter);
          ++iter;
        }
      }
    }
 
    ~AttachedElementList()
    {
      set_pipe(NULL);
    }
 
    const AttachedElementList& operator=(const AttachedElementList& ael)
    {
      clear();
 
      if(ael.m_bSharedAttachment)
        set_pipe(ael.m_pipe, ael.m_aEntry);
      else
        set_pipe(ael.m_pipe);
 
      if(ael.m_front){
        iterator iter(ael.m_front, m_aaEntry);
        while(*iter){
          push_back(*iter);
          ++iter;
        }
      }
 
      return *this;
    }
 
    void set_pipe(TAttachmentPipe* pipe)
    {
      if(!m_bSharedAttachment && m_pipe)
        m_pipe->detach(m_aEntry);
      m_aaEntry.invalidate();
 
      m_pipe = pipe;
      if(m_pipe){
        if(!m_pipe->has_attachment(m_aEntry))
          m_pipe->attach(m_aEntry);
        m_aaEntry.access(*m_pipe, m_aEntry);
      }
 
      m_front = m_back = NULL;
    }
 
 
    void set_pipe(TAttachmentPipe* pipe, AEntry aEntry)
    {
      if(!m_bSharedAttachment && m_pipe)
        m_pipe->detach(m_aEntry);
      m_aaEntry.invalidate();
 
      m_pipe = pipe;
      m_aEntry = aEntry;
      m_bSharedAttachment = true;
 
      if(m_pipe){
      //  since we use a shared attachment in this case, it may already be
      //  attached to the pipe.
        if(!m_pipe->has_attachment(m_aEntry))
          m_pipe->attach(m_aEntry);
        m_aaEntry.access(*m_pipe, m_aEntry);
      }
 
      m_front = m_back = NULL;
    }
 
    void clear()
    {
      if(m_pipe){
        iterator iter = begin();
        while(iter != end()){
          element elem = *iter;
          iter++;
          m_aaEntry[elem] = Entry();
        }
 
        m_front = m_back = NULL;
      }
    }
 
 
    bool empty() const        {return m_front == NULL;}
 
    element front()         {return m_front;}
    element back()          {return m_back;}
 
    const element front() const   {return m_front;}
    const element back() const    {return m_back;}
 
    void push_back(const element& elem)
    {
      m_aaEntry[elem] = Entry(m_back, NULL);
      if(empty())
        m_front = elem;
      else
        m_aaEntry[m_back].next = elem;
      m_back = elem;
    }
 
 
    iterator insert(iterator position, const element& elem)
    {
      if(empty() || !(*position))
        push_back(elem);
      else{
        Entry& entry = m_aaEntry[*position];
 
        if(entry.prev){
          m_aaEntry[entry.prev].next = elem;
          m_aaEntry[elem].prev = entry.prev;
        }
        else{
          m_aaEntry[elem].prev = NULL;
          m_front = elem;
        }
 
        m_aaEntry[elem].next = *position;
        entry.prev = elem;
      }
 
      return get_iterator(elem);
    }
 
 
    iterator erase(iterator position)
    {
      Entry& entry = m_aaEntry[*position];
      if(entry.prev)
        m_aaEntry[entry.prev].next = entry.next;
      else
        m_front = entry.next;
 
      if(entry.next)
        m_aaEntry[entry.next].prev = entry.prev;
      else
        m_back = entry.prev;
 
    //  get next element and reset entry.
      element nextElem = entry.next;
      entry = Entry();
      return iterator(nextElem, m_aaEntry);
    }
 
    iterator erase(iterator begin, iterator end)
    {
      iterator iter = begin;
      while(iter != end){
        iterator titer = iter++;
        erase(titer);
      }
      return iter;
    }
 
 
    iterator get_iterator(const element& elem)
    {
      return iterator(elem, m_aaEntry);
    }
 
 
    element const* get_pointer_to_element(const element& elem)
    {
      if(elem == m_front)
        return &m_front;
      return &m_aaEntry[m_aaEntry[elem].prev].next;
    }
    
    bool is_in_list(const element& elem)
    {
      return (m_front == elem) || (m_aaEntry[elem].prev != NULL);
    }
    iterator begin()        {return iterator(m_front, m_aaEntry);}
 
 
    iterator end()          {return iterator(NULL, m_aaEntry);}
 
    const_iterator begin() const  {return const_iterator(m_front, m_aaEntry);}
 
 
    const_iterator end() const    {return const_iterator(NULL, m_aaEntry);}
 
  private:
  //  the attachment pipe on which we'll operate
    TAttachmentPipe*  m_pipe;
 
  //  The entry attachment
    AEntry    m_aEntry;
 
  //  the attachment accessor with which the entries are accessed
    AAEntry   m_aaEntry;
 
  //  front and back elements
    element   m_front;
    element   m_back;
 
  //  tells whether the entry attachment is shared with other lists
    bool    m_bSharedAttachment;
};
 
 
 
}// end of namespace
 
#endif