hub_index_space_handle.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 HUB_INDEX_SPACE_HANDLE_H
#define HUB_INDEX_SPACE_HANDLE_H

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

#ifndef SUM_INDEX_SPACE_HANDLE_H
#include "SheafSystem/sum_index_space_handle.h"
#endif

namespace sheaf
{
  
class primary_sum_index_space_state;
  
class SHEAF_DLL_SPEC hub_index_space_handle : public sum_index_space_handle
{

  friend class primary_sum_index_space_state;

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

public:

  hub_index_space_handle();

  hub_index_space_handle(const hub_index_space_handle& xother);

  hub_index_space_handle(const index_space_family& xid_spaces,
             pod_type xindex);

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

  hub_index_space_handle& operator=(const hub_index_space_handle& xother);

  virtual ~hub_index_space_handle();

protected:

  hub_index_space_handle(primary_sum_index_space_state& xstate);

  using explicit_index_space_handle::state;

  primary_sum_index_space_state& state();

  const primary_sum_index_space_state& state() const;

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:

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

  bool has_gathered_id_space() const;

protected:

private:



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

public:

  void update_standard_ids();

  bool has_only_standard_ids() const;

  void clear_ids();

protected:

private:



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

public:

protected:

private:



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

public:

protected:

private:



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

public:

  virtual hub_index_space_handle& operator=(const index_space_handle& xother);

  virtual hub_index_space_handle* clone() const;

protected:

private:



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

public:

  using sum_index_space_handle::conforms_to_state;

  virtual bool conforms_to_state(const index_space_collection& xhost,
                 pod_type xlocal_id) const;

protected:

private:



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

public:

  virtual bool is_ancestor_of(const any *other) const;

  virtual bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================
 
} // end namespace sheaf

#endif // ifndef HUB_INDEX_SPACE_HANDLE_H