interval_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 INTERVAL_INDEX_SPACE_STATE_H
#define INTERVAL_INDEX_SPACE_STATE_H

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

#ifndef AUTO_BLOCK_H
#include "SheafSystem/auto_block.h"
#endif

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

#ifndef SCATTERED_INSERTION_INDEX_SPACE_STATE_H
#include "SheafSystem/scattered_insertion_index_space_state.h"
#endif

#ifndef STD_MAP_H
#include "SheafSystem/std_map.h"
#endif

namespace sheaf
{

class interval_index_space_handle;
class interval_index_space_state;
class interval_index_space_iterator;

class SHEAF_DLL_SPEC interval_index_space_state : public scattered_insertion_index_space_state
{

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

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

public:

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

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

protected:

private:



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

public:

protected:

  // [xrange_begin, xrange_end] in map xmap.
  static void insert_map_interval(pod_type xdomain_begin, 
                  pod_type xdomain_end, 
                  pod_type xrange_begin, 
                  pod_type xrange_end,
                  std::map<pod_type, pod_type>& xmap,
                  bool xmerge_mode);

  static pod_type map_value(pod_type xid, const std::map<pod_type, pod_type>& xmap);

  interval_index_space_state();

  interval_index_space_state(const interval_index_space_state& xother) { };

  virtual ~interval_index_space_state();

private:



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

public:

  void insert_interval(pod_type xbegin,
               pod_type xend,
               const scoped_index& xhub_begin, 
               const scoped_index& xhub_end);
  
  void insert_interval(pod_type xbegin, 
               pod_type xend, 
               pod_type xhub_begin, 
               pod_type xhub_end);

  void push_interval(const scoped_index& xhub_begin,
             const scoped_index& xhub_end);

  void push_interval(pod_type xhub_begin, pod_type xhub_end);
  
  size_type remove_interval(const scoped_index& xhub_begin,
                const scoped_index& xhub_end);

  size_type remove_hub_interval(pod_type xhub_begin, pod_type xhub_end);  

  size_type remove_interval(pod_type xbegin, pod_type xend);  

  pod_type interval_begin(const scoped_index& xid) const;
  
  pod_type interval_begin(pod_type xhub_id) const;
  
  pod_type interval_end(const scoped_index& xid) const;
  
  pod_type interval_end(pod_type xhub_id) const;
  
  bool merge_mode() const;

  void put_merge_mode(bool xvalue);

protected:

  size_type invalid_entry_ct(pod_type xhub_begin, pod_type xhub_end) const;

private:


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

public:

protected:

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:

  void print_map_rep(std::ostream& xos) const;
  
protected:

  void map_rep_insert_interval(pod_type xdomain_begin, 
                   pod_type xdomain_end, 
                   pod_type xrange_begin, 
                   pod_type xrange_end);

  size_type map_rep_remove_interval(pod_type xbegin,
                    pod_type xend,
                    bool xis_range_id);  

  virtual void map_rep_insert_entry(pod_type xdomain_id, pod_type xrange_id);

  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();

  typedef std::map<pod_type, pod_type> map_type;

  typedef map_type to_domain_type;

  to_domain_type _to_domain;

  typedef map_type to_range_type;

  to_range_type _to_range;

  pod_type _capacity;

  bool _merge_mode;

private:



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

public:

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

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

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

private:



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

public:

  using scattered_insertion_index_space_state::contains;

  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;

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<interval_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<interval_index_space_iterator>& iterators();



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

public:

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

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

#endif // ifndef INTERVAL_INDEX_SPACE_STATE_H