primary_index_space_state.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 PRIMARY_INDEX_SPACE_STATE_H
#define PRIMARY_INDEX_SPACE_STATE_H

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

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

#ifndef EXPLICIT_INDEX_SPACE_STATE_H
#include "SheafSystem/explicit_index_space_state.h"
#endif

namespace sheaf
{

class primary_index_space_handle;
class primary_index_space_iterator;

class SHEAF_DLL_SPEC primary_index_space_state : public explicit_index_space_state
{
  friend class namespace_poset;
  friend class primary_index_space_handle;

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

public:

  static primary_index_space_handle new_space(index_space_family& xid_spaces,
                         const std::string& xname,
                         pod_type xoffset,
                         size_type xct);

  static primary_index_space_handle new_space(index_space_family& xid_spaces,
                         pod_type xid,
                         const std::string& xname,
                         pod_type xoffset,
                         size_type xct);

protected:

private:



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

public:

protected:

  primary_index_space_state();

  primary_index_space_state(const primary_index_space_state& xother) { };

  virtual ~primary_index_space_state();

private:



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

public:

  pod_type offset() const;

  virtual void extend(size_type xct);

  pod_type hub_term_id() const;

protected:

  void put_hub_term_id(pod_type xhub_term_id);

  pod_type _offset;

  pod_type _hub_term_id;

private:



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

public:

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

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

  virtual primary_index_space_state& operator=(const explicit_index_space_state& xother);

private:



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

public:

  virtual bool contains(pod_type xid) const;

  virtual bool contains_unglued_hub(pod_type xid) const;

  virtual pod_type pod(pod_type xid) const;

  virtual pod_type unglued_hub_pod(pod_type xid) const;

//   ///
//   /// The pod index in the primary sum id space equivalent to xid in this id space.
//   ///
//   virtual pod_type primary_sum_pod(pod_type xid) const;

protected:

private:



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

public:

  static size_type handle_pool_ct();

  static size_type handle_pool_deep_size();

  virtual index_space_handle& get_id_space() 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:

private:

  static list_pool<primary_index_space_handle>& handles();



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

public:

  static size_type iterator_pool_ct();

  static size_type iterator_pool_deep_size();

  virtual index_space_iterator& get_iterator() const;

  virtual void release_iterator(index_space_iterator& xitr) const;

  virtual bool allocated_iterator(const index_space_iterator& xitr) const;

protected:

private:

  static list_pool<primary_index_space_iterator>& iterators();



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

public:

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

  virtual primary_index_space_state* clone() const;

protected:

private:

  static bool make_prototype();



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

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 primary_index_space_state& xn, bool xinclude_shallow = true);
  
} // end namespace sheaf

#endif // ifndef PRIMARY_INDEX_SPACE_STATE_H