gathered_insertion_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 GATHERED_INSERTION_INDEX_SPACE_STATE_H
#define GATHERED_INSERTION_INDEX_SPACE_STATE_H

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

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

namespace sheaf
{

class gathered_insertion_index_space_handle;

class SHEAF_DLL_SPEC gathered_insertion_index_space_state : public explicit_index_space_state
{

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

public:

protected:

  gathered_insertion_index_space_state();

  gathered_insertion_index_space_state(const gathered_insertion_index_space_state& xother) { };

  virtual ~gathered_insertion_index_space_state();

private:



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

public:

  void push_back(const scoped_index& xhub_id);

  void push_back(pod_type xid);

  void push(index_space_iterator& xitr, const scoped_index& xhub_id);

  void push(index_space_iterator& xitr, pod_type xhub_id);

  pod_type next_id() const;

  size_type remove(const scoped_index& xid, bool update_extrema);

  size_type remove(pod_type xid, bool update_extrema);

  size_type remove_hub(pod_type xhub_id, bool update_extrema);

  void remove(index_space_iterator& xitr, bool update_extrema);

  void gather();
  
  virtual void update_extrema() = 0;

  virtual void reserve(size_type xcapacity) = 0;

  virtual size_type capacity() const = 0;

  void clear();

protected:
  
  virtual void update_extrema_after_remove();

  void update_extrema(pod_type xid);

private:



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

public:

protected:

  virtual void map_rep_push_back(pod_type xrange_id) = 0;

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

  virtual size_type map_rep_remove_entry(pod_type xid, bool xis_range_id) = 0;

  virtual void map_rep_remove_entry(index_space_iterator& xitr) = 0;

  virtual void map_rep_clear() = 0;

  virtual void map_rep_gather() = 0;

private:



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

public:

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

protected:

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

private:



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

public:

  void put_is_persistent(bool xis_persistent);

protected:

private:



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

public:

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

protected:

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

#endif // ifndef GATHERED_INSERTION_INDEX_SPACE_STATE_H