poset_powerset_state.h

//
// 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.
//

// Interface for class POSET_POWERSET_STATE

#ifndef POSET_POWERSET_STATE_H
#define POSET_POWERSET_STATE_H

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

#ifndef ANY_H
#include "SheafSystem/any.h"
#endif

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

#ifndef INDEX_SPACE_FAMILY_H
#include "SheafSystem/index_space_family.h"
#endif

#ifndef SCOPED_INDEX_H
#include "SheafSystem/scoped_index.h"
#endif

#ifndef SUBPOSET_H
#include "SheafSystem/subposet.h"
#endif

#ifndef SUBPOSET_STATE_H
#include "SheafSystem/subposet_state.h"
#endif

#ifndef NAME_MULTIMAP_H
#include "SheafSystem/name_multimap.h"
#endif

namespace sheaf
{

// Forward declaration to support friend declaration.
SHEAF_DLL_SPEC std::ostream & operator << (std::ostream &os, const poset_powerset_state& p);

class SHEAF_DLL_SPEC poset_powerset_state : public any
{
  friend class poset_state_handle;
  friend class subposet;
  friend class storage_agent; // needs to create an id space.
  friend class poset_scaffold; // needs to create an id space.
  friend SHEAF_DLL_SPEC std::ostream & operator << (std::ostream &os, const poset_powerset_state& p);
  friend SHEAF_DLL_SPEC size_t deep_size(const poset_powerset_state& xp, bool xinclude_shallow);

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

public:

  poset_powerset_state(size_type xcapacity, const scoped_index& xsubposet_member_index_ub);

  ~poset_powerset_state();

protected:

private:



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

public:

  subposet_state& member(pod_index_type xindex);

  subposet_state& member(const scoped_index& xindex);

  const subposet_state& member(pod_index_type xindex) const;

  const subposet_state& member(const scoped_index& xindex) const;

  pod_index_type new_subposet(bool xinitializ);

  void new_subposet(bool xinitialize, scoped_index& xresult);

  pod_index_type new_subposet(const block<pod_index_type>& xmembers);

  void new_subposet(const block<scoped_index>& xmembers,
            scoped_index& xresult);

  void delete_subposet(pod_index_type xindex);

  void delete_subposet(const scoped_index& xindex);

  const scoped_index& subposet_index_ub() const;

  size_type subposet_ct() const;

  index_space_iterator& get_subposet_id_space_iterator() const;

  void release_subposet_id_space_iterator(index_space_iterator& xitr) const;

  bool contains_subposet(pod_index_type xindex) const;

  bool contains_subposet(const scoped_index& xindex) const;

protected:

private:

  typedef zero_block_initialization_policy<subposet_state*> subposets_init_type;

  typedef auto_block<subposet_state*, subposets_init_type> subposets_type;

  subposets_type _subposets;

  scoped_index _subposet_index_ub;  



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

public:

  const index_space_family& id_spaces() const;

  const hub_index_space_handle& hub_id_space() const;

  const scoped_index& hub_id() const;

  scoped_index hub_id(pod_index_type xid) const;

protected:

private:

  index_space_family _id_spaces;



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

public:

  typedef name_multimap subposet_name_map_type;

  subposet_name_map_type& subposet_name_map();

  const subposet_name_map_type& subposet_name_map() const;

protected:

private:

  subposet_name_map_type _subposet_name_map;



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

public:

  const scoped_index& subposet_member_index_ub() const;

  void put_subposet_member_index_ub(const scoped_index& xub);

  bool is_dof_subposet(pod_index_type xindex) const;

  bool is_dof_subposet(const scoped_index& xindex) const;

  void delete_poset_member(pod_index_type xindex);

  void delete_poset_member(const scoped_index& xindex);

  bool subposet_contains_member(pod_index_type xsubposet_index,
                                pod_index_type xmbr_index) const;

  bool subposet_contains_member(const scoped_index& xsubposet_index,
                                const scoped_index& xmbr_index) const;

protected:

private:

  // Upper bound for member index in all subposets.

  scoped_index _subposet_member_index_ub;



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

public:

  subposet& coarsest_common_refinement();

  const subposet& coarsest_common_refinement() const;

  subposet& coarsest_common_refinement_jims();

  const subposet& coarsest_common_refinement_jims() const;

  subposet& whole();

  subposet& jims();

  subposet& table_dof_subposet();

  const subposet& table_dof_subposet() const;

  subposet& row_dof_subposet();

  const subposet& row_dof_subposet() const;

  int standard_subposet_ct() const;

  void put_standard_subposet_ct(int xct);

protected:

private:

  subposet _coarsest_common_refinement;

  subposet _coarsest_common_refinement_jims;

  subposet _whole;

  subposet _jims;

  subposet _table_dof_subposet;

  subposet _row_dof_subposet;

  int _standard_subposet_ct;



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

public:

  virtual bool is_ancestor_of(const any* other) const;

  virtual poset_powerset_state* clone() const;

  bool invariant() const;

protected:

private:


};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

SHEAF_DLL_SPEC std::ostream & operator << (std::ostream &os, const poset_powerset_state& p);

SHEAF_DLL_SPEC size_t deep_size(const poset_powerset_state& xp, bool xinclude_shallow = true);

} // namespace sheaf

#endif // ifndef POSET_POWERSET_STATE_H