sum_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 SUM_INDEX_SPACE_STATE_H
#define SUM_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

#ifndef BLOCK_H
#include "SheafSystem/block.h"
#endif
 
#ifndef STD_UNORDERED_MAP_H
#include "SheafSystem/std_unordered_map.h"
#endif

#ifndef STD_MAP_H
#include "SheafSystem/std_map.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_state : public explicit_index_space_state
{

  friend SHEAF_DLL_SPEC size_t deep_size(const sum_index_space_state& xn, bool xinclude_shallow);

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

public:

protected:

  sum_index_space_state();

  sum_index_space_state(const sum_index_space_state& xother) { };

  virtual ~sum_index_space_state();

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;

  virtual bool contains_rep(pod_type xhub_id) const = 0;

  bool contains_unique_rep(pod_type xhub_id) const;

  virtual pod_type rep(pod_type xhub_id) const = 0;

  virtual pod_type host_rep(pod_type xhub_id) const = 0;

  virtual pod_type term_id_begin() const = 0;

  virtual pod_type term_id_end() const = 0;

  virtual bool contains_term_id(pod_type xi) const = 0;

  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;

  virtual void clear();

protected:

  typedef unordered::unordered_multimap<pod_type, pod_type> rem_inv_type;

  rem_inv_type _rem_inv;

  typedef zero_block_initialization_policy<index_space_handle*> terms_init_type;

  typedef auto_block<index_space_handle*, terms_init_type> terms_type;

  terms_type _terms;

  block<pod_type> _term_begin;

  block<pod_type> _term_end;

  typedef std::map<pod_type, pod_type> sum_to_term_type;
  
  sum_to_term_type _sum_to_term_map;

private:



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

public:

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

  virtual size_type deep_size(bool xinclude_shallow) const;

protected:

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

private:



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

public:

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

#endif // ifndef SUM_INDEX_SPACE_STATE_H