SheafSystem  0.0.0.0
sheaf::explicit_index_space_handle Class Reference

An implementation of class index_space_handle for an explicit_index_space_state. More...

#include <explicit_index_space_handle.h>

Inheritance diagram for sheaf::explicit_index_space_handle:
sheaf::index_space_handle sheaf::any fiber_bundle::section_space_schema_jims_index_space_handle sheaf::gathered_insertion_index_space_handle sheaf::offset_index_space_handle sheaf::primary_index_space_handle sheaf::primitives_index_space_handle sheaf::singleton_index_space_handle sheaf::sum_index_space_handle sheaf::scattered_insertion_index_space_handle sheaf::reserved_primary_index_space_handle sheaf::hub_index_space_handle sheaf::array_index_space_handle sheaf::hash_index_space_handle sheaf::interval_index_space_handle sheaf::list_index_space_handle

Friends

class explicit_index_space_state
 

EXPLICIT_INDEX_SPACE_HANDLE FACET

explicit_index_space_state_state
 The explicit state. More...
 
 explicit_index_space_handle ()
 Default constructor. More...
 
 explicit_index_space_handle (const explicit_index_space_handle &xother)
 Copy constructor. More...
 
 explicit_index_space_handle (const index_space_family &xid_spaces, pod_type xindex)
 Constructor: Attach to state with index xindex in the family xid_spaces. More...
 
 explicit_index_space_handle (const index_space_family &xid_spaces, const std::string &xname)
 Constructor: Attach to state with name xname in the family xid_spaces. More...
 
explicit_index_space_handleoperator= (const explicit_index_space_handle &xother)
 Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother). More...
 
virtual ~explicit_index_space_handle ()
 Destructor. More...
 
explicit_index_space_statestate ()
 The explicit state (mutable version). More...
 
const explicit_index_space_statestate () const
 The explicit state (const version). More...
 

INDEX_SPACE_HANDLE FACET

virtual explicit_index_space_handleoperator= (const index_space_handle &xother)
 Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother). More...
 
virtual explicit_index_space_handleclone () const
 Virtual constructor, makes a new instance of the same type as this. If the handle is attached, attach to the same state. More...
 

INDEX SPACE FACET

virtual const index_space_familyid_spaces () const
 The id space family for this (const version). More...
 
virtual index_space_familyid_spaces ()
 The id space family for this (mutable version). More...
 
virtual size_type ct () const
 The number of members. More...
 
virtual pod_type begin () const
 Beginning id of this space. More...
 
virtual pod_type end () const
 Ending id of this space. More...
 
virtual bool contains (pod_type xid) const
 True if this space contains id xid. More...
 
virtual bool contains_unglued_hub (pod_type xid) const
 True if this space contains an id equivalent to xid in the unglued hub id space. More...
 
virtual bool contains_glued_hub (pod_type xid) const
 True if this space contains an id equivalent to xid in the glued hub id space. More...
 
virtual bool contains (pod_type xid, pod_type xhub_id) const
 True if this space contains an id xid equivalent to xhub_id in the hub id space. More...
 
virtual pod_type pod (pod_type xid) const
 The pod index in this space equivalent to xid in the hub id space. More...
 
virtual pod_type unglued_hub_pod (pod_type xid) const
 The pod index in the unglued hub id space equivalent to xid in this id space. More...
 
virtual pod_type glued_hub_pod (pod_type xid) const
 The pod index in the hub id space equivalent to xid in this id space. synonym for unglued_hub_pod(xid). More...
 
virtual bool is_persistent () const
 True if this id space should be written to disk. More...
 

PRODUCT STRUCTURE FACET

virtual void new_product_structure (const abstract_product_structure &xproduct)
 Creates a new product structure for this id space by cloning the product structure, xproduct. More...
 
virtual void delete_product_structure ()
 Deletes the product structure for this id space. More...
 
virtual const abstract_product_structureproduct_structure () const
 The product structure for this id space (const version). More...
 
virtual abstract_product_structureproduct_structure ()
 The product structure for this id space (mutable version). More...
 
virtual bool has_product_structure () const
 True if this id space has a product structure. More...
 

HANDLE FACET

virtual const index_space_collectionhost () const
 The host collection. More...
 
virtual pod_type index () const
 Index of this space. More...
 
virtual bool is_attached () const
 True if this handle is attached to a state. More...
 
virtual void attach_to (pod_type xindex)
 Attach to the state with index xindex in the id space family id_spaces(). More...
 
virtual void attach_to (const index_space_collection &xhost, pod_type xlocal_id)
 Attach to the state with local scope id, xlocal_id in the host id space collection xhost. More...
 
virtual void detach ()
 Detach this handle form its state, if any. More...
 
virtual bool conforms_to_state (const index_space_collection &xhost, pod_type xlocal_id) const
 True if this conforms to the handle type required by the state with local scope id xlocal_id in the host id space collection xhost. More...
 
void attach_to (explicit_index_space_state *xstate)
 Attach to the explicit id space state xstate. More...
 
virtual bool conforms_to_state (explicit_index_space_state *xstate) const
 True if this conforms to the iterator type required by the explicit id space state xstate. More...
 
explicit_index_space_statestate (pod_type xindex) const
 The explicit id space state at id xindex in id space family id_spaces(). Returns null if no id space stae is available at index xindex. More...
 
