Iterator over the discretization subposet associated with a section_space_schema_member anchor. More...

#include <discretization_iterator.h>

Inheritance diagram for fiber_bundle::discretization_iterator:

Public Member Functions
	discretization_iterator ()
	Default constructor; creates an unattached iterator. More...

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

	~discretization_iterator ()
	Destructor. More...

virtual bool	is_ancestor_of (const any *other) const
	True if other conforms to this. More...

virtual discretization_iterator *	clone () const
	Make a new instance of the same type as this. More...

bool	invariant () const
	The class invariant. More...

	discretization_iterator (const section_space_schema_member &xschema_anchor)
	Creates an iterator anchored on base_space of xschema_anchor. More...

virtual bool	is_initialized () const
	True if this has been initialized for iteration with respect to a specific anchor. More...

virtual void	force_is_done ()
	Force the iterator to be done. More...

void	next ()
	Makes this the next member of the subset. More...

virtual void	next (bool xtruncate)
	Makes this the next member of the subset. If xtruncate, new this is not less than old this, i.e. the depth-first descent is truncated and the cover of this is not visited. More...

section_space_schema_member &	schema_anchor ()
	The schema member whose base space is being iterated over; the top member of the domain of iteration (mutable version). More...

const section_space_schema_member &	schema_anchor () const
	The schema member whose base space is being iterated over; the top member of the domain of iteration (const version). More...

void	put_schema_anchor (const section_space_schema_member &xschema_anchor)
	Set schema_anchor() to the same state as xschema_anchor. More...

void	put_schema_anchor (pod_index_type xschema_anchor_index)
	Set schema_anchor() to the member identified by xschema_anchor_index. More...

void	put_schema_anchor (const scoped_index &xschema_anchor_index)
	Set schema_anchor() to the member identified by xschema_anchor_index. More...

const scoped_index &	discretization_member_index () const
	The current discretization member index. More...

const scoped_index &	evaluation_member_index () const
	The current evaluation member index. More...

bool	is_multivalued () const
	True, if the current discretization member is in the multivalued subposet. More...

Public Member Functions inherited from sheaf::depth_first_iterator
depth_first_iterator &	operator= (const depth_first_iterator &xother)
	Assignment operator. More...

virtual	~depth_first_iterator ()
	Destructor. More...

bool	invariant () const
	The class invariant. More...

order_type	order () const
	The order of the iteration. Determines which actions are exported to the client. More...

virtual abstract_poset_member &	anchor ()
	The poset member whose downset is being iterated over; the top member of the domain of iteration (mutable version). More...

virtual const abstract_poset_member &	anchor () const
	The poset member whose downset is being iterated over; the top member of the domain of iteration (const version). More...

virtual bool	anchor_is_ancestor_of (const abstract_poset_member &xmbr) const
	True if xmbr conforms to the type of anchor of this. More...

bool	descending () const
	True if iterating over down set of anchor. More...

bool	strict () const
	True if iterating over xstrict up/down set of anchor. More...

subposet &	filter ()
	The subposet which is the filter; Defines what is passed, not what is blocked. More...

bool	is_done () const
	True if iteration finished. More...

void	next ()
	Makes this the next member of the subset. More...

void	truncate ()
	Makes this the next member of the subset which is not less than old this, i.e. the depth-first descent is truncated and the cover of this is not visited. More...

virtual void	reset (bool xreset_markers=true)
	Restarts the iteration over the down set of anchor(). More...

int	ct (bool xreset=false)
	The number of members of the iteration set, from the current member to the end, inclusive. If xreset, reset before computing the count. More...

bool	has_visited (pod_index_type xhub_id) const
	True if this has already visited member with hub id xhub_id. More...

bool	has_visited (const scoped_index &xid) const
	True if this has already visited member with id xid. More...

bool	has_visited (const abstract_poset_member *xmbr) const
	True if this has already visited member xmbr. More...

void	put_has_visited (pod_index_type xhub_id, bool xvalue)
	Set the visited marker for hub id xhub_id to xvalue. Intended for use reseting iterator without having to reset entire collection of markers. More...

void	put_has_visited (const scoped_index &xid, bool xvalue)
	Set the visisted marker for id xid to xvalue. Intended for use reseting iterator without having to reset entire collection of markers. More...

bool	visit_once () const
	True if traversal should only visit a member once; that is, it should not revisit members it has already visited. More...

void	put_visit_once (bool xvisit_once)
	Set visit_once() to xvisit_once. More...

bool	is_maximal () const
	True if the current member has no greater member within the subposet visited by this iterator. More...

const scoped_index &	greater_index () const
	The index of the greater member of the current link. More...

const scoped_index &	lesser_index () const
	The index of the lesser member of the current link. More...

action_type	action () const
	The type of action the client should take when the iterator returns control to the client. More...

void	erase_cover ()
	Schedules the lesser member entry in the cover of the greater member of the current link for deletion on the next call to next(). Warning: this function can change the state of the the cover relation graph in unpredictable ways. Use only if you know what you are doing. More...

const scoped_index &	index () const
	The index of the current member of the iteration. More...

size_t	depth () const
	The length of the path from anchor() to the current member. 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
void	initialize_schema_anchor (const section_space_schema_member &xanchor)
	Initializes the schema anchor. More...

virtual void	initialize_has_visited (const abstract_poset_member &xanchor)
	Initializes the has_visited markers. More...

Protected Member Functions inherited from sheaf::depth_first_iterator
	depth_first_iterator ()
	Default constructor; creates an unattached iterator,. More...

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

void	first ()
	Moves this to the first member of the iteration. More...

void	mark_visited (abstract_poset_member *xmbr)
	Mark xmbr as visited. Warning: this function can change the state of the iteration in unpredictable ways. Use only if you know what you are doing. More...

void	mark_not_visited (abstract_poset_member *xmbr)
	Mark xmbr as not visited. Warning: this function can change the state of the iteration in unpredictable ways. Use only if you know what you are doing. More...

virtual void	attach_item ()
	Attaches the item handle to the current index. Empty in this class; intended for redefinition in descendants. More...

virtual void	detach_item ()
	Detaches the item handle to the current index. Empty in this class; intended for redefinition in descendants. More...

void	initialize_order (order_type xorder)
	Initializes _order and _transition_fcn. More...

void	initialize_traversal (const abstract_poset_member &xanchor)
	Initializes the anchor, has_visited markers and filter. More...

void	initialize_traversal (pod_index_type xanchor_hub_id)
	Initializes the anchor, has_visited markers and filter. More...

void	initialize_traversal (const scoped_index &xanchor_id)
	Initializes the anchor, has_visited markers and filter. More...

void	initialize_anchor (const abstract_poset_member &xanchor)
	Initializes the anchor. More...

zn_to_bool *	has_visited () const
	The marker bit vector. /. More...

void	put_has_visited (zn_to_bool *xhas_visited)
	Sets _has_visited to xhas_visited. /. More...

bool	filter (pod_index_type xhub_id) const
	The value of the filter at hub id xhub_id. More...

bool	filter (const scoped_index &xid) const
	The value of the filter at id xid. More...

void	initialize_filter ()
	Initializes the filter subposet from the client filter. More...

void	initialize_filter (const subposet &xfilter)
	Initializes the client filter to xfilter then initializes the filter from the client filter. More...

void	initialize_filter (pod_index_type xfilter_hub_id)
	Initializes the client filter to the subposet with hub id xfilter_hub_id then initializes the filter from the client filter. More...

void	initialize_filter (const scoped_index &xfilter_id)
	Initializes the client filter to the subposet with id xfilter_id then initializes the filter from the client filter. More...

void	initialize_filter (const std::string &xfilter_name)
	Initializes the client filter to the subposet with name xfilter_name then initializes the filter from the client filter. More...

void	release_cover_id_space_iterators ()
	Release the cover iterators back to the pool of iterators. More...

Protected Member Functions inherited from sheaf::any
	any ()
	default constructor More...

Friends
class	section_dof_iterator

Additional Inherited Members
Public Types inherited from sheaf::depth_first_iterator
enum	order_type { PREORDER, POSTORDER, LINKORDER, BIORDER, TRIORDER, NOT_AN_ORDER }
	The types of order in which the iterator will visit the members of the poset. Determines which actions are exported to the client. More...

enum	action_type { PREVISIT_ACTION, LINK_ACTION, POSTVISIT_ACTION, NOT_AN_ACTION }
	The types of action a client should take when the iterator returns control to the client. More...

Static Public Attributes inherited from sheaf::depth_first_iterator
static const char *	NULL_FILTER = ""
	Placeholder for null filter. More...

