collection.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2021 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------
 
#ifndef dealii_hp_collection_h
#define dealii_hp_collection_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/memory_consumption.h>
#include <deal.II/base/subscriptor.h>
 
#include <memory>
#include <vector>
 
DEAL_II_NAMESPACE_OPEN
 
namespace hp
{
  template <typename T>
  class Collection : public Subscriptor
  {
  public:
    Collection() = default;
 
    void
    push_back(const std::shared_ptr<const T> &new_entry);
 
    const T &operator[](const unsigned int index) const;
 
    unsigned int
    size() const;
 
    std::size_t
    memory_consumption() const;
 
  private:
    std::vector<std::shared_ptr<const T>> entries;
  };
 
 
  /* --------------- inline functions ------------------- */
 
 
 
  template <typename T>
  std::size_t
  Collection<T>::memory_consumption() const
  {
    return (sizeof(*this) + MemoryConsumption::memory_consumption(entries));
  }
 
 
 
  template <typename T>
  void
  Collection<T>::push_back(const std::shared_ptr<const T> &new_entry)
  {
    entries.push_back(new_entry);
  }
 
 
 
  template <typename T>
  inline unsigned int
  Collection<T>::size() const
  {
    return entries.size();
  }
 
 
 
  template <typename T>
  inline const T &Collection<T>::operator[](const unsigned int index) const
  {
    AssertIndexRange(index, entries.size());
    return *entries[index];
  }
 
} // namespace hp
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif