sum_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 SUM_INDEX_SPACE_HANDLE_H
#define SUM_INDEX_SPACE_HANDLE_H

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

#ifndef EXPLICIT_INDEX_SPACE_HANDLE_H
#include "SheafSystem/explicit_index_space_handle.h"
#endif

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

namespace sheaf
{

class sum_index_space_state;
  
class SHEAF_DLL_SPEC sum_index_space_handle : public explicit_index_space_handle
{

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

public:

  sum_index_space_handle();

  sum_index_space_handle(const sum_index_space_handle& xother);

  sum_index_space_handle(const index_space_family& xid_spaces,
             pod_type xindex);

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

  sum_index_space_handle& operator=(const sum_index_space_handle& xother);

  virtual ~sum_index_space_handle();

protected:

  using explicit_index_space_handle::state;

  sum_index_space_state& state();

  const sum_index_space_state& state() const;

private:



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

public:

  typedef std::list<pod_type> equivalence_class_type;

  void equivalence_class(pod_type xhub_id, equivalence_class_type& result) const;

  size_type equivalence_ct(pod_type xhub_id) const;

  bool contains_rep(pod_type xhub_id) const;

  bool contains_unique_rep(pod_type xhub_id) const;

  pod_type rep(pod_type xhub_id) const;

  pod_type host_rep(pod_type xhub_id) const;

  pod_type term_id_begin() const;

  pod_type term_id_end() const;

  bool contains_term_id(pod_type xi) const;

  const index_space_handle& term(pod_type xi) const;

  const index_space_handle& term_of(pod_type xid) const;

  const index_space_handle& term_of(const scoped_index& xid) const;

  const index_space_handle& last_term() const;

  pod_type term_begin(pod_type xi) const;

  pod_type term_end(pod_type xi) const;

  pod_type term_hub_begin(pod_type xi) const;

  pod_type term_hub_end(pod_type xi) const;

  pod_type term_id(pod_type xid) const;

  void binary(pod_type xindex, pod_type& xterm_id, pod_type& xlocal) const;
  
  void simple(pod_type xterm_id, pod_type xlocal_id, pod_type& xindex) const;

  void clear();

protected:

private:



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

public:

protected:

private:



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

public:

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

  virtual sum_index_space_handle* clone() const;

protected:

private:



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

public:

  using explicit_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 SUM_INDEX_SPACE_HANDLE_H