Protected Types inherited from sheaf::depth_first_iterator
enum	iterator_state { FIRST, INIT_COVER_ITERATOR, TEST_HAS_VISITED, INC_COVER_ITERATOR, ERASE_COVER_ITERATOR, DESCEND, TEST_PATH_TAIL, ASCEND, EXECUTE_PREVISIT_ACTION, EXECUTE_LINK_ACTION, EXECUTE_POSTVISIT_ACTION, FINISH, NOT_A_STATE }
	The states for the finite state machine that controls iteration. More...

enum	iterator_token { PASS, FAIL }
	The input tokens for the finite state machine. More...

typedef const iterator_state(*	transition_fcn_type)[FAIL+1]

Protected Attributes inherited from sheaf::depth_first_iterator
abstract_poset_member *	_anchor
	The top member of the down set being iterated over. More...

action_type	_action
	The type of action the client should take; the state of the iterator. More...

scoped_index	_index
	The index of the lesser end of the current link; the current item in the iteration. More...

scoped_index	_greater_index
	The index of the greater member of the current link. More...

scoped_index	_lesser_index
	The index of the lesser member of the current link. More...

subposet	_client_filter
	The filter specified by the client. More...

bool	_new_filter
	True if this allocated a new filter;. More...

bool	_descending
	True if iterating over the up/down set of anchor. More...

bool	_strict
	True if iterating over the strict up/down set of anchor. More...

order_type	_order
	The order of the iteration. More...

const iterator_state(*	_transition_fcn )[FAIL+1]
	The current state transition function for the iterator finite state machine. Points to one of the predefined transition functions. More...

iterator_state	_state
	The current state of iteration. More...

index_space_iterator *	_path_head_lc
	The lower cover iterator for the head of the path to the current member of the iteration. More...

index_space_iterator *	_path_head
	The head of the path to the current member of the iteration lesser_index() == this->index() == **_path_head == lesser member of current link. More...

std::stack< index_space_iterator * >	_path_tail
	The tail of the path to the current member of the iteration greater_index() == **(_path_tail.top()) == greater member of current link. More...

std::stack< pod_index_type >	_filtered_path_tail
	The tail of the filtered path to the current member of the iteration. Contains only members which pass the filter; equivalent to the path in the subposet selected by the filter. More...

bool	_visit_once
	True if traversal should only visit a member once; that is, it should not revisit members it has already visited. More...

Static Protected Attributes inherited from sheaf::depth_first_iterator
static const char *	iterator_state_names [NOT_A_STATE+1]
	The names of the iterator states, convenient for debugging. More...

static const iterator_state	PREORDER_TRANSITION_FCN [NOT_A_STATE-1][FAIL+1]
	The predefined transition function for postorder iteration. Defines the next state for each combination of state and input token, except for state FINISH, which is always a terminal state. More...

static const iterator_state	POSTORDER_TRANSITION_FCN [NOT_A_STATE-1][FAIL+1]
	The predefined transition function for postorder iteration. Defines the next state for each combination of state and input token, except for state FINISH, which is always a terminal state. More...

static const iterator_state	LINKORDER_TRANSITION_FCN [NOT_A_STATE-1][FAIL+1]
	The predefined transition function for linkorder iteration. Defines the next state for each combination of state and input token, except for state FINISH, which is always a terminal state. More...

static const iterator_state	BIORDER_TRANSITION_FCN [NOT_A_STATE-1][FAIL+1]
	The predefined transition function for biorder iteration. Defines the next state for each combination of state and input token, except for state FINISH, which is always a terminal state. More...

static const iterator_state	TRIORDER_TRANSITION_FCN [NOT_A_STATE-1][FAIL+1]
	The predefined transition function for triorder iteration. Defines the next state for each combination of state and input token, except for state FINISH, which is always a terminal state. More...

static const transition_fcn_type	STD_TRANSITION_FCNS [NOT_AN_ORDER+1]
	The set of predefined transition functions. More...

Detailed Description

Iterator over the discretization subposet associated with a section_space_schema_member anchor.

Definition at line 49 of file discretization_iterator.h.

Constructor & Destructor Documentation

◆ discretization_iterator() [1/3]

fiber_bundle::discretization_iterator::discretization_iterator ( )

Default constructor; creates an unattached iterator.

Postcondition

invariant()

!is_initialized()

Definition at line 29 of file discretization_iterator.cc.

References sheaf::depth_first_iterator::initialize_order(), sheaf::scoped_index::invalidate(), invariant(), and is_initialized().