explicit_index_space_statestate (const index_space_collection &xhost, pod_type xlocal_id) const
 The explicit id space state with local scope id xlocal_id in the host id space collection xhost. More...
 

HANDLE POOL FACET

virtual index_space_handleget_id_space () const
 Allocates an id space handle from the handle pool. More...
 
virtual void release_id_space () const
 Returns this id space handle to the handle pool. More...
 
virtual bool allocated_id_space () const
 True if and only if this id space handle was allocated by the handle pool. More...
 

ITERATOR POOL FACET

virtual index_space_iteratorget_iterator () const
 Allocates an id space iterator from the iterator pool. More...
 
virtual void release_iterator (index_space_iterator &xitr) const
 Returns the id space iterator xitr to the iterator pool. More...
 
virtual bool allocated_iterator (const index_space_iterator &xitr) const
 True if and only if id space iterator xitr was allocated by the iterator pool. More...
 

ANY FACET

virtual bool is_ancestor_of (const any *other) const
 Conformance test; true if other conforms to this. More...
 
virtual bool invariant () const
 Class invariant. More...
 

Additional Inherited Members

- Public Types inherited from sheaf::index_space_handle
typedef pod_index_type pod_type
 The "plain old data" index type for this. More...
 
- Public Member Functions inherited from sheaf::index_space_handle
virtual ~index_space_handle ()
 Destructor. More...
 
bool operator== (const index_space_handle &xother) const
 True if this is a handle has the same state as xother. More...
 
const hub_index_space_handlehub_id_space () const
 The hub id space. More...
 
bool is_empty () const
 True if there are no ids in the space. More...
 
bool is_gathered () const
 True if begin() == 0 and end() == ct(). More...
 
bool contains (const scoped_index &xid) const
 True if this space contains an id equivalent to xid. synonym for contains_hub(xid.hub_pod()). More...
 
bool contains_hub (pod_type xid) const
 True if this space contains an id equivalent to xid in the unglued hub id space. synonym for contains_unglued_hub(xid) More...
 
bool contains (pod_type xid, const scoped_index &xhub_id) const
 True if this space contains an id xid equivalent to xhub_id in the hub id space. synonym for contains(xid, xhub_id.hub_pod()). More...
 
pod_type pod (const scoped_index &xid) const
 The pod index in this space equivalent to xid. synonym for pod(xid.hub_pod()). More...
 
pod_type hub_pod (pod_type xid) const
 The pod index in the unglued hub id space equivalent to xid in this id space; synonym for unglued_hub_pod(pod_type). More...
 
template<typename T >
const T & product_structure () const
 The product structure of type T for this id space (const version). More...
 
template<typename T >
T & product_structure ()
 The product structure of type T for this id space (mutable version). More...
 
template<typename T >
bool product_structure_conforms_to () const
 True if the product structure for this id space conforms to type T. More...
 
std::string name () const
 Name of this space. More...
 
void put_name (const std::string &xname)
 Associate name xname with this id space. More...
 
void attach_to (const index_space_family &xid_spaces, pod_type xindex)
 Attach to the state with index xindex in the id space family xid_spaces. More...
 
void attach_to (const index_space_family &xid_spaces, const std::string &xname)
 Attach to the state with name xname in the id space family xid_spaces. More...
 
void attach_to (const std::string &xname)
 Attach to the state with name xname in the id space family id_spaces(). More...
 
void attach_to (const index_space_handle &xother)
 Attach to the state of the id space xother. More...
 
bool conforms_to_state (const index_space_family &xid_spaces, pod_type xindex) const
 True if this conforms to the handle type required by the state with index xindex in the id space family, xid_spaces. More...
 
bool conforms_to_state (const index_space_family &xid_spaces, const std::string &xname) const
 True if this conforms to the handle type required by the state with name xname in the id space family, xid_spaces. More...
 
bool conforms_to_state (pod_type xid) const
 True if this conforms to the handle type required by the state with id xid. More...
 
bool conforms_to_state (const std::string &xname) const
 True if this conforms to the handle type required by the state with name xname. More...
 
bool conforms_to_state (const index_space_handle &xother) const
 True if this conforms to the handle type required by the state of xother. More...
 
- Public Member Functions inherited from sheaf::any
bool is_same_type (const any *other) const
 True if other is the same type as this. More...
 
virtual ~any ()
 Destructor. More...
 
bool invariant_check () const
 True if invariant checking is enabled. More...
 
void enable_invariant_check () const
 Enable invariant checking. More...
 
void disable_invariant_check () const
 Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...
 
int disable_invariance_check_request_depth () const
 Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...
 
- Protected Member Functions inherited from sheaf::index_space_handle
 index_space_handle ()
 Default constructor. More...
 
 index_space_handle (const index_space_handle &xother)
 Copy constructor; disabled. More...
 
- Protected Member Functions inherited from sheaf::any
 any ()
 default constructor More...
 

Detailed Description

An implementation of class index_space_handle for an explicit_index_space_state.

Definition at line 42 of file explicit_index_space_handle.h.

Constructor & Destructor Documentation

◆ explicit_index_space_handle() [1/4]

sheaf::explicit_index_space_handle::explicit_index_space_handle ( )

Default constructor.

Postcondition

Definition at line 36 of file explicit_index_space_handle.cc.

References invariant().

Referenced by clone(), and explicit_index_space_handle().

