An implementation of implicit_index_space_iterator for an implicit id space in an i_adjacency_index_space_interval. More...

#include <i_adjacency_implicit_index_space_iterator.h>

Inheritance diagram for fiber_bundle::i_adjacency_implicit_index_space_iterator:

Friends
class	i_adjacency_implicit_index_space_interval

I_ADJACENCY_IMPLICIT_INDEX_SPACE_ITERATOR FACET
pod_type	_hub_begin
	The hub id of the first zone in the adjacency list. More...

size_type	_i_ct
	The number of adjacent zones in the i direction. More...

pod_type	_i
	The current index in the i direction. More...

	i_adjacency_implicit_index_space_iterator ()
	Default constructor. More...

	i_adjacency_implicit_index_space_iterator (const i_adjacency_implicit_index_space_iterator &xother)
	Copy constructor. More...

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

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

i_adjacency_implicit_index_space_iterator &	operator= (const i_adjacency_implicit_index_space_iterator &xother)
	Assignment operator. More...

virtual	~i_adjacency_implicit_index_space_iterator ()
	Destructor. More...

pod_type	hub_begin () const
	The hub id of the first zone in the adjacency list. More...

size_type	i_ct () const
	The number of adjacent zones in the i direction. More...

INDEX_SPACE_ITERATOR FACET
virtual i_adjacency_implicit_index_space_iterator &	operator= (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 i_adjacency_implicit_index_space_iterator *	clone () 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_collection &	host () 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_family &	id_spaces () const
	The id space family for this (const version). More...

const hub_index_space_handle &	hub_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...

virtual void	attach_to (const index_space_collection &xhost, pod_type xlocal_id)=0
	Attach to the state with local scope id, xlocal_id in the host id space collection xhost. 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...

virtual bool	conforms_to_state (const index_space_collection &xhost, pod_type xlocal_id) const =0
	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...

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_iterator &	operator= (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 i_adjacency_index_space_interval.

Definition at line 45 of file i_adjacency_implicit_index_space_iterator.h.

Constructor & Destructor Documentation

◆ i_adjacency_implicit_index_space_iterator() [1/4]

fiber_bundle::i_adjacency_implicit_index_space_iterator::i_adjacency_implicit_index_space_iterator ( )

Default constructor.

Postcondition

invariant()

!is_attached()

Definition at line 36 of file i_adjacency_implicit_index_space_iterator.cc.

Referenced by i_adjacency_implicit_index_space_iterator().

◆ i_adjacency_implicit_index_space_iterator() [2/4]

fiber_bundle::i_adjacency_implicit_index_space_iterator::i_adjacency_implicit_index_space_iterator ( const i_adjacency_implicit_index_space_iterator & xother )

Copy constructor.

Postcondition

invariant()

(*this) == xother

Definition at line 53 of file i_adjacency_implicit_index_space_iterator.cc.

References i_adjacency_implicit_index_space_iterator().

◆ i_adjacency_implicit_index_space_iterator() [3/4]

fiber_bundle::i_adjacency_implicit_index_space_iterator::i_adjacency_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.

◆ i_adjacency_implicit_index_space_iterator() [4/4]

fiber_bundle::i_adjacency_implicit_index_space_iterator::i_adjacency_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

invariant()

is_attached()

&id_spaces() == &xid_spaces

name() == xname

Definition at line 96 of file i_adjacency_implicit_index_space_iterator.cc.

References operator=().

◆ ~i_adjacency_implicit_index_space_iterator()

fiber_bundle::i_adjacency_implicit_index_space_iterator::~i_adjacency_implicit_index_space_iterator ( )

virtual

Destructor.

Definition at line 151 of file i_adjacency_implicit_index_space_iterator.cc.

References hub_begin().

Referenced by operator=().

Member Function Documentation

◆ attach_to()

void fiber_bundle::i_adjacency_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)

Postcondition

invariant()

is_attached()

&host() == &xhost

index() == xhost.family_scope(xlocal_id)

Definition at line 395 of file i_adjacency_implicit_index_space_iterator.cc.

References fiber_bundle::i_adjacency_index_space_interval::adjacent_zones(), conforms_to_state(), sheaf::index_space_collection::contains(), and sheaf::index_space_collection::family_scope().

Referenced by reset().

◆ clone()

fiber_bundle::i_adjacency_implicit_index_space_iterator * fiber_bundle::i_adjacency_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 279 of file i_adjacency_implicit_index_space_iterator.cc.

References next().

Referenced by operator==().

◆ conforms_to_state()

bool fiber_bundle::i_adjacency_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

Definition at line 434 of file i_adjacency_implicit_index_space_iterator.cc.

References is_ancestor_of().

Referenced by attach_to().

◆ hub_begin()

fiber_bundle::i_adjacency_implicit_index_space_iterator::pod_type fiber_bundle::i_adjacency_implicit_index_space_iterator::hub_begin ( ) const

The hub id of the first zone in the adjacency list.

Postcondition

is_basic_query

Definition at line 168 of file i_adjacency_implicit_index_space_iterator.cc.

References i_ct().

Referenced by ~i_adjacency_implicit_index_space_iterator().

◆ i_ct()

sheaf::size_type fiber_bundle::i_adjacency_implicit_index_space_iterator::i_ct ( ) const

The number of adjacent zones in the i direction.

Postcondition

is_basic_query

Definition at line 185 of file i_adjacency_implicit_index_space_iterator.cc.

References operator=().

Referenced by hub_begin().

◆ invariant()

bool fiber_bundle::i_adjacency_implicit_index_space_iterator::invariant ( ) const

virtual

Class invariant.

Invariant

implicit_index_space_iterator::invariant()

Reimplemented from sheaf::implicit_index_space_iterator.

Definition at line 486 of file i_adjacency_implicit_index_space_iterator.cc.

References sheaf::implicit_index_space_iterator::invariant().

Referenced by is_ancestor_of().

◆ is_ancestor_of()

bool fiber_bundle::i_adjacency_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 465 of file i_adjacency_implicit_index_space_iterator.cc.

References invariant().

Referenced by conforms_to_state().

◆ next()

void fiber_bundle::i_adjacency_implicit_index_space_iterator::next ( )

virtual

Makes item() the next id in the iteration.

Precondition

is_attached()

!is_done()

Postcondition

invariant()

is_done() || pod() != old_pod

is_done() || hub_pod() != old_hub_pod

Implements sheaf::index_space_iterator.

Definition at line 313 of file i_adjacency_implicit_index_space_iterator.cc.

References reset().

Referenced by clone().

◆ operator=() [1/2]

fiber_bundle::i_adjacency_implicit_index_space_iterator & fiber_bundle::i_adjacency_implicit_index_space_iterator::operator= ( const i_adjacency_implicit_index_space_iterator & xother )

Assignment operator.

Postcondition

invariant()

(*this) == xother

Definition at line 121 of file i_adjacency_implicit_index_space_iterator.cc.

References _hub_begin, _i, _i_ct, sheaf::implicit_index_space_iterator::is_attached(), and ~i_adjacency_implicit_index_space_iterator().

Referenced by i_adjacency_implicit_index_space_iterator(), and i_ct().

◆ operator=() [2/2]

fiber_bundle::i_adjacency_implicit_index_space_iterator & fiber_bundle::i_adjacency_implicit_index_space_iterator::operator= ( const index_space_iterator & xother )

virtual

Assignment operator.

Precondition