Referenced by clone(), and invariant().

◆ discretization_iterator() [2/3]

fiber_bundle::discretization_iterator::discretization_iterator ( const discretization_iterator & xother )

Copy constructor.

Not Implemented.

Postcondition

invariant()

Definition at line 57 of file discretization_iterator.cc.

References invariant(), and ~discretization_iterator().

◆ ~discretization_iterator()

fiber_bundle::discretization_iterator::~discretization_iterator ( )

Destructor.

Hack:: remove depth_first_iterator::has_viist()/put_has_visited(zn_to_bool*) when no longer need here.

Definition at line 76 of file discretization_iterator.cc.

References fiber_bundle::section_space_schema_member::detach_from_state(), sheaf::depth_first_iterator::has_visited(), is_ancestor_of(), and sheaf::depth_first_iterator::put_has_visited().

Referenced by discretization_iterator().

◆ discretization_iterator() [3/3]

fiber_bundle::discretization_iterator::discretization_iterator ( const section_space_schema_member & xschema_anchor )

Creates an iterator anchored on base_space of xschema_anchor.

Precondition

xschema_anchor.state_is_read_accessible()

Postcondition

invariant()

is_initialized()

schema_anchor().is_same_state(&xschema_anchor)

schema_anchor().is_same_type(&xschema_anchor)

descending()

!strict()

-unexecutable( !is_done() implies this is first member )

Definition at line 182 of file discretization_iterator.cc.

References sheaf::depth_first_iterator::descending(), sheaf::depth_first_iterator::first(), sheaf::depth_first_iterator::initialize_order(), invariant(), sheaf::depth_first_iterator::is_done(), is_initialized(), sheaf::any::is_same_type(), put_schema_anchor(), sheaf::depth_first_iterator::reset(), schema_anchor(), sheaf::read_write_monitor_handle::state_is_read_accessible(), and sheaf::depth_first_iterator::strict().

Member Function Documentation

◆ clone()

fiber_bundle::discretization_iterator * fiber_bundle::discretization_iterator::clone ( ) const

virtual

Make a new instance of the same type as this.

Postcondition

result != 0

!result->is_initialized()

Reimplemented from sheaf::depth_first_iterator.

Definition at line 125 of file discretization_iterator.cc.

References discretization_iterator(), invariant(), and is_initialized().

Referenced by is_ancestor_of().

◆ discretization_member_index()

const sheaf::scoped_index & fiber_bundle::discretization_iterator::discretization_member_index ( ) const

The current discretization member index.

Definition at line 619 of file discretization_iterator.cc.

References evaluation_member_index().

Referenced by fiber_bundle::sparse_field_dof_map::get_component_dofs(), is_multivalued(), fields::discretization_pusher::push(), fiber_bundle::sparse_field_dof_map::put_component_dofs(), and put_schema_anchor().

◆ evaluation_member_index()

const sheaf::scoped_index & fiber_bundle::discretization_iterator::evaluation_member_index ( ) const

The current evaluation member index.

Precondition

is_multivalued()

Definition at line 626 of file discretization_iterator.cc.

References is_multivalued().

Referenced by discretization_member_index().

◆ force_is_done()

void fiber_bundle::discretization_iterator::force_is_done ( )

virtual

Force the iterator to be done.

Postcondition

invariant()

is_done()

Reimplemented from sheaf::depth_first_iterator.

Definition at line 239 of file discretization_iterator.cc.

References sheaf::singly_linked_list< T, A >::clear(), sheaf::depth_first_iterator::force_is_done(), sheaf::scoped_index::invalidate(), invariant(), sheaf::depth_first_iterator::is_done(), and next().

Referenced by is_initialized(), and put_schema_anchor().

◆ initialize_has_visited()

void fiber_bundle::discretization_iterator::initialize_has_visited ( const abstract_poset_member & xanchor )

protectedvirtual

Initializes the has_visited markers.

Precondition

xanchor.state_is_read_accessible()

is_done()

Hack:: remove depth_first_iterator::has_viist()/put_has_visited(zn_to_bool*) when no longer need here. _descending_has_visited = _has_visited; _ascending_has_visited = new zn_to_bool(*_has_visited);

Postcondition

has_visited() != 0

_descending_has_visited == has_visited()

_ascending_has_visited != 0

is_done()

Reimplemented from sheaf::depth_first_iterator.

