SheafSystem  0.0.0.0
sheaf::ragged_array_implicit_index_space_iterator Class Reference

An implementation of implicit_index_space_iterator for an implicit id space in an ragged_array_index_space_interval. The equivalence between the ids in the space and the hub id space is stored in a two dimensional array with variable length rows. More...

#include <ragged_array_implicit_index_space_iterator.h>

Inheritance diagram for sheaf::ragged_array_implicit_index_space_iterator:
sheaf::implicit_index_space_iterator sheaf::index_space_iterator sheaf::any

Friends

class ragged_array_implicit_index_space_interval
 

RAGGED_ARRAY_IMPLICIT_INDEX_SPACE_ITERATOR FACET

const pod_type_to_hub
 The ragged_array to hub ids. More...
 
pod_type _end
 The end of this id space. More...
 
 ragged_array_implicit_index_space_iterator ()
 Default constructor. More...
 
 ragged_array_implicit_index_space_iterator (const ragged_array_implicit_index_space_iterator &xother)
 Copy constructor. More...
 
 ragged_array_implicit_index_space_iterator (const index_space_family &xid_spaces, pod_type xindex)
 Constructor: Attach to state with index xindex in the family xid_spaces. More...
 
 ragged_array_implicit_index_space_iterator (const index_space_family &xid_spaces, const std::string &xname)
 Constructor: Attach to state with name xname in the family xid_spaces. More...
 
ragged_array_implicit_index_space_iteratoroperator= (const ragged_array_implicit_index_space_iterator &xother)
 True if this is equivalent to xother. More...
 
virtual ~ragged_array_implicit_index_space_iterator ()
 Destructor. More...
 

INDEX_SPACE_ITERATOR FACET

virtual ragged_array_implicit_index_space_iteratoroperator= (const index_space_iterator &xother)
 Assignment operator. More...
 
virtual bool operator== (const index_space_iterator &xother) const
 True if this is equivalent to xother. More...
 
virtual ragged_array_implicit_index_space_iteratorclone () const
 Virtual constructor, makes a new instance of the same type as this. If the iterator is attached, attach to the same state. More...
 

ITERATOR FACET

virtual void next ()
 Makes item() the next id in the iteration. More...
 
virtual void reset ()
 Restarts the iteration. More...
 

HANDLE FACET

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

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_iterator
typedef pod_index_type pod_type
 The "plain old data" index type for this. More...
 
- Public Member Functions inherited from sheaf::implicit_index_space_iterator
virtual ~implicit_index_space_iterator ()
 Destructor. More...
 
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 iterator 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 detach ()
 Detach this iterator form its state, if any. More...
 
- Public Member Functions inherited from sheaf::index_space_iterator
virtual ~index_space_iterator ()
 Destructor. More...
 
bool is_done () const
 True if iteration is finished. More...
 
void force_is_done ()
 Makes is_done() true. More...
 
pod_type pod () const
 The current id in the iteration. More...
 
pod_type hub_pod () const
 The current unglued hub id in the iteration. synonym for unglued_hub_pod(). More...
 
pod_type unglued_hub_pod () const
 The current unglued hub id in the iteration. More...
 
pod_type glued_hub_pod () const
 The current glued hub id in the iteration. More...
 
const index_space_familyid_spaces () const
 The id space family for this (const version). More...
 
const hub_index_space_handlehub_id_space () const
 The hub id space. More...
 
std::string name () const
 Name of this 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 &xid_space)
 Attach to the state of the id space xid_space. 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...
 
- 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::implicit_index_space_iterator
 implicit_index_space_iterator ()
 Default constructor. More...
 
 implicit_index_space_iterator (const implicit_index_space_iterator &xother)
 Copy constructor. More...
 
implicit_index_space_iteratoroperator= (const implicit_index_space_iterator &xother)
 Assignment operator. More...
 
- Protected Member Functions inherited from sheaf::index_space_iterator
 index_space_iterator ()
 Creates an iterator for the id space. More...
 
 index_space_iterator (const index_space_iterator &xother)
 Copy constructor. More...
 
void invalidate_ids ()
 Set is_done() and invalidate pod() and hub_pod(). More...
 
- Protected Member Functions inherited from sheaf::any
 any ()
 default constructor More...
 
- Protected Attributes inherited from sheaf::implicit_index_space_iterator
const index_space_collection_host
 The host collection. More...
 
pod_type _local_id
 The id of this space in the local host id space. More...
 
- Protected Attributes inherited from sheaf::index_space_iterator
bool _is_done
 True if the iteration is finished. More...
 
pod_type _pod
 The current id in the iteration. More...
 
pod_type _hub_pod
 The current hub id in the iteration. More...
 

Detailed Description

An implementation of implicit_index_space_iterator for an implicit id space in an ragged_array_index_space_interval. The equivalence between the ids in the space and the hub id space is stored in a two dimensional array with variable length rows.

Definition at line 45 of file ragged_array_implicit_index_space_iterator.h.

Constructor & Destructor Documentation

◆ ragged_array_implicit_index_space_iterator() [1/4]

sheaf::ragged_array_implicit_index_space_iterator::ragged_array_implicit_index_space_iterator ( )

Default constructor.

Postcondition
  • !is_attached()

Definition at line 34 of file ragged_array_implicit_index_space_iterator.cc.

References invariant(), and sheaf::implicit_index_space_iterator::is_attached().

Referenced by clone(), and ragged_array_implicit_index_space_iterator().

◆ ragged_array_implicit_index_space_iterator() [2/4]

sheaf::ragged_array_implicit_index_space_iterator::ragged_array_implicit_index_space_iterator ( const ragged_array_implicit_index_space_iterator xother)

Copy constructor.

Postcondition
  • (*this) == xother

Definition at line 51 of file ragged_array_implicit_index_space_iterator.cc.

References invariant(), and ragged_array_implicit_index_space_iterator().

◆ ragged_array_implicit_index_space_iterator() [3/4]

sheaf::ragged_array_implicit_index_space_iterator::ragged_array_implicit_index_space_iterator ( 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 70 of file ragged_array_implicit_index_space_iterator.cc.

References attach_to(), conforms_to_state(), sheaf::index_space_iterator::id_spaces(), sheaf::implicit_index_space_iterator::index(), invariant(), sheaf::implicit_index_space_iterator::is_attached(), and ragged_array_implicit_index_space_iterator().

◆ ragged_array_implicit_index_space_iterator() [4/4]

sheaf::ragged_array_implicit_index_space_iterator::ragged_array_implicit_index_space_iterator ( 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 94 of file ragged_array_implicit_index_space_iterator.cc.

References attach_to(), conforms_to_state(), sheaf::index_space_iterator::id_spaces(), invariant(), sheaf::implicit_index_space_iterator::is_attached(), sheaf::index_space_iterator::name(), and operator=().

◆ ~ragged_array_implicit_index_space_iterator()

sheaf::ragged_array_implicit_index_space_iterator::~ragged_array_implicit_index_space_iterator ( )
virtual

Destructor.

Definition at line 148 of file ragged_array_implicit_index_space_iterator.cc.

References operator=().

Referenced by operator=().

Member Function Documentation

◆ attach_to()

void sheaf::ragged_array_implicit_index_space_iterator::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)
  • reinterpret_cast<const ragged_array_index_space_interval&>(xhost).ct(xlocal_id) > 0
Postcondition
  • index() == xhost.family_scope(xlocal_id)

Implements sheaf::index_space_iterator.

Definition at line 366 of file ragged_array_implicit_index_space_iterator.cc.

References _end, sheaf::implicit_index_space_iterator::_host, sheaf::implicit_index_space_iterator::_local_id, _to_hub, conforms_to_state(), sheaf::index_space_collection::contains(), sheaf::ragged_array_index_space_interval::end(), sheaf::index_space_collection::family_scope(), sheaf::implicit_index_space_iterator::host(), sheaf::ragged_array_index_space_interval::hub_ids(), sheaf::implicit_index_space_iterator::index(), invariant(), sheaf::implicit_index_space_iterator::is_attached(), and reset().

Referenced by ragged_array_implicit_index_space_iterator(), and reset().

◆ clone()

sheaf::ragged_array_implicit_index_space_iterator * sheaf::ragged_array_implicit_index_space_iterator::clone ( ) const
virtual

Virtual constructor, makes a new instance of the same type as this. If the iterator is attached, attach to the same state.

Postcondition
  • result != 0
  • is_same_type(result)
  • *result == *this

Implements sheaf::implicit_index_space_iterator.

Definition at line 241 of file ragged_array_implicit_index_space_iterator.cc.

References sheaf::any::is_same_type(), next(), and ragged_array_implicit_index_space_iterator().

Referenced by operator==().

◆ conforms_to_state()

bool sheaf::ragged_array_implicit_index_space_iterator::conforms_to_state ( const index_space_collection xhost,
pod_type  xlocal_id 
) const
virtual

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.

Postcondition
  • is_basic_query

Implements sheaf::index_space_iterator.

Definition at line 407 of file ragged_array_implicit_index_space_iterator.cc.

References is_ancestor_of().

Referenced by attach_to(), and ragged_array_implicit_index_space_iterator().

◆ invariant()

◆ is_ancestor_of()

bool sheaf::ragged_array_implicit_index_space_iterator::is_ancestor_of ( const any other) const
virtual

Conformance test; true if other conforms to this.

Precondition
  • other != 0

Reimplemented from sheaf::implicit_index_space_iterator.

Definition at line 438 of file ragged_array_implicit_index_space_iterator.cc.

References invariant().

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

◆ next()

◆ operator=() [1/2]

◆ operator=() [2/2]

sheaf::ragged_array_implicit_index_space_iterator & sheaf::ragged_array_implicit_index_space_iterator::operator= ( const index_space_iterator xother)
virtual

Assignment operator.

Precondition
  • is_ancestor_of(&xother)
Postcondition
  • (*this) == xother

Reimplemented from sheaf::implicit_index_space_iterator.

Definition at line 187 of file ragged_array_implicit_index_space_iterator.cc.

References invariant(), is_ancestor_of(), and operator==().

◆ operator==()

bool sheaf::ragged_array_implicit_index_space_iterator::operator== ( const index_space_iterator xother) const
virtual

True if this is equivalent to xother.

Precondition
  • is_ancestor_of(&xother)
Postcondition

Reimplemented from sheaf::implicit_index_space_iterator.

Definition at line 212 of file ragged_array_implicit_index_space_iterator.cc.

References _end, _to_hub, clone(), invariant(), is_ancestor_of(), sheaf::implicit_index_space_iterator::is_attached(), and sheaf::implicit_index_space_iterator::operator==().

Referenced by operator=().

◆ reset()

Member Data Documentation

◆ _end

pod_type sheaf::ragged_array_implicit_index_space_iterator::_end
protected

The end of this id space.

Definition at line 99 of file ragged_array_implicit_index_space_iterator.h.

Referenced by attach_to(), next(), operator=(), operator==(), and reset().

◆ _to_hub

const pod_type* sheaf::ragged_array_implicit_index_space_iterator::_to_hub
protected

The ragged_array to hub ids.

Definition at line 94 of file ragged_array_implicit_index_space_iterator.h.

Referenced by attach_to(), next(), operator=(), operator==(), and reset().


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