list_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 LIST_INDEX_SPACE_STATE_H
#define LIST_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 GATHERED_INSERTION_INDEX_SPACE_STATE_H
#include "SheafSystem/gathered_insertion_index_space_state.h"
#endif

#ifndef STD_LIST_H
#include "SheafSystem/std_list.h"
#endif

namespace sheaf
{

class list_index_space_handle;
class list_index_space_state;
class list_index_space_iterator;
 
SHEAF_DLL_SPEC 
size_t deep_size(const list_index_space_state& xn, bool xinclude_shallow);

class SHEAF_DLL_SPEC list_index_space_state : public gathered_insertion_index_space_state
{

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

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

public:

  static list_index_space_handle new_space(index_space_family& xid_spaces,
                       const std::string& xname,
                       bool xis_persistent);

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

protected:

private:



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

public:

  void reverse(bool xupdate_extrema);

  pod_type front() const;

  pod_type back() const;

  void push_front(pod_type xhub_id);

  void replace_range_id(pod_type xold_range_id, pod_type xnew_range_id);

protected:

  list_index_space_state();

  list_index_space_state(const list_index_space_state& xother) { };

  virtual ~list_index_space_state();
  

private:



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

public:

  using gathered_insertion_index_space_state::update_extrema;

  virtual void update_extrema();

  virtual void reserve(size_type xcapacity);

  virtual size_type capacity() const;

protected:

private:



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

public:

  typedef std::list<pod_type> to_range_type;

  to_range_type& to_range();

  const to_range_type& to_range() const;

protected:

  virtual void map_rep_push_back(pod_type xrange_id);

  virtual void map_rep_push(index_space_iterator& xitr, pod_type xrange_id);

  virtual size_type map_rep_remove_entry(pod_type xid, bool xis_range_id);

  virtual void map_rep_remove_entry(index_space_iterator& xitr);

  virtual void map_rep_clear();

  virtual void map_rep_gather();

  to_range_type _to_range;

  pod_type _capacity;

  to_range_type::iterator to_range_itr(pod_type xid, bool xis_range_id);

  to_range_type::const_iterator to_range_const_itr(pod_type xid, bool xis_range_id) const;
  

private:



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

public:

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

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

  virtual list_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(pod_type xid, pod_type xhub_id) const;

  virtual pod_type pod(pod_type xid) const;

  virtual pod_type unglued_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<list_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<list_index_space_iterator>& iterators();



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

public:

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

  virtual list_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
// ===========================================================
  
} // end namespace sheaf

#endif // ifndef LIST_INDEX_SPACE_STATE_H