pointer_const_array.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-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__pointer_const_array__
#define __H__UG__pointer_const_array__
 
#include <vector>
#include <common/assert.h>
#include <common/types.h>
 
namespace ug
{
 
 
 
template <class TPtr>
class PointerConstArray{
  typedef TPtr const* ConstPtrArray;
  typedef TPtr*   PtrArray;
 
  public:
    PointerConstArray();
    PointerConstArray(const PointerConstArray& pa);
    ~PointerConstArray();
 
    PointerConstArray& operator=(const PointerConstArray& pa);
 
    inline size_t size() const;
 
    inline bool empty() const;
 
 
    inline TPtr const operator[](size_t i) const;
 
 
    void set_external_array(TPtr const* array, size_t size, bool bCopy = false);
 
 
    void reserve(size_t capacity);
 
 
    void clear();
 
 
    void push_back(TPtr p);
 
  private:
 
    void assign_pointer_const_array(const PointerConstArray& pa);
 
    void reserve(size_t capacity, bool copyOldData);
 
  private:
    ConstPtrArray   m_array;
    PtrArray      m_data;
    size_t        m_size;
    size_t        m_capacity;
};
 
// end group ugbase_common_util
 
}// end of namespace
 
//  include implementation
#include "pointer_const_array_impl.hpp"
 
#endif