array_index_space_interval.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 ARRAY_INDEX_SPACE_INTERVAL_H
#define ARRAY_INDEX_SPACE_INTERVAL_H

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

#ifndef FORWARDING_INDEX_SPACE_HANDLE_H
#include "SheafSystem/forwarding_index_space_handle.h"
#endif

#ifndef INDEX_SPACE_INTERVAL_H
#include "SheafSystem/index_space_interval.h"
#endif

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif

#ifndef LIST_POOL_H
#include "SheafSystem/list_pool.h"
#endif

#ifndef STD_UNORDERED_MAP_H
#include "SheafSystem/std_unordered_map.h"
#endif

namespace sheaf
{

class array_implicit_index_space_iterator;
class index_space_handle;

class SHEAF_DLL_SPEC array_index_space_interval : public index_space_interval
{

  friend class namespace_poset;
  friend SHEAF_DLL_SPEC size_t deep_size(const array_index_space_interval& xn, bool xinclude_shallow);

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

public:

  static const array_index_space_interval& new_space(index_space_family& xid_spaces,
                             size_type xub,
                             block<pod_type>& xhub_ids,
                             size_type xids_per_space,
                             bool xowns_hub_ids);

protected:

private:



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

public:

  virtual ~array_index_space_interval();

  const block<pod_type>& hub_ids() const;

  size_type ids_per_space() const;

  bool owns_hub_ids() const;

protected:

  array_index_space_interval();

  array_index_space_interval(const array_index_space_interval& xother) { };

  block<pod_type>* _hub_ids;

  size_type _ids_per_space;

  bool _owns_hub_ids;

private:



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

public:

protected:

private:



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

public:

  virtual const std::string& class_name() const;

  virtual array_index_space_interval* clone() const;

protected:

private:

  static bool make_prototype();



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

public:

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

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

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

  virtual explicit_index_space_state* explicit_state(pod_type xlocal_id) const;

private:



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

public:

  virtual void remove(pod_type xlocal_id);

  virtual size_type ct(pod_type xlocal_id) const;

  using index_space_interval::begin;

  virtual pod_type begin(pod_type xlocal_id) const;

  using index_space_interval::end;

  virtual pod_type end(pod_type xlocal_id) const;

  using index_space_interval::contains;

  virtual bool contains(pod_type xlocal_id, pod_type xid) const;

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

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

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

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

  virtual bool is_persistent(pod_type xlocal_id) const;

protected:

private:



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

public:

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

  virtual void delete_product_structure(pod_type xlocal_id);

  virtual const abstract_product_structure& product_structure(pod_type xlocal_id) const;

  virtual abstract_product_structure& product_structure(pod_type xlocal_id);

  virtual bool has_product_structure(pod_type xlocal_id) const;

protected:

private:



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

public:

  virtual index_space_handle& get_id_space(pod_type xlocal_id) const;

  virtual void release_id_space(index_space_handle& xid_space) const;

  virtual bool allocated_id_space(const index_space_handle& xid_space) const;

protected:

  mutable list_pool<forwarding_index_space_handle> _handles;

private:



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

public:

  virtual index_space_iterator& get_id_space_iterator(pod_type xlocal_id) const;

  virtual void release_id_space_iterator(index_space_iterator& xitr) const;

  virtual bool allocated_id_space_iterator(const index_space_iterator& xitr) const;

protected:

  mutable list_pool<array_implicit_index_space_iterator> _iterators;

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
SHEAF_DLL_SPEC 
size_t deep_size(const array_index_space_interval& xn, bool xinclude_shallow = true);
  
} // end namespace sheaf

#endif // ifndef ARRAY_INDEX_SPACE_INTERVAL_H