◆ explicit_index_space_handle() [2/4]

sheaf::explicit_index_space_handle::explicit_index_space_handle ( const explicit_index_space_handle xother)

Copy constructor.

Postcondition
  • (*this) == xother

Definition at line 53 of file explicit_index_space_handle.cc.

References explicit_index_space_handle(), and invariant().

◆ explicit_index_space_handle() [3/4]

sheaf::explicit_index_space_handle::explicit_index_space_handle ( const index_space_family xid_spaces,
pod_type  xindex 
)

Constructor: Attach to state with index xindex in the family xid_spaces.

Precondition
  • conforms_to_state(xid_spaces, xindex)
Postcondition

Definition at line 73 of file explicit_index_space_handle.cc.

References attach_to(), conforms_to_state(), explicit_index_space_handle(), id_spaces(), index(), invariant(), and is_attached().

◆ explicit_index_space_handle() [4/4]

sheaf::explicit_index_space_handle::explicit_index_space_handle ( const index_space_family xid_spaces,
const std::string &  xname 
)

Constructor: Attach to state with name xname in the family xid_spaces.

Precondition
  • conforms_to_state(xid_spaces, xname)
Postcondition

Definition at line 97 of file explicit_index_space_handle.cc.

References attach_to(), conforms_to_state(), id_spaces(), invariant(), is_attached(), sheaf::index_space_handle::name(), and ~explicit_index_space_handle().

◆ ~explicit_index_space_handle()

sheaf::explicit_index_space_handle::~explicit_index_space_handle ( )
virtual

Destructor.

Definition at line 121 of file explicit_index_space_handle.cc.

References operator=().

Referenced by explicit_index_space_handle().

Member Function Documentation

◆ allocated_id_space()

bool sheaf::explicit_index_space_handle::allocated_id_space ( ) const
virtual

True if and only if this id space handle was allocated by the handle pool.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 967 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::allocated_id_space(), get_iterator(), and is_attached().

Referenced by release_id_space().

◆ allocated_iterator()

bool sheaf::explicit_index_space_handle::allocated_iterator ( const index_space_iterator xitr) const
virtual

True if and only if id space iterator xitr was allocated by the iterator pool.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 1042 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::allocated_iterator(), is_ancestor_of(), and is_attached().

Referenced by sheaf::gathered_insertion_index_space_handle::push(), and release_iterator().

◆ attach_to() [1/3]

void sheaf::explicit_index_space_handle::attach_to ( pod_type  xindex)
virtual

Attach to the state with index xindex in the id space family id_spaces().

Precondition
  • conforms_to_state(xindex)
Postcondition

Implements sheaf::index_space_handle.

Definition at line 614 of file explicit_index_space_handle.cc.

References _state, conforms_to_state(), contains(), id_spaces(), index(), is_attached(), and state().

Referenced by sheaf::array_index_space_handle::array_index_space_handle(), sheaf::explicit_index_space_state::attach(), conforms_to_state(), explicit_index_space_handle(), sheaf::gathered_insertion_index_space_handle::gathered_insertion_index_space_handle(), sheaf::hash_index_space_handle::hash_index_space_handle(), sheaf::hub_index_space_handle::hub_index_space_handle(), sheaf::poset_scaffold::initialize_dof_tuple_id_space(), sheaf::crg_interval::initialize_local_id_space(), sheaf::poset_scaffold::initialize_member_id_space(), sheaf::poset_scaffold::initialize_subposet_id_space(), sheaf::interval_index_space_handle::interval_index_space_handle(), is_attached(), sheaf::list_index_space_handle::list_index_space_handle(), sheaf::member_record_set::member_record_set(), fiber_bundle::sec_rep_space::multisection_id_space(), sheaf::primary_sum_index_space_state::new_reserved_term(), sheaf::offset_index_space_handle::offset_index_space_handle(), sheaf::scattered_insertion_index_space_handle::operator=(), sheaf::gathered_insertion_index_space_handle::operator=(), sheaf::hub_index_space_handle::operator=(), sheaf::primitives_index_space_handle::operator=(), sheaf::reserved_primary_index_space_handle::operator=(), operator=(), sheaf::primary_index_space_handle::operator=(), sheaf::sum_index_space_handle::operator=(), sheaf::singleton_index_space_handle::operator=(), sheaf::interval_index_space_handle::operator=(), sheaf::offset_index_space_handle::operator=(), sheaf::hash_index_space_handle::operator=(), sheaf::array_index_space_handle::operator=(), fiber_bundle::section_space_schema_jims_index_space_handle::operator=(), sheaf::list_index_space_handle::operator=(), sheaf::primary_index_space_handle::primary_index_space_handle(), sheaf::primitives_index_space_handle::primitives_index_space_handle(), sheaf::reserved_primary_index_space_handle::reserved_primary_index_space_handle(), sheaf::scattered_insertion_index_space_handle::scattered_insertion_index_space_handle(), fiber_bundle::section_space_schema_jims_index_space_handle::section_space_schema_jims_index_space_handle(), sheaf::singleton_index_space_handle::singleton_index_space_handle(), and sheaf::sum_index_space_handle::sum_index_space_handle().

◆ attach_to() [2/3]

void sheaf::explicit_index_space_handle::attach_to ( const index_space_collection xhost,
pod_type  xlocal_id 
)
virtual

