index_space_collection.h

Go to the documentation of this file.

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//


#ifndef INDEX_SPACE_COLLECTION_H
#define INDEX_SPACE_COLLECTION_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

#ifndef POD_TYPES_H
#include "SheafSystem/pod_types.h"
#endif

namespace sheaf
{

class abstract_product_structure;
class explicit_index_space_state;
class hub_index_space_handle;
class index_space_family;
class index_space_handle;
class index_space_iterator;
class scoped_index;
  
class SHEAF_DLL_SPEC index_space_collection : public any
{

  friend class explicit_index_space_handle;
  friend class explicit_index_space_iterator;
  friend class index_space_family;

  // ===========================================================
  // ===========================================================

public:

  typedef pod_index_type pod_type;

  virtual ~index_space_collection();

  virtual bool operator==(const index_space_collection& xother) const = 0;

  virtual bool contains(pod_type xlocal_id) const = 0;

  virtual bool contains_family(pod_type xspace_id) const = 0;

  virtual pod_type local_scope(pod_type xspace_id) const = 0;

  virtual pod_type family_scope(pod_type xlocal_id) const = 0;

  virtual size_type deep_size(bool xinclude_shallow) const = 0;

protected:

  index_space_collection();

  index_space_collection(const index_space_collection& xother) { };

  virtual index_space_collection& operator=(const index_space_collection& xother) = 0;

  virtual explicit_index_space_state* explicit_state(pod_type xlocal_id) const = 0;

private:



  // ===========================================================
  // ===========================================================

public:

  virtual const index_space_family& id_spaces() const = 0;

  virtual index_space_family& id_spaces() = 0;

  const hub_index_space_handle& hub_id_space() const;

  virtual void remove(pod_type xlocal_id) = 0;

  virtual size_type ct(pod_type xlocal_id) const = 0;

  bool is_empty(pod_type xlocal_id) const;

  virtual pod_type begin(pod_type xlocal_id) const = 0;

  virtual pod_type end(pod_type xlocal_id) const = 0;

  bool is_gathered(pod_type xlocal_id) const;
    
  virtual bool contains(pod_type xlocal_id, pod_type xid) const = 0;

  bool contains(pod_type xlocal_id, const scoped_index& xid) const;

  bool contains_hub(pod_type xlocal_id, pod_type xid) const;

  virtual bool contains_unglued_hub(pod_type xlocal_id, pod_type xid) const = 0;

  bool contains_glued_hub(pod_type xlocal_id, pod_type xid) const;

  bool contains(pod_type xlocal_id, pod_type xid, const scoped_index& xhub_id) const;

  virtual bool contains(pod_type xlocal_id, pod_type xid, pod_type xhub_id) const = 0;

  virtual pod_type pod(pod_type xlocal_id, pod_type xid) const = 0;

  pod_type pod(pod_type xlocal_id, const scoped_index& xid) const;

  pod_type hub_pod(pod_type xlocal_id, pod_type xid) const;

  virtual pod_type unglued_hub_pod(pod_type xlocal_id, pod_type xid) const = 0;

  pod_type glued_hub_pod(pod_type xlocal_id, pod_type xid) const;

  virtual bool is_persistent(pod_type xlocal_id) const = 0;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual void new_product_structure(pod_type xlocal_id,
                     const abstract_product_structure& xproduct) = 0;

  virtual void delete_product_structure(pod_type xlocal_id) = 0;

  virtual const abstract_product_structure& product_structure(pod_type xlocal_id) const = 0;

  virtual abstract_product_structure& product_structure(pod_type xlocal_id) = 0;

  virtual bool has_product_structure(pod_type xlocal_id) const = 0;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual index_space_handle& get_id_space(pod_type xlocal_id) const = 0;

  virtual void release_id_space(index_space_handle& xid_space) const = 0;

  virtual bool allocated_id_space(const index_space_handle& xid_space) const = 0;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual index_space_iterator& get_id_space_iterator(pod_type xlocal_id) const = 0;

  virtual void release_id_space_iterator(index_space_iterator& xitr) const = 0;

  virtual bool allocated_id_space_iterator(const index_space_iterator& xitr) const = 0;

protected:

private:



  // ===========================================================
  // ===========================================================

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // end namespace sheaf

#endif // ifndef INDEX_SPACE_COLLECTION_H