persistentcontainerinterface.hh

// SPDX-FileCopyrightText: Copyright (C) DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_PERSISTENTCONTAINERINTERFACE_HH
#define DUNE_PERSISTENTCONTAINERINTERFACE_HH
 
#ifndef HEADERCHECK
#error "This header exists for documentation purposes only and should never be included directly."
#endif
 
namespace Dune
{
 
  template< class G, class T >
  class PersistentContainerInterface
  {
    typedef PersistentContainerInterface< G, T > This;
 
    struct ImplementationDefined;
 
  public:
    typedef G Grid;
 
    typedef T Value;
 
    typedef ImplementationDefined Size;
    typedef ImplementationDefined ConstIterator;
    typedef ImplementationDefined Iterator;
 
    // construction
 
    PersistentContainerInterface ( Grid &grid, int codim, const Value &value = Value() );
 
    PersistentContainerInterface ( const This &other );
 
    const This &operator= ( const This &other );
 
    // element access
 
    template< class Entity >
    const Value &operator[] ( const Entity &entity ) const;
 
    template< class Entity >
    Value &operator[] ( const Entity &entity );
 
    template< class Entity >
    const Value &operator() ( const Entity &entity, int subEntity ) const;
 
    template< class Entity >
    Value &operator() ( const Entity &entity, int subEntity );
 
    // capacity
 
    Size size () const;
 
    void resize ( const Value &value = Value() );
 
    void shrinkToFit ();
 
    // modifiers
 
    void fill ( const Value &value );
 
    void swap ( This &other );
 
    // iterators
 
    ConstIterator begin () const;
    Iterator begin ();
 
    ConstIterator end () const;
    Iterator end ();
 
    // information
 
    int codimension () const;
  };
 
} // namespace Dune
 
#endif // #ifndef DUNE_PERSISTENTCONTAINERINTERFACE_HH