Attach to the state with local scope id, xlocal_id in the host id space collection xhost.

Precondition
  • xhost.contains(xlocal_id)
  • conforms_to_state(xhost, xlocal_id)
Postcondition
  • index() == xhost.family_scope(xlocal_id)

Implements sheaf::index_space_handle.

Definition at line 641 of file explicit_index_space_handle.cc.

References _state, conforms_to_state(), sheaf::index_space_collection::contains(), detach(), sheaf::index_space_collection::family_scope(), host(), index(), is_attached(), and state().

◆ attach_to() [3/3]

void sheaf::explicit_index_space_handle::attach_to ( explicit_index_space_state xstate)
protected

Attach to the explicit id space state xstate.

Precondition
  • xstate != 0
  • conforms_to_state(xstate)
Postcondition

Definition at line 708 of file explicit_index_space_handle.cc.

References _state, conforms_to_state(), is_attached(), and state().

◆ begin()

◆ clone()

◆ conforms_to_state() [1/2]

◆ conforms_to_state() [2/2]

bool sheaf::explicit_index_space_handle::conforms_to_state ( explicit_index_space_state xstate) const
protectedvirtual

True if this conforms to the iterator type required by the explicit id space state xstate.

Postcondition
  • is_basic_query

Definition at line 731 of file explicit_index_space_handle.cc.

References state().

◆ contains() [1/2]

bool sheaf::explicit_index_space_handle::contains ( pod_type  xid) const
virtual

True if this space contains id xid.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 374 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::contains(), contains_unglued_hub(), and is_attached().

Referenced by attach_to(), sheaf::sum_index_space_handle::binary(), contains_glued_hub(), sheaf::hub_index_space_handle::delete_id(), end(), sheaf::sum_index_space_handle::host_rep(), index(), sheaf::index_equivalence_class::index_equivalence_class(), sheaf::index_equivalence_iterator::index_equivalence_iterator(), sheaf::scattered_insertion_index_space_handle::insert(), sheaf::member_record::internalize(), sheaf::reserved_primary_index_space_state::is_hub_id_available(), sheaf::hash_index_space_state::map_rep_gather(), sheaf::hub_index_space_handle::new_id(), sheaf::hub_index_space_handle::new_primary_term(), sheaf::singleton_index_space_handle::new_space(), sheaf::singleton_index_space_state::new_space(), fiber_bundle::i_adjacency_index_space_interval::new_space(), fiber_bundle::i_connectivity_index_space_interval::new_space(), fiber_bundle::ij_adjacency_index_space_interval::new_space(), fiber_bundle::ij_connectivity_index_space_interval::new_space(), fiber_bundle::ijk_connectivity_index_space_interval::new_space(), fiber_bundle::ijk_adjacency_index_space_interval::new_space(), pod(), sheaf::gathered_insertion_index_space_handle::push(), sheaf::gathered_insertion_index_space_handle::push_back(), sheaf::index_equivalence_iterator::put_rep_id(), sheaf::gathered_insertion_index_space_handle::remove(), sheaf::interval_index_space_handle::remove_interval(), fields::field_refinement_buffer::reserve_coord_fiber(), fields::field_refinement_buffer::reserve_prop_fiber(), sheaf::sum_index_space_handle::simple(), state(), sheaf::sum_index_space_handle::term_of(), and sheaf::hub_index_space_handle::unglue().

◆ contains() [2/2]

bool sheaf::explicit_index_space_handle::contains ( pod_type  xid,
pod_type  xhub_id 
) const
virtual

True if this space contains an id xid equivalent to xhub_id in the hub id space.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 437 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::contains(), is_attached(), and pod().

◆ contains_glued_hub()

bool sheaf::explicit_index_space_handle::contains_glued_hub ( pod_type  xid) const
virtual

True if this space contains an id equivalent to xid in the glued hub id space.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 416 of file explicit_index_space_handle.cc.

References _state, contains(), sheaf::explicit_index_space_state::contains_glued_hub(), and is_attached().

Referenced by contains_unglued_hub().

◆ contains_unglued_hub()

bool sheaf::explicit_index_space_handle::contains_unglued_hub ( pod_type  xid) const
virtual

True if this space contains an id equivalent to xid in the unglued hub id space.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 395 of file explicit_index_space_handle.cc.

References _state, contains_glued_hub(), sheaf::explicit_index_space_state::contains_unglued_hub(), and is_attached().

Referenced by contains(), glued_hub_pod(), sheaf::list_index_space_handle::push_front(), sheaf::list_index_space_handle::replace_range_id(), and unglued_hub_pod().

◆ ct()

sheaf::size_type sheaf::explicit_index_space_handle::ct ( ) const
virtual

The number of members.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 311 of file explicit_index_space_handle.cc.

References _state, begin(), sheaf::explicit_index_space_state::ct(), and is_attached().

