SheafSystem
0.0.0.0
|
Abstract iterator over the discretization of the property section of a field_vd. Concurrently traverses the schema of both the coordinates and property sections of a field, returning to the client at each property discretization member, with enough context to evaluate the coordinate section at the property discretization point. More...
#include <property_disc_iterator.h>
Classes | |
struct | depth_flags_type |
Relative depth flags type. More... | |
PROPERTY_DISC_ITERATOR FACET | |
section_iteration_state | _coord_state |
Descriptor for coordinate section iteration. More... | |
section_iteration_state | _prop_state |
Descriptor for property section iteration. More... | |
depth_flags_type | _at |
True if current iteration is a member of the subposet associated with the flag. More... | |
depth_flags_type | _above |
True if current iteration is above the subposet associated with the flag. More... | |
static property_disc_iterator * | new_property_disc_iterator (const section_space_schema_member &xcoords_schema, const section_space_schema_member &xprop_schema) |
Creates an iterator appropriate for xcoords and xprop. More... | |
~property_disc_iterator () | |
Destructor. More... | |
const section_space_schema_member & | coordinates_schema () const |
The coordinates field schema member which is being iterated over. More... | |
const section_space_schema_member & | property_schema () const |
The property field schema member which is being iterated over. More... | |
const base_space_poset & | base_space () const |
The base space shared by both schema. More... | |
const subposet & | coordinates_evaluation () const |
The evaluation subposet for the coordinates. More... | |
const subposet & | property_evaluation () const |
The evaluation subposet for the property. More... | |
int | db () const |
The dimension of the current evaluation member. More... | |
pod_index_type | type_id () const |
The type id of the current member. More... | |
std::string | type_name () const |
The type name of the current member. More... | |
section_evaluator & | coordinate_evaluator () const |
The coordinate field evaluator associated with the current evaluation member. More... | |
section_evaluator & | property_evaluator () const |
The property field evaluator associated with the current evaluation member. More... | |
const block< discretization_context > & | coordinate_discretization_members () const |
The coordinate discretization members in the downset of the current evaluation member. More... | |
const block< discretization_context > & | property_discretization_members () const |
The property discretization members in the downset of the current evaluation member. More... | |
virtual void | get_prop_disc_values (const sec_vd &xsec)=0 |
The gets the values of xsec at the property discretization points. More... | |
property_disc_iterator () | |
Default constructor. More... | |
property_disc_iterator (const property_disc_iterator &xother) | |
Copy constructor; disabled. More... | |
void | initialize_iteration (const field_vd &xfield, order_type xorder) |
Initializes this for iteration of type xorder over the schema of xfield. More... | |
void | initialize_iteration (const section_space_schema_member &xcoordinates_schema, const section_space_schema_member &xproperty_schema, order_type xorder) |
Initializes this for iteration of type xorder over xcoordinates_schema and xproperty_schema. More... | |
DEPTH_FIRST_ITERATOR FACET | |
virtual void | force_is_done () |
Force the iterator to be done. More... | |
ANY FACET | |
virtual bool | is_ancestor_of (const any *xother) const |
True if other conforms to this. More... | |
virtual property_disc_iterator * | clone () const =0 |
Make a new instance of the same type as this. More... | |
bool | invariant () const |
The class invariant. More... | |
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... | |
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 bool | is_initialized () const |
True if this has been initialized for iteration with respect to a specific anchor. 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 | next (bool xtruncate) |
Makes this the next member of the subset. If action() == PREVISIT_ACTION and 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. If action() != PREVISIT_ACTION, xtruncate is ignored. 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... | |
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 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... | |
virtual void | initialize_has_visited (const abstract_poset_member &xanchor) |
Initializes the has_visited markers. 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... | |
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... | |
Abstract iterator over the discretization of the property section of a field_vd. Concurrently traverses the schema of both the coordinates and property sections of a field, returning to the client at each property discretization member, with enough context to evaluate the coordinate section at the property discretization point.
Definition at line 56 of file property_disc_iterator.h.
fields::property_disc_iterator::~property_disc_iterator | ( | ) |
Destructor.
Definition at line 158 of file property_disc_iterator.cc.
References coordinates_schema().
Referenced by new_property_disc_iterator().
|
inlineprotected |
Default constructor.
Definition at line 153 of file property_disc_iterator.h.
|
inlineprotected |
Copy constructor; disabled.
Definition at line 158 of file property_disc_iterator.h.
const fiber_bundle::base_space_poset & fields::property_disc_iterator::base_space | ( | ) | const |
The base space shared by both schema.
Definition at line 212 of file property_disc_iterator.cc.
References coordinates_evaluation(), and sheaf::poset_state_handle::is_same_state().
Referenced by property_schema().
|
pure virtual |
Make a new instance of the same type as this.
Is Abstract.
Reimplemented from sheaf::depth_first_iterator.
Implemented in fields::property_disc_iterator_1_3, fields::property_disc_iterator_1_2, fields::property_disc_iterator_4_3, fields::property_disc_iterator_4_2, and fields::property_disc_iterator_1_1.
Definition at line 578 of file property_disc_iterator.cc.
References invariant().
Referenced by is_ancestor_of().
const sheaf::block< fiber_bundle::discretization_context > & fields::property_disc_iterator::coordinate_discretization_members | ( | ) | const |
The coordinate discretization members in the downset of the current evaluation member.
Definition at line 388 of file property_disc_iterator.cc.
References property_discretization_members().
Referenced by property_evaluator().
fiber_bundle::section_evaluator & fields::property_disc_iterator::coordinate_evaluator | ( | ) | const |
The coordinate field evaluator associated with the current evaluation member.
Definition at line 340 of file property_disc_iterator.cc.
References property_evaluator().
Referenced by type_name().
const sheaf::subposet & fields::property_disc_iterator::coordinates_evaluation | ( | ) | const |
The evaluation subposet for the coordinates.
Definition at line 234 of file property_disc_iterator.cc.
References sheaf::poset_component::is_same_state(), and property_evaluation().
Referenced by base_space().
const fiber_bundle::section_space_schema_member & fields::property_disc_iterator::coordinates_schema | ( | ) | const |
The coordinates field schema member which is being iterated over.
Definition at line 170 of file property_disc_iterator.cc.
References property_schema(), and sheaf::total_poset_member::schema().
Referenced by fields::property_disc_iterator_1_1::clone(), fields::property_disc_iterator_1_1::get_prop_disc_values(), fields::property_disc_iterator_1_1::invariant(), new_property_disc_iterator(), fields::field_vd::new_property_disc_iterator(), fields::property_disc_iterator_1_1::property_disc_iterator_1_1(), and ~property_disc_iterator().
int fields::property_disc_iterator::db | ( | ) | const |
The dimension of the current evaluation member.
Definition at line 272 of file property_disc_iterator.cc.
References type_id().
Referenced by property_evaluation().
|
virtual |
Force the iterator to be done.
Reimplemented from sheaf::depth_first_iterator.
Definition at line 639 of file property_disc_iterator.cc.
Referenced by invariant().
|
pure virtual |
The gets the values of xsec at the property discretization points.
Implemented in fields::property_disc_iterator_1_3, fields::property_disc_iterator_1_2, fields::property_disc_iterator_4_3, fields::property_disc_iterator_4_2, and fields::property_disc_iterator_1_1.
Definition at line 429 of file property_disc_iterator.cc.
References fiber_bundle::section_space_schema_member::df(), initialize_iteration(), sheaf::poset_component::is_same_state(), fiber_bundle::sec_rep_space_member::schema(), and sheaf::read_write_monitor_handle::state_is_read_accessible().
Referenced by fields::base_space_map::base_space_map(), property_discretization_members(), fields::field_vd::put_property_dofs(), fields::body_pusher::same_fiber(), and fields::section_pusher::section_pusher().
|
protected |
Initializes this for iteration of type xorder over the schema of xfield.
Definition at line 457 of file property_disc_iterator.cc.
References fields::field_vd::base_space(), fiber_bundle::section_space_schema_member::base_space(), sheaf::schema_poset_member::conforms_to(), fields::field_vd::coordinates(), sheaf::abstract_poset_member::le(), fields::field_vd::property(), sheaf::total_poset_member::schema(), fiber_bundle::sec_rep_space_member::schema(), fields::field_vd::state_is_read_accessible(), and sheaf::poset_component::version().
Referenced by get_prop_disc_values(), and fields::property_disc_iterator_1_1::property_disc_iterator_1_1().
|
protected |
Initializes this for iteration of type xorder over xcoordinates_schema and xproperty_schema.
Definition at line 505 of file property_disc_iterator.cc.
References fiber_bundle::section_space_schema_member::base_space(), sheaf::schema_poset_member::conforms_to(), is_ancestor_of(), sheaf::abstract_poset_member::le(), sheaf::total_poset_member::schema(), sheaf::read_write_monitor_handle::state_is_read_accessible(), and sheaf::poset_component::version().
|
virtual |
The class invariant.
Reimplemented from sheaf::any.
Reimplemented in fields::property_disc_iterator_1_3, fields::property_disc_iterator_1_2, fields::property_disc_iterator_4_3, fields::property_disc_iterator_4_2, and fields::property_disc_iterator_1_1.
Definition at line 600 of file property_disc_iterator.cc.
References force_is_done().
Referenced by clone(), and fields::property_disc_iterator_1_1::invariant().
|
virtual |
True if other conforms to this.
Reimplemented from sheaf::depth_first_iterator.
Reimplemented in fields::property_disc_iterator_1_3, fields::property_disc_iterator_1_2, fields::property_disc_iterator_4_3, fields::property_disc_iterator_4_2, and fields::property_disc_iterator_1_1.
Definition at line 561 of file property_disc_iterator.cc.
References clone().
Referenced by initialize_iteration().
|
static |
Creates an iterator appropriate for xcoords and xprop.
Definition at line 60 of file property_disc_iterator.cc.
References coordinates_schema(), fiber_bundle::sec_rep_descriptor::eval_is_above_disc(), fiber_bundle::section_space_schema_member::evaluation(), fiber_bundle::section_space_schema_member::evaluator_family_name(), sheaf::poset_component::is_same_state(), sheaf::subposet::name(), sheaf::abstract_poset_member::name(), property_schema(), fiber_bundle::section_space_schema_member::rep(), sheaf::read_write_monitor_handle::state_is_read_accessible(), and ~property_disc_iterator().
Referenced by fields::base_space_map::base_space_map(), fields::field_vd::new_property_disc_iterator(), and fields::field_vd::put_property_dofs().
const sheaf::block< fiber_bundle::discretization_context > & fields::property_disc_iterator::property_discretization_members | ( | ) | const |
The property discretization members in the downset of the current evaluation member.
Definition at line 408 of file property_disc_iterator.cc.
References get_prop_disc_values().
Referenced by fields::base_space_map::base_space_map(), coordinate_discretization_members(), fields::field_vd::put_property_dofs(), fields::body_pusher::same_fiber(), and fields::section_pusher::section_pusher().
const sheaf::subposet & fields::property_disc_iterator::property_evaluation | ( | ) | const |
The evaluation subposet for the property.
Definition at line 253 of file property_disc_iterator.cc.
References db(), and sheaf::poset_component::is_same_state().
Referenced by coordinates_evaluation().
fiber_bundle::section_evaluator & fields::property_disc_iterator::property_evaluator | ( | ) | const |
The property field evaluator associated with the current evaluation member.
Definition at line 364 of file property_disc_iterator.cc.
References coordinate_discretization_members().
Referenced by coordinate_evaluator().
const fiber_bundle::section_space_schema_member & fields::property_disc_iterator::property_schema | ( | ) | const |
The property field schema member which is being iterated over.
Definition at line 191 of file property_disc_iterator.cc.
References base_space(), and sheaf::total_poset_member::schema().
Referenced by fields::property_disc_iterator_1_1::clone(), coordinates_schema(), fields::property_disc_iterator_1_1::invariant(), new_property_disc_iterator(), fields::field_vd::new_property_disc_iterator(), and fields::property_disc_iterator_1_1::property_disc_iterator_1_1().
sheaf::pod_index_type fields::property_disc_iterator::type_id | ( | ) | const |
The type id of the current member.
Definition at line 295 of file property_disc_iterator.cc.
References type_name().
Referenced by db().
std::string fields::property_disc_iterator::type_name | ( | ) | const |
The type name of the current member.
Definition at line 317 of file property_disc_iterator.cc.
References coordinate_evaluator().
Referenced by type_id().
|
protected |
True if current iteration is above the subposet associated with the flag.
Definition at line 214 of file property_disc_iterator.h.
|
protected |
True if current iteration is a member of the subposet associated with the flag.
Definition at line 208 of file property_disc_iterator.h.
|
protected |
Descriptor for coordinate section iteration.
Definition at line 176 of file property_disc_iterator.h.
|
protected |
Descriptor for property section iteration.
Definition at line 181 of file property_disc_iterator.h.
Referenced by fields::property_disc_iterator_1_1::get_prop_disc_values(), and fields::property_disc_iterator_1_1::next().