Definition at line 706 of file discretization_iterator.cc.

References sheaf::depth_first_iterator::has_visited(), sheaf::depth_first_iterator::initialize_has_visited(), sheaf::depth_first_iterator::is_done(), and sheaf::read_write_monitor_handle::state_is_read_accessible().

Referenced by initialize_schema_anchor().

◆ initialize_schema_anchor()

void fiber_bundle::discretization_iterator::initialize_schema_anchor ( const section_space_schema_member & xanchor )

protected

Initializes the schema anchor.

Precondition

xschema_anchor.state_is_read_accessible()

is_done()

Postcondition

is_done()

_schema_anchor->is_same_state(&xschema_anchor)

_schema_anchor->version() == xschema_anchor.version()

_schema_anchor->is_same_type(&xschema_anchor)

Definition at line 663 of file discretization_iterator.cc.

References fiber_bundle::section_space_schema_member::attach_to_state(), fiber_bundle::section_space_schema_member::clone(), fiber_bundle::section_space_schema_member::detach_from_state(), initialize_has_visited(), sheaf::depth_first_iterator::is_done(), sheaf::poset_component::is_same_state(), sheaf::any::is_same_type(), sheaf::read_write_monitor_handle::state_is_read_accessible(), and sheaf::poset_component::version().

Referenced by is_multivalued(), and put_schema_anchor().

◆ invariant()

bool fiber_bundle::discretization_iterator::invariant ( ) const

virtual

The class invariant.

Invariant

depth_first_iterator::invariant()

order()==BIORDER

is_initialized() ? anchor().is_same_state(&(schema_anchor().base_space())) : true

Reimplemented from sheaf::any.

Definition at line 147 of file discretization_iterator.cc.

References sheaf::depth_first_iterator::anchor(), sheaf::any::disable_invariant_check(), discretization_iterator(), sheaf::any::enable_invariant_check(), sheaf::depth_first_iterator::invariant(), sheaf::any::invariant_check(), is_initialized(), sheaf::depth_first_iterator::order(), and schema_anchor().

Referenced by clone(), discretization_iterator(), force_is_done(), next(), and put_schema_anchor().

◆ is_ancestor_of()

bool fiber_bundle::discretization_iterator::is_ancestor_of ( const any * other ) const

virtual

True if other conforms to this.

Reimplemented from sheaf::depth_first_iterator.

Definition at line 106 of file discretization_iterator.cc.

References clone().

Referenced by ~discretization_iterator().

◆ is_initialized()

bool fiber_bundle::discretization_iterator::is_initialized ( ) const

virtual

True if this has been initialized for iteration with respect to a specific anchor.

Reimplemented from sheaf::depth_first_iterator.

Definition at line 220 of file discretization_iterator.cc.

References force_is_done(), and sheaf::depth_first_iterator::is_initialized().

Referenced by clone(), discretization_iterator(), invariant(), is_multivalued(), put_schema_anchor(), and schema_anchor().

◆ is_multivalued()

bool fiber_bundle::discretization_iterator::is_multivalued ( ) const

True, if the current discretization member is in the multivalued subposet.

Precondition

is_initialized()

Postcondition

result == ((discretization_member_index().is_valid()) && schema_anchor().is_multivalued() && schema_anchor().multivalued().contains_member(discretization_member_index()))

Definition at line 637 of file discretization_iterator.cc.

References sheaf::subposet::contains_member(), discretization_member_index(), initialize_schema_anchor(), is_initialized(), fiber_bundle::section_space_schema_member::is_multivalued(), sheaf::is_valid(), sheaf::scoped_index::is_valid(), fiber_bundle::section_space_schema_member::multivalued(), and schema_anchor().

Referenced by evaluation_member_index(), and next().

◆ next() [1/2]

void fiber_bundle::discretization_iterator::next ( )

inline

Makes this the next member of the subset.

Definition at line 111 of file discretization_iterator.h.

Referenced by force_is_done(), fiber_bundle::sparse_field_dof_map::get_component_dofs(), fields::discretization_pusher::push(), and fiber_bundle::sparse_field_dof_map::put_component_dofs().

◆ next() [2/2]

void fiber_bundle::discretization_iterator::next ( bool xtruncate )

virtual

Makes this the next member of the subset. If xtruncate, new this is not less than old this, i.e. the depth-first descent is truncated and the cover of this is not visited.

Precondition