Referenced by sheaf::primary_index_space_handle::extend(), sheaf::hub_index_space_handle::extend_last_term(), sheaf::primary_sum_index_space_state::extend_last_term(), fiber_bundle::section_space_schema_table_dof_crg_range::get_size(), fiber_bundle::product_section_space_schema_crg_range::get_size(), id_spaces(), sheaf::scattered_insertion_index_space_handle::insert(), sheaf::interval_index_space_handle::insert_interval(), sheaf::reserved_primary_index_space_handle::new_hub_id(), sheaf::reserved_primary_index_space_handle::new_id(), sheaf::hub_index_space_handle::new_primary_term(), sheaf::offset_index_space_handle::new_space(), sheaf::reserved_primary_index_space_state::new_space(), sheaf::singleton_index_space_state::new_space(), sheaf::offset_index_space_state::new_space(), sheaf::primary_index_space_state::new_space(), fiber_bundle::section_space_schema_jims_index_space_state::new_space(), sheaf::operator<<(), sheaf::gathered_insertion_index_space_handle::push(), sheaf::gathered_insertion_index_space_handle::push_back(), sheaf::list_index_space_handle::push_front(), sheaf::interval_index_space_handle::push_interval(), sheaf::gathered_insertion_index_space_handle::remove(), sheaf::gathered_insertion_index_space_handle::remove_hub(), sheaf::hub_index_space_handle::remove_term(), and sheaf::crg_interval::size().

◆ delete_product_structure()

void sheaf::explicit_index_space_handle::delete_product_structure ( )
virtual

Deletes the product structure for this id space.

Precondition
Postcondition
  • !has_product_structure()

Implements sheaf::index_space_handle.

Definition at line 827 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::delete_product_structure(), has_product_structure(), is_attached(), and product_structure().

Referenced by new_product_structure().

◆ detach()

void sheaf::explicit_index_space_handle::detach ( )
virtual

Detach this handle form its state, if any.

Postcondition
  • !is_attached()

Implements sheaf::index_space_handle.

Definition at line 665 of file explicit_index_space_handle.cc.

References _state, conforms_to_state(), and is_attached().

Referenced by attach_to().

◆ end()

◆ get_id_space()

◆ get_iterator()

◆ glued_hub_pod()

sheaf::index_space_handle::pod_type sheaf::explicit_index_space_handle::glued_hub_pod ( pod_type  xid) const
virtual

The pod index in the hub id space equivalent to xid in this id space. synonym for unglued_hub_pod(xid).

Precondition
Postcondition
  • !is_valid(result) || contains_unglued_hub(result)

Implements sheaf::index_space_handle.

Definition at line 500 of file explicit_index_space_handle.cc.

References _state, contains_unglued_hub(), sheaf::explicit_index_space_state::glued_hub_pod(), is_attached(), is_persistent(), and sheaf::is_valid().

Referenced by sheaf::hub_index_space_handle::glue(), sheaf::index_space_collection::glued_hub_pod(), sheaf::explicit_index_space_state::glued_hub_pod(), sheaf::index_space_family::glued_hub_pod(), and unglued_hub_pod().

◆ has_product_structure()

bool sheaf::explicit_index_space_handle::has_product_structure ( ) const
virtual

True if this id space has a product structure.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 892 of file explicit_index_space_handle.cc.

References _state, get_id_space(), sheaf::explicit_index_space_state::has_product_structure(), and is_attached().

Referenced by delete_product_structure(), new_product_structure(), and product_structure().

◆ host()

const sheaf::index_space_collection & sheaf::explicit_index_space_handle::host ( ) const
virtual

The host collection.

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 553 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::host(), index(), and is_attached().

Referenced by attach_to(), is_persistent(), and state().

◆ id_spaces() [1/2]

const sheaf::index_space_family & sheaf::explicit_index_space_handle::id_spaces ( ) const
virtual

The id space family for this (const version).

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 269 of file explicit_index_space_handle.cc.

References _state, sheaf::explicit_index_space_state::id_spaces(), and is_attached().

Referenced by sheaf::array_index_space_handle::array_index_space_handle(), attach_to(), clone(), sheaf::poset_state_handle::dof_tuple_hub_id_space(), explicit_index_space_handle(), sheaf::gathered_insertion_index_space_handle::gathered_insertion_index_space_handle(), sheaf::hash_index_space_handle::hash_index_space_handle(), sheaf::hub_index_space_handle::hub_index_space_handle(), index(), sheaf::interval_index_space_handle::interval_index_space_handle(), sheaf::list_index_space_handle::list_index_space_handle(), sheaf::poset_state_handle::member_hub_id_space(), sheaf::hub_index_space_handle::new_primary_term(), sheaf::offset_index_space_handle::new_space(), sheaf::hash_index_space_handle::new_space(), sheaf::array_index_space_handle::new_space(), sheaf::primitives_index_space_state::new_space(), sheaf::singleton_index_space_state::new_space(), sheaf::reserved_primary_index_space_state::new_space(), sheaf::offset_index_space_state::new_space(), sheaf::primary_index_space_state::new_space(), sheaf::hash_index_space_state::new_space(), fiber_bundle::section_space_schema_jims_index_space_state::new_space(), sheaf::list_index_space_state::new_space(), sheaf::array_index_space_state::new_space(), sheaf::interval_index_space_state::new_space(), sheaf::primary_sum_index_space_state::new_space(), sheaf::offset_index_space_handle::offset_index_space_handle(), sheaf::primary_index_space_handle::primary_index_space_handle(), sheaf::primitives_index_space_handle::primitives_index_space_handle(), sheaf::reserved_primary_index_space_handle::reserved_primary_index_space_handle(), sheaf::scattered_insertion_index_space_handle::scattered_insertion_index_space_handle(), fiber_bundle::section_space_schema_jims_index_space_handle::section_space_schema_jims_index_space_handle(), sheaf::singleton_index_space_handle::singleton_index_space_handle(), state(), sheaf::poset_state_handle::subposet_hub_id_space(), and sheaf::sum_index_space_handle::sum_index_space_handle().

