section_container.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-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 __UTIL__SECTION_CONTAINER__
#define __UTIL__SECTION_CONTAINER__
 
#include <vector>
#include "../types.h"
 
namespace ug
{
 
 
//  SectionContainer
 
template <class TValue, class TContainer>
class SectionContainer
{
  public:
    typedef TValue                value_type;
    typedef TContainer              Container;
    typedef typename Container::iterator    iterator;
    typedef typename Container::const_iterator  const_iterator;
    //typedef typename Container::reverse_iterator    reverse_iterator;
    //typedef typename Container::const_reverse_iterator  const_reverse_iterator;
    
  public:
    SectionContainer();
 
    void clear();
    void clear_section(int sectionIndex);
 
    iterator insert(const TValue& val, int sectionIndex);
    void erase(const iterator& iter, int sectionIndex);
 
    inline iterator begin() {return m_container.begin();}
    inline iterator end() {return m_container.end();}
 
    inline const_iterator begin() const {return m_container.begin();}
    inline const_iterator end() const {return m_container.end();}
 
    iterator section_begin(int sectionIndex);
 
    const_iterator section_begin(int sectionIndex) const;
 
    iterator section_end(int sectionIndex);
 
    const_iterator section_end(int sectionIndex) const;
 
 
    value_type& front(int secIndex = -1);
 
 
    value_type& back(int secIndex = -1);
      
    uint num_elements(int sectionIndex) const;
    inline uint num_elements() const  {return m_numElements;}
    inline int num_sections() const   {return (int)m_vSections.size();}
 
 
    inline Container& get_container()     {return m_container;}
 
 
    void append(const SectionContainer& c);
 
    void transfer_elements(SectionContainer& c);
 
  protected:
    void add_sections(int num);
 
  protected:
    struct Section
    {
      Section() {}
      Section(const iterator& elemsBegin, const iterator& elemsEnd,
          //const reverse_iterator& elemsRBegin,
          //const reverse_iterator& elemsREnd,
          int numElems) :
        m_elemsBegin(elemsBegin), m_elemsEnd(elemsEnd),
        //m_elemsRBegin(elemsRBegin), m_elemsREnd(elemsREnd),
        m_numElements(numElems)
        {}
 
      iterator  m_elemsBegin;
      iterator  m_elemsEnd;
      //reverse_iterator  m_elemsRBegin;
      //reverse_iterator  m_elemsREnd;
      uint    m_numElements;
    };
 
    typedef std::vector<Section>  SectionVec;
 
  protected:
    Container   m_container;
    SectionVec    m_vSections;
    uint      m_numElements;
};
 
// end group ugbase_common_util
 
}// end of namespace
 
//  include implementation
#include "section_container.hpp"
 
#endif