primary_sum_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_SUM_INDEX_SPACE_STATE_H
#define PRIMARY_SUM_INDEX_SPACE_STATE_H

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

#ifndef SUM_INDEX_SPACE_STATE_H
#include "SheafSystem/sum_index_space_state.h"
#endif

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

#ifndef INTERVAL_INDEX_SPACE_HANDLE_H
#include "SheafSystem/interval_index_space_handle.h"
#endif
 
#ifndef INTERVAL_SET_H
#include "SheafSystem/interval_set.h"
#endif

#ifndef RESERVED_PRIMARY_INDEX_SPACE_HANDLE_H
#include "SheafSystem/reserved_primary_index_space_handle.h"
#endif

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

#ifndef STD_UNORDERED_SET_H
#include "SheafSystem/std_unordered_set.h"
#endif

namespace sheaf
{

class interval_index_space_handle;
class primary_index_space_handle;
class hub_index_space_iterator;
  
class SHEAF_DLL_SPEC primary_sum_index_space_state : public sum_index_space_state
{

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

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

public:

  static hub_index_space_handle new_space(index_space_family& xid_spaces,
                      const std::string& xname);

  static hub_index_space_handle new_space(index_space_family& xid_spaces,
                      pod_type xid,
                      const std::string& xname);

protected:

private:



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

public:

protected:

  primary_sum_index_space_state();

  primary_sum_index_space_state(const primary_sum_index_space_state& xother) { };

  virtual ~primary_sum_index_space_state();

private:



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

public:

  pod_type new_id();

  pod_type new_id(pod_type xid);

  void delete_id(pod_type xid);

  bool is_valid_reserved_id(pod_type xid) const;

  pod_type next_id() const;

  pod_type new_primary_term(size_type xct);

  pod_type new_primary_term(pod_type xid, size_type xct);

  void remove_term(pod_type xi);

  void extend_last_term(size_type xct);

  bool interval_is_full(pod_type xbegin, pod_type xend) const;

  bool interval_is_empty(pod_type xbegin, pod_type xend) const;

  bool interval_is_available(pod_type xbegin, pod_type xend) const;

protected:

  static const std::string& term_prefix();

  std::string next_term_name();

  pod_type new_reserved_term();

  pod_type new_reserved_term(pod_type xid);  

  void add_term(pod_type xterm_id, pod_type xbegin, pod_type xend);

  bool reserved_interval_is_available(pod_type xid) const;

  void update_extrema();

  interval_set _members;

  pod_type _next_id;

  reserved_primary_index_space_handle _reserved_term;

  unordered::unordered_set<pod_type> _reserved_term_ids;
  
private:



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

public:

  void glue(pod_type xid, pod_type xrep);
  
  void unglue(pod_type xid);
  
  void unglue_all(pod_type xrep_id);

  bool has_gluing() const;

protected:

private:



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

public:

  const index_space_handle& new_gathered_id_space(bool xexclude_bottom);

  void update_gathered_id_space();

  const index_space_handle& gathered_id_space() const;

  bool has_gathered_id_space() const;

  bool gathered_id_space_excludes_bottom() const;

  static const std::string& gathered_hub_id_space_name();

protected:

  void update_gathered_id_space(bool xexclude_bottom);

  interval_index_space_handle _gathered_id_space;

private:



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

public:

  void update_standard_ids();

  bool has_only_standard_ids() const;

  void clear_ids();

protected:

  pod_type _standard_id_end;

private:



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

public:

  virtual bool contains_rep(pod_type xhub_id) const;

  virtual pod_type rep(pod_type xhub_id) const;

  virtual pod_type host_rep(pod_type xhub_id) const;

  virtual pod_type term_id_begin() const;

  virtual pod_type term_id_end() const;

  virtual bool contains_term_id(pod_type xi) const;

  virtual void clear();

protected:

  typedef unordered::unordered_map<pod_type, pod_type> rem_type;

  rem_type _rem;

  pod_type _term_id_begin;

  pod_type _term_id_end;

private:



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

public:

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

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

  virtual primary_sum_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 bool contains_glued_hub(pod_type xid) const;

  virtual pod_type pod(pod_type xid) const;

  virtual pod_type unglued_hub_pod(pod_type xid) const;

  virtual pod_type glued_hub_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<hub_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<hub_index_space_iterator>& iterators();



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

public:

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

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

#endif // ifndef PRIMARY_SUM_INDEX_SPACE_STATE_H