◆ id_spaces() [2/2]

sheaf::index_space_family & sheaf::explicit_index_space_handle::id_spaces ( )
virtual

The id space family for this (mutable version).

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 290 of file explicit_index_space_handle.cc.

References _state, ct(), sheaf::explicit_index_space_state::id_spaces(), and is_attached().

◆ index()

sheaf::index_space_handle::pod_type sheaf::explicit_index_space_handle::index ( ) const
virtual

Index of this space.

Precondition
Postcondition

Implements sheaf::index_space_handle.

Definition at line 574 of file explicit_index_space_handle.cc.

References _state, contains(), id_spaces(), sheaf::explicit_index_space_state::index(), and is_attached().

Referenced by sheaf::array_index_space_handle::array_index_space_handle(), attach_to(), explicit_index_space_handle(), sheaf::crg_interval::force_explicit_cover(), sheaf::gathered_insertion_index_space_handle::gathered_insertion_index_space_handle(), sheaf::hash_index_space_handle::hash_index_space_handle(), host(), sheaf::hub_index_space_handle::hub_index_space_handle(), sheaf::index_equivalence_class::index_equivalence_class(), fiber_bundle::point_block_crg_interval::initialize_block_vertices(), fiber_bundle::structured_block_1d_crg_interval::initialize_block_vertices(), fiber_bundle::structured_block_2d_crg_interval::initialize_block_vertices(), fiber_bundle::structured_block_3d_crg_interval::initialize_block_vertices(), fiber_bundle::zone_nodes_block_crg_interval::initialize_vertex_client_id_space(), sheaf::interval_index_space_handle::interval_index_space_handle(), sheaf::list_index_space_handle::list_index_space_handle(), sheaf::primary_sum_index_space_state::new_primary_term(), sheaf::primary_sum_index_space_state::new_reserved_term(), sheaf::singleton_index_space_state::new_space(), sheaf::reserved_primary_index_space_state::new_space(), sheaf::offset_index_space_state::new_space(), sheaf::primary_index_space_state::new_space(), sheaf::primitives_index_space_state::new_space(), sheaf::array_index_space_state::new_space(), sheaf::list_index_space_state::new_space(), sheaf::hash_index_space_state::new_space(), fiber_bundle::section_space_schema_jims_index_space_state::new_space(), sheaf::interval_index_space_state::new_space(), sheaf::primary_sum_index_space_state::new_space(), sheaf::offset_index_space_handle::offset_index_space_handle(), sheaf::primary_index_space_handle::primary_index_space_handle(), sheaf::primitives_index_space_handle::primitives_index_space_handle(), sheaf::implicit_crg_interval::put_private_data(), sheaf::reserved_primary_index_space_handle::reserved_primary_index_space_handle(), sheaf::scattered_insertion_index_space_handle::scattered_insertion_index_space_handle(), fiber_bundle::section_space_schema_jims_index_space_handle::section_space_schema_jims_index_space_handle(), sheaf::singleton_index_space_handle::singleton_index_space_handle(), sheaf::sum_index_space_handle::sum_index_space_handle(), and sheaf::id_space_names_record::transfer_poset_to_internal_buffer().

◆ invariant()

◆ is_ancestor_of()

◆ is_attached()

bool sheaf::explicit_index_space_handle::is_attached ( ) const
virtual

True if this handle is attached to a state.

Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 595 of file explicit_index_space_handle.cc.

References _state, and attach_to().

Referenced by allocated_id_space(), allocated_iterator(), sheaf::array_index_space_handle::array_index_space_handle(), sheaf::explicit_index_space_state::attach(), attach_to(), begin(), sheaf::gathered_insertion_index_space_handle::capacity(), sheaf::gathered_insertion_index_space_handle::clear(), contains(), contains_glued_hub(), contains_unglued_hub(), ct(), fiber_bundle::base_space_poset::d_cells_id_space(), delete_product_structure(), detach(), sheaf::poset_state_handle::dof_tuple_hub_id_space(), sheaf::poset_scaffold::dof_tuple_id_space(), sheaf::poset_scaffold::dof_tuple_id_space_initialized(), end(), explicit_index_space_handle(), sheaf::gathered_insertion_index_space_handle::gather(), sheaf::gathered_insertion_index_space_handle::gathered_insertion_index_space_handle(), fiber_bundle::sec_rep_space::get_branch_id_space(), fiber_bundle::sec_rep_space_member::get_branch_id_space(), sheaf::primitives_index_space_state::get_id_space(), sheaf::singleton_index_space_state::get_id_space(), sheaf::offset_index_space_state::get_id_space(), sheaf::reserved_primary_index_space_state::get_id_space(), sheaf::primary_index_space_state::get_id_space(), fiber_bundle::section_space_schema_jims_index_space_state::get_id_space(), sheaf::hash_index_space_state::get_id_space(), sheaf::array_index_space_state::get_id_space(), get_id_space(), sheaf::list_index_space_state::get_id_space(), sheaf::interval_index_space_state::get_id_space(), sheaf::primary_sum_index_space_state::get_id_space(), get_iterator(), glued_hub_pod(), sheaf::primary_sum_index_space_state::has_gathered_id_space(), has_product_structure(), sheaf::hash_index_space_handle::hash_index_space_handle(), host(), sheaf::singleton_index_space_handle::hub_id(), fiber_bundle::homogeneous_block::hub_id_space(), sheaf::hub_index_space_handle::hub_index_space_handle(), sheaf::subposet::id_space(), id_spaces(), index(), sheaf::scattered_insertion_index_space_handle::insert(), sheaf::interval_index_space_handle::insert_interval(), sheaf::interval_index_space_handle::interval_begin(), sheaf::interval_index_space_handle::interval_end(), sheaf::interval_index_space_handle::interval_index_space_handle(), is_persistent(), sheaf::list_index_space_handle::list_index_space_handle(), sheaf::poset_state_handle::member_hub_id_space(), sheaf::poset_scaffold::member_id_space(), sheaf::poset_scaffold::member_id_space_initialized(), sheaf::interval_index_space_handle::merge_mode(), fiber_bundle::sec_rep_space::multisection_id_space(), sheaf::reserved_primary_index_space_handle::new_id(), sheaf::primary_sum_index_space_state::new_id(), new_product_structure(), sheaf::gathered_insertion_index_space_handle::next_id(), sheaf::primary_index_space_handle::offset(), sheaf::offset_index_space_handle::offset(), sheaf::offset_index_space_handle::offset_index_space_handle(), sheaf::operator<<(), sheaf::gathered_insertion_index_space_handle::operator=(), sheaf::scattered_insertion_index_space_handle::operator=(), sheaf::hub_index_space_handle::operator=(), sheaf::primitives_index_space_handle::operator=(), sheaf::reserved_primary_index_space_handle::operator=(), operator=(), sheaf::primary_index_space_handle::operator=(), sheaf::sum_index_space_handle::operator=(), sheaf::singleton_index_space_handle::operator=(), sheaf::offset_index_space_handle::operator=(), sheaf::interval_index_space_handle::operator=(), sheaf::hash_index_space_handle::operator=(), sheaf::array_index_space_handle::operator=(), fiber_bundle::section_space_schema_jims_index_space_handle::operator=(), sheaf::list_index_space_handle::operator=(), pod(), sheaf::primary_index_space_handle::primary_index_space_handle(), sheaf::primitives_index_space_handle::primitives_index_space_handle(), product_structure(), sheaf::gathered_insertion_index_space_handle::push(), sheaf::gathered_insertion_index_space_handle::push_back(), sheaf::interval_index_space_handle::put_merge_mode(), release_id_space(), release_iterator(), sheaf::gathered_insertion_index_space_handle::remove(), sheaf::gathered_insertion_index_space_handle::remove_hub(), sheaf::interval_index_space_handle::remove_hub_interval(), sheaf::interval_index_space_handle::remove_interval(), sheaf::gathered_insertion_index_space_handle::reserve(), sheaf::reserved_primary_index_space_handle::reserved_primary_index_space_handle(), sheaf::scattered_insertion_index_space_handle::scattered_insertion_index_space_handle(), fiber_bundle::section_space_schema_jims_index_space_handle::section_space_schema_jims_index_space_handle(), sheaf::singleton_index_space_handle::singleton_index_space_handle(), sheaf::gathered_insertion_index_space_handle::state(), sheaf::scattered_insertion_index_space_handle::state(), state(), sheaf::sum_index_space_handle::state(), sheaf::primitives_index_space_handle::state(), sheaf::hub_index_space_handle::state(), sheaf::reserved_primary_index_space_handle::state(), sheaf::primary_index_space_handle::state(), sheaf::singleton_index_space_handle::state(), sheaf::interval_index_space_handle::state(), sheaf::offset_index_space_handle::state(), sheaf::hash_index_space_handle::state(), sheaf::array_index_space_handle::state(), fiber_bundle::section_space_schema_jims_index_space_handle::state(), sheaf::list_index_space_handle::state(), sheaf::poset_state_handle::subposet_hub_id_space(), sheaf::poset_scaffold::subposet_id_space(), sheaf::poset_scaffold::subposet_id_space_initialized(), sheaf::sum_index_space_handle::sum_index_space_handle(), unglued_hub_pod(), and sheaf::gathered_insertion_index_space_handle::update_extrema().

◆ is_persistent()

◆ new_product_structure()

void sheaf::explicit_index_space_handle::new_product_structure ( const abstract_product_structure xproduct)
virtual

Creates a new product structure for this id space by cloning the product structure, xproduct.

Precondition
Postcondition

Implements sheaf::index_space_handle.

Definition at line 806 of file explicit_index_space_handle.cc.

References _state, delete_product_structure(), has_product_structure(), is_attached(), and sheaf::explicit_index_space_state::new_product_structure().

Referenced by fiber_bundle::section_space_schema_poset::initialize_standard_members(), and state().

◆ operator=() [1/2]

sheaf::explicit_index_space_handle & sheaf::explicit_index_space_handle::operator= ( const explicit_index_space_handle xother)

Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother).

Precondition
  • xother.is_attached() ? conforms_to_state(xother) : true
Postcondition
  • (*this) == xother

Definition at line 138 of file explicit_index_space_handle.cc.

References attach_to(), conforms_to_state(), invariant(), is_attached(), and state().

Referenced by state(), and ~explicit_index_space_handle().

◆ operator=() [2/2]

◆ pod()

sheaf::index_space_handle::pod_type sheaf::explicit_index_space_handle::pod ( pod_type  xid) const
virtual

The pod index in this space equivalent to xid in the hub id space.

Precondition
Postcondition
  • !is_valid(result) || contains(result)

Implements sheaf::index_space_handle.

Definition at line 458 of file explicit_index_space_handle.cc.

References _state, contains(), is_attached(), sheaf::is_valid(), sheaf::explicit_index_space_state::pod(), and unglued_hub_pod().

Referenced by fiber_bundle::sec_rep_space::branch_id_space_name(), contains(), sheaf::crg_interval::cover_id_space_id(), sheaf::member_record::externalize(), fiber_bundle::zone_nodes_block_crg_interval::get_implicit_private_data(), sheaf::interval_index_space_handle::insert_interval(), fields::zone_centered_tet_refiner::modify_subposets(), fields::zone_centered_segment_refiner::modify_subposets(), fields::zone_centered_triangle_refiner::modify_subposets(), fields::edge_centered_polygon_refiner::modify_subposets(), fiber_bundle::base_space_poset::new_member(), fiber_bundle::section_space_schema_table_dof_crg_range::ordinal(), sheaf::interval_index_space_handle::push_interval(), fiber_bundle::unstructured_block_builder::put_name_mode(), sheaf::gathered_insertion_index_space_handle::remove_hub(), sheaf::list_index_space_handle::replace_range_id(), fields::field_refinement_buffer::reserve_coord_fiber(), fields::field_refinement_buffer::reserve_prop_fiber(), tool::visualization_iterator_1_1::set_vtk_data(), tool::visualization_iterator_4_2::set_vtk_data(), tool::visualization_iterator_4_3::set_vtk_data(), tool::visualization_iterator_1_3::set_vtk_data(), sheaf::poset_general_record::transfer_poset_to_internal_buffer(), and sheaf::attributes_record_set::write_toc_bounds_attribute().

◆ product_structure() [1/2]

const sheaf::abstract_product_structure & sheaf::explicit_index_space_handle::product_structure ( ) const
virtual

◆ product_structure() [2/2]

sheaf::abstract_product_structure & sheaf::explicit_index_space_handle::product_structure ( )
virtual

The product structure for this id space (mutable version).

Precondition
Postcondition
  • is_basic_query

Implements sheaf::index_space_handle.

Definition at line 870 of file explicit_index_space_handle.cc.

References _state, has_product_structure(), is_attached(), and sheaf::explicit_index_space_state::product_structure().

◆ release_id_space()

◆ release_iterator()

void sheaf::explicit_index_space_handle::release_iterator ( index_space_iterator xitr) const
virtual

◆ state() [1/4]

sheaf::explicit_index_space_state & sheaf::explicit_index_space_handle::state ( )
protected

The explicit state (mutable version).

Precondition
Postcondition
  • is_basic_query

Definition at line 162 of file explicit_index_space_handle.cc.

References _state, and is_attached().

Referenced by attach_to(), conforms_to_state(), operator=(), and state().

◆ state() [2/4]

const sheaf::explicit_index_space_state & sheaf::explicit_index_space_handle::state ( ) const
protected

The explicit state (const version).

Precondition
Postcondition
  • is_basic_query

Definition at line 183 of file explicit_index_space_handle.cc.

References _state, is_attached(), and operator=().

◆ state() [3/4]

sheaf::explicit_index_space_state * sheaf::explicit_index_space_handle::state ( pod_type  xindex) const
protected

The explicit id space state at id xindex in id space family id_spaces(). Returns null if no id space stae is available at index xindex.

Precondition
Postcondition
  • is_basic_query

Definition at line 750 of file explicit_index_space_handle.cc.

References sheaf::index_space_family::collection(), sheaf::index_space_collection::contains(), contains(), sheaf::index_space_collection::explicit_state(), host(), id_spaces(), is_attached(), sheaf::index_space_collection::local_scope(), and state().

◆ state() [4/4]

sheaf::explicit_index_space_state * sheaf::explicit_index_space_handle::state ( const index_space_collection xhost,
pod_type  xlocal_id 
) const
protected

The explicit id space state with local scope id xlocal_id in the host id space collection xhost.

Precondition
  • xhost.contains(xlocal_id)
Postcondition
  • is_basic_query

Definition at line 776 of file explicit_index_space_handle.cc.

References sheaf::index_space_collection::contains(), sheaf::index_space_collection::explicit_state(), and new_product_structure().

◆ unglued_hub_pod()

sheaf::index_space_handle::pod_type sheaf::explicit_index_space_handle::unglued_hub_pod ( pod_type  xid) const
virtual

The pod index in the unglued hub id space equivalent to xid in this id space.

Precondition
Postcondition
  • !is_valid(result) || contains_unglued_hub(result)

Implements sheaf::index_space_handle.

Definition at line 479 of file explicit_index_space_handle.cc.

References _state, contains_unglued_hub(), glued_hub_pod(), is_attached(), sheaf::is_valid(), and sheaf::explicit_index_space_state::unglued_hub_pod().

Referenced by sheaf::index_space_iterator::glued_hub_pod(), pod(), and sheaf::list_index_space_handle::push_front().

Member Data Documentation

◆ _state


The documentation for this class was generated from the following files: