An implementation of index_space_collection for a sparse collection of explicit id spaces. More...

#include <explicit_index_space_collection.h>

Inheritance diagram for sheaf::explicit_index_space_collection:

Friends
class	index_space_family

EXPLICIT_INDEX_SPACE_COLLECTION FACET
typedef unordered::unordered_map< pod_type, explicit_index_space_state * >	map_type
	The type of explicit id space map. More...

map_type	_states
	The map from space id to explicit id space. More...

virtual	~explicit_index_space_collection ()
	Creates an arg list for constructing an instance of this. More...

size_type	capacity () const
	The capacity of this collection. More...

void	insert (explicit_index_space_state &xid_space)
	Insert the explicit id space xid_space into this interval. More...

	explicit_index_space_collection ()
	Default constructor. More...

	explicit_index_space_collection (const explicit_index_space_collection &xother)
	Copy constructor; disabled. More...

INDEX_SPACE_COLLECTION FACET
virtual bool	operator== (const index_space_collection &xother) const
	True if this is equivalent to xother. More...

virtual bool	contains (pod_type xlocal_id) const
	True if this collection contains the id space with local id xlocal_id. More...

virtual bool	contains_family (pod_type xspace_id) const
	True if this collection contains the id space with family id xspace_id. More...

virtual pod_type	local_scope (pod_type xspace_id) const
	Id relative to this collection equivalent to the id space family id xspace_id. More...

virtual pod_type	family_scope (pod_type xlocal_id) const
	Id relative to the id space family equivalent to the local id xlocal_id. More...

virtual explicit_index_space_collection &	operator= (const index_space_collection &xother)
	Assignment operator. More...

virtual explicit_index_space_state *	explicit_state (pod_type xlocal_id) const
	The explicit id space state for id xlocal_id. Returns null if there is no explicit id space for xlocal_id. More...

INDEX SPACE FACET
index_space_family *	_id_spaces
	The index space family of this collection. More...

virtual const index_space_family &	id_spaces () const
	The id space family for this (const version). More...

virtual index_space_family &	id_spaces ()
	The id space family for this (mutable version). More...

virtual void	remove (pod_type xlocal_id)
	Remove the id space with id xlocal_id. More...

virtual size_type	ct (pod_type xlocal_id) const
	The number of members for the id space with id xlocal_id. More...

virtual pod_type	begin (pod_type xlocal_id) const
	Beginning id of the space with id xlocal_id. More...

virtual pod_type	end (pod_type xlocal_id) const
	Ending id of the space with id xlocal_id. More...

virtual bool	contains (pod_type xlocal_id, pod_type xid) const
	True if the space with id xlocal_id contains id xid. More...

virtual bool	contains_unglued_hub (pod_type xlocal_id, pod_type xid) const
	True if the space with id xlocal_id contains an id equivalent to xid in the unglued hub id space. More...

virtual bool	contains (pod_type xlocal_id, pod_type xid, pod_type xhub_id) const
	True if the space with id xlocal_id contains an id xid equivalent to xhub_id in the hub id space. More...

virtual pod_type	pod (pod_type xlocal_id, pod_type xid) const
	The pod index in the space with id xlocal_id equivalent to xid in the hub id space. More...

virtual pod_type	unglued_hub_pod (pod_type xlocal_id, pod_type xid) const
	The pod index in the unglued hub id space equivalent to xid in the id space with id xlocal_id. More...

virtual bool	is_persistent (pod_type xlocal_id) const
	True if the id space with id xlocal_id should be written to disk. More...

PRODUCT STRUCTURE FACET
virtual void	new_product_structure (pod_type xlocal_id, const abstract_product_structure &xproduct)
	Creates a new product structure for the id space with id xlocal_id by cloning the product structure, xproduct. More...

virtual void	delete_product_structure (pod_type xlocal_id)
	Deletes the product structure for the id space with id xlocal_id. More...

virtual const abstract_product_structure &	product_structure (pod_type xlocal_id) const
	The product structure for the id space with id xlocal_id (const version). More...

virtual abstract_product_structure &	product_structure (pod_type xlocal_id)
	The product structure for the id space with id xlocal_id (mutable version). More...

virtual bool	has_product_structure (pod_type xlocal_id) const
	True if the id space with id xlocal_id has a product structure. More...

HANDLE POOL FACET
virtual index_space_handle &	get_id_space (pod_type xlocal_id) const
	Allocates an id space handle from the handle pool attached to state with id xlocal_id. More...

virtual void	release_id_space (index_space_handle &xid_space) const
	Returns the id space handle xid_space to the handle pool. More...

virtual bool	allocated_id_space (const index_space_handle &xid_space) const
	True if and only if id space handle xid_space was allocated by the handle pool. More...

ITERATOR POOL FACET
virtual index_space_iterator &	get_id_space_iterator (pod_type xlocal_id) const
	Allocates an id space iterator from the iterator pool attached to state with id xlocal_id. More...

virtual void	release_id_space_iterator (index_space_iterator &xitr) const
	Returns the id space iterator xitr to the iterator pool. More...

virtual bool	allocated_id_space_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_collection
typedef pod_index_type	pod_type
	The "plain old data" index type for this. More...

Public Member Functions inherited from sheaf::index_space_collection
virtual	~index_space_collection ()
	Destructor. More...

virtual bool	contains (pod_type xlocal_id) const =0
	True if this collection contains the id space with local id xlocal_id. More...

virtual bool	contains_family (pod_type xspace_id) const =0
	True if this collection contains the id space with family id xspace_id. More...

virtual pod_type	local_scope (pod_type xspace_id) const =0
	Id relative to this collection equivalent to the id space family id xspace_id. More...

virtual pod_type	family_scope (pod_type xlocal_id) const =0
	Id relative to the id space family equivalent to the local id xlocal_id. More...

virtual size_type	deep_size (bool xinclude_shallow) const =0
	The deep size of this. More...

const hub_index_space_handle &	hub_id_space () const
	The hub id space. More...

virtual void	remove (pod_type xlocal_id)=0
	Remove the id space with id xlocal_id. More...

virtual size_type	ct (pod_type xlocal_id) const =0
	The number of members for the id space with id xlocal_id. More...

bool	is_empty (pod_type xlocal_id) const
	True if there are no ids in the space with id xlocal_id. More...

virtual pod_type	begin (pod_type xlocal_id) const =0
	Beginning id of the space with id xlocal_id. More...

virtual pod_type	end (pod_type xlocal_id) const =0
	Ending id of the space with id xlocal_id. More...

bool	is_gathered (pod_type xlocal_id) const
	True if begin(xlocal_id) == 0 and end(xlocal_id) == ct(xlocal_id). More...

virtual bool	contains (pod_type xlocal_id, pod_type xid) const =0
	True if the space with id xlocal_id contains id xid. More...

bool	contains (pod_type xlocal_id, const scoped_index &xid) const
	True if the space with id xlocal_id contains an id equivalent to xid. synonym for contains_hub(xlocal_id, xid.hub_pod()). More...

bool	contains_hub (pod_type xlocal_id, pod_type xid) const
	True if the space with id xlocal_id contains an id equivalent to xid in the hub id space. synonym for contains_unglued_hub(xlocal_id, xid) More...

virtual bool	contains_unglued_hub (pod_type xlocal_id, pod_type xid) const =0
	True if the space with id xlocal_id contains an id equivalent to xid in the unglued hub id space. More...

bool	contains_glued_hub (pod_type xlocal_id, pod_type xid) const
	True if the space with id xlocal_id contains an id equivalent to xid in the glued hub id space. More...

bool	contains (pod_type xlocal_id, pod_type xid, const scoped_index &xhub_id) const
	True if the space with id xlocal_id contains an id xid equivalent to xhub_id in the hub id space. synonym for contains(xlocal_id, xid, xhub_id.hub_pod()). More...

virtual bool	contains (pod_type xlocal_id, pod_type xid, pod_type xhub_id) const =0
	True if the space with id xlocal_id contains an id xid equivalent to xhub_id in the hub id space. More...

virtual pod_type	pod (pod_type xlocal_id, pod_type xid) const =0
	The pod index in the space with id xlocal_id equivalent to xid in the hub id space. More...

pod_type	pod (pod_type xlocal_id, const scoped_index &xid) const
	The pod index in the space with id xlocal_id equivalent to xid. synonym for pod(xlocal_id, id.hub_pod()). More...

pod_type	hub_pod (pod_type xlocal_id, pod_type xid) const
	The pod index in the glued hub id space equivalent to xid in the id space with id xlocal_id. synonym for unglued_hub_pod(xlocal_id, xid). More...

virtual pod_type	unglued_hub_pod (pod_type xlocal_id, pod_type xid) const =0
	The pod index in the glued hub id space equivalent to xid in the id space with id xlocal_id. More...

pod_type	glued_hub_pod (pod_type xlocal_id, pod_type xid) const
	The pod index in the unglued hub id space equivalent to xid in the id space with id xlocal_id. More...

virtual bool	is_persistent (pod_type xlocal_id) const =0
	True if the id space with id xlocal_id should be written to disk. More...

virtual void	new_product_structure (pod_type xlocal_id, const abstract_product_structure &xproduct)=0
	Creates a new product structure for the id space with id xlocal_id by cloning the product structure, xproduct. More...

virtual void	delete_product_structure (pod_type xlocal_id)=0
	Deletes the product structure for the id space with id xlocal_id. More...

virtual const abstract_product_structure &	product_structure (pod_type xlocal_id) const =0
	The product structure for the id space with id xlocal_id (const version). More...

virtual abstract_product_structure &	product_structure (pod_type xlocal_id)=0
	The product structure for the id space with id xlocal_id (mutable version). More...

virtual bool	has_product_structure (pod_type xlocal_id) const =0
	True if the id space with id xlocal_id has a product structure. More...

virtual index_space_handle &	get_id_space (pod_type xlocal_id) const =0
	Allocates an id space handle from the handle pool attached to state with id xlocal_id. More...

virtual index_space_iterator &	get_id_space_iterator (pod_type xlocal_id) const =0
	Allocates an id space iterator from the iterator pool attached to state with id xlocal_id. 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 *	clone () const
	Virtual constructor, makes a new instance of 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_collection
	index_space_collection ()
	Default constructor. More...

	index_space_collection (const index_space_collection &xother)
	Copy constructor; disabled. More...

virtual explicit_index_space_state *	explicit_state (pod_type xlocal_id) const =0
	The explicit id space state for id xlocal_id. Returns null if there is no explicit id space for xlocal_id. More...

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

Detailed Description

An implementation of index_space_collection for a sparse collection of explicit id spaces.

Definition at line 45 of file explicit_index_space_collection.h.

Member Typedef Documentation

◆ map_type

typedef unordered::unordered_map<pod_type, explicit_index_space_state*> sheaf::explicit_index_space_collection::map_type

protected

The type of explicit id space map.

Definition at line 86 of file explicit_index_space_collection.h.

Constructor & Destructor Documentation

◆ ~explicit_index_space_collection()

sheaf::explicit_index_space_collection::~explicit_index_space_collection ( )

virtual

Creates an arg list for constructing an instance of this.

Destructor

Definition at line 35 of file explicit_index_space_collection.cc.

References _states, and capacity().

◆ explicit_index_space_collection() [1/2]

sheaf::explicit_index_space_collection::explicit_index_space_collection ( )

protected

Default constructor.

Postcondition

invariant()

Definition at line 102 of file explicit_index_space_collection.cc.

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

Referenced by insert().

◆ explicit_index_space_collection() [2/2]

sheaf::explicit_index_space_collection::explicit_index_space_collection ( const explicit_index_space_collection & xother )

inlineprotected

Copy constructor; disabled.

Definition at line 86 of file explicit_index_space_collection.h.

Member Function Documentation

◆ allocated_id_space()

bool sheaf::explicit_index_space_collection::allocated_id_space ( const index_space_handle & xid_space ) const

virtual

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

Postcondition

is_basic_query

Implements sheaf::index_space_collection.

Definition at line 730 of file explicit_index_space_collection.cc.

References _states, get_id_space_iterator(), sheaf::index_space_handle::index(), and local_scope().

Referenced by release_id_space().

◆ allocated_id_space_iterator()

bool sheaf::explicit_index_space_collection::allocated_id_space_iterator ( const index_space_iterator & xitr ) const

virtual

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

Postcondition

is_basic_query

Implements sheaf::index_space_collection.

Definition at line 806 of file explicit_index_space_collection.cc.

References _states, sheaf::index_space_iterator::index(), is_ancestor_of(), and local_scope().

Referenced by release_id_space_iterator().

◆ begin()

sheaf::index_space_collection::pod_type sheaf::explicit_index_space_collection::begin ( pod_type xlocal_id ) const

virtual

Beginning id of the space with id xlocal_id.

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 386 of file explicit_index_space_collection.cc.

References _states, contains(), and end().

Referenced by ct().

◆ capacity()

sheaf::size_type sheaf::explicit_index_space_collection::capacity ( ) const

The capacity of this collection.

Postcondition

is_basic_query

Definition at line 58 of file explicit_index_space_collection.cc.

References _states, and insert().

Referenced by ~explicit_index_space_collection().

◆ contains() [1/3]

bool sheaf::explicit_index_space_collection::contains ( pod_type xlocal_id ) const

virtual

True if this collection contains the id space with local id xlocal_id.

Postcondition

is_basic_query

Definition at line 156 of file explicit_index_space_collection.cc.

References _states, and contains_family().

Referenced by begin(), contains(), contains_unglued_hub(), ct(), delete_product_structure(), end(), explicit_state(), family_scope(), get_id_space(), get_id_space_iterator(), has_product_structure(), insert(), is_persistent(), local_scope(), new_product_structure(), operator==(), pod(), product_structure(), remove(), and unglued_hub_pod().

◆ contains() [2/3]

bool sheaf::explicit_index_space_collection::contains	(	pod_type	xlocal_id,
		pod_type	xid
	)		const

virtual

True if the space with id xlocal_id contains id xid.

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 428 of file explicit_index_space_collection.cc.

References _states, contains(), and contains_unglued_hub().

◆ contains() [3/3]

bool sheaf::explicit_index_space_collection::contains	(	pod_type	xlocal_id,
		pod_type	xid,
		pod_type	xhub_id
	)		const

virtual

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

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 470 of file explicit_index_space_collection.cc.

References _states, contains(), and pod().

◆ contains_family()

bool sheaf::explicit_index_space_collection::contains_family ( pod_type xspace_id ) const

virtual

True if this collection contains the id space with family id xspace_id.

Postcondition

is_basic_query

Definition at line 180 of file explicit_index_space_collection.cc.

References _states, and local_scope().

Referenced by contains(), and family_scope().

◆ contains_unglued_hub()

bool sheaf::explicit_index_space_collection::contains_unglued_hub	(	pod_type	xlocal_id,
		pod_type	xid
	)		const

virtual

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

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 449 of file explicit_index_space_collection.cc.

References _states, and contains().

Referenced by contains(), and unglued_hub_pod().

◆ ct()

sheaf::size_type sheaf::explicit_index_space_collection::ct ( pod_type xlocal_id ) const

virtual

The number of members for the id space with id xlocal_id.

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 365 of file explicit_index_space_collection.cc.

References _states, begin(), and contains().

Referenced by remove().

◆ delete_product_structure()

void sheaf::explicit_index_space_collection::delete_product_structure ( pod_type xlocal_id )

virtual

Deletes the product structure for the id space with id xlocal_id.

Precondition

contains(xlocal_id)

Postcondition

!has_product_structure(xlocal_id)

Definition at line 587 of file explicit_index_space_collection.cc.

References _states, contains(), has_product_structure(), and product_structure().

Referenced by new_product_structure().

◆ end()

sheaf::index_space_collection::pod_type sheaf::explicit_index_space_collection::end ( pod_type xlocal_id ) const

virtual

Ending id of the space with id xlocal_id.

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 407 of file explicit_index_space_collection.cc.

References _states, and contains().

Referenced by begin().

◆ explicit_state()

sheaf::explicit_index_space_state * sheaf::explicit_index_space_collection::explicit_state ( pod_type xlocal_id ) const

protectedvirtual

The explicit id space state for id xlocal_id. Returns null if there is no explicit id space for xlocal_id.

Postcondition

is_basic_query

Definition at line 276 of file explicit_index_space_collection.cc.

References _states, contains(), and id_spaces().

Referenced by operator=().

◆ family_scope()

sheaf::index_space_collection::pod_type sheaf::explicit_index_space_collection::family_scope ( pod_type xlocal_id ) const

virtual

Id relative to the id space family equivalent to the local id xlocal_id.

Postcondition

!is_valid(result) || contains_family(result)

Definition at line 226 of file explicit_index_space_collection.cc.

References contains(), contains_family(), sheaf::invalid_pod_index(), sheaf::is_valid(), and operator=().

Referenced by local_scope().

◆ get_id_space()

sheaf::index_space_handle & sheaf::explicit_index_space_collection::get_id_space ( pod_type xlocal_id ) const

virtual

Allocates an id space handle from the handle pool attached to state with id xlocal_id.

Precondition

contains(xlocal_id)

Postcondition

result.is_attached()

Definition at line 686 of file explicit_index_space_collection.cc.

References _states, contains(), sheaf::index_space_handle::is_attached(), and release_id_space().

Referenced by has_product_structure().

◆ get_id_space_iterator()

sheaf::index_space_iterator & sheaf::explicit_index_space_collection::get_id_space_iterator ( pod_type xlocal_id ) const

virtual

Allocates an id space iterator from the iterator pool attached to state with id xlocal_id.

Precondition

contains(xlocal_id)

Postcondition

result.is_attached()

Definition at line 763 of file explicit_index_space_collection.cc.

References _states, contains(), sheaf::index_space_iterator::is_attached(), and release_id_space_iterator().

Referenced by allocated_id_space().

◆ has_product_structure()

bool sheaf::explicit_index_space_collection::has_product_structure ( pod_type xlocal_id ) const

virtual

True if the id space with id xlocal_id has a product structure.

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 654 of file explicit_index_space_collection.cc.

References _states, contains(), and get_id_space().

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

◆ id_spaces() [1/2]

const sheaf::index_space_family & sheaf::explicit_index_space_collection::id_spaces ( ) const

virtual

The id space family for this (const version).

Postcondition

is_basic_query

Implements sheaf::index_space_collection.

Definition at line 305 of file explicit_index_space_collection.cc.

References _id_spaces.

Referenced by explicit_state().

◆ id_spaces() [2/2]

sheaf::index_space_family & sheaf::explicit_index_space_collection::id_spaces ( )

virtual

The id space family for this (mutable version).

Postcondition

is_basic_query

Implements sheaf::index_space_collection.

Definition at line 324 of file explicit_index_space_collection.cc.

References _id_spaces, and remove().

◆ insert()

void sheaf::explicit_index_space_collection::insert ( explicit_index_space_state & xid_space )

Insert the explicit id space xid_space into this interval.

Precondition

!contains(local_scope(xid_space.index()))

Postcondition

contains(local_scope(xid_space.index()))

Definition at line 77 of file explicit_index_space_collection.cc.

References _states, contains(), explicit_index_space_collection(), sheaf::explicit_index_space_state::index(), and local_scope().

Referenced by capacity().

◆ invariant()

bool sheaf::explicit_index_space_collection::invariant ( ) const

virtual

Class invariant.

Invariant

index_space_collection::invariant()

Reimplemented from sheaf::index_space_collection.

Definition at line 860 of file explicit_index_space_collection.cc.

References sheaf::deep_size(), sheaf::any::disable_invariant_check(), sheaf::any::enable_invariant_check(), sheaf::index_space_collection::invariant(), and sheaf::any::invariant_check().

Referenced by explicit_index_space_collection(), is_ancestor_of(), and operator=().

◆ is_ancestor_of()

bool sheaf::explicit_index_space_collection::is_ancestor_of ( const any * other ) const

virtual

Conformance test; true if other conforms to this.

Precondition

other != 0

Reimplemented from sheaf::index_space_collection.

Definition at line 839 of file explicit_index_space_collection.cc.

References invariant().

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

◆ is_persistent()

bool sheaf::explicit_index_space_collection::is_persistent ( pod_type xlocal_id ) const

virtual

True if the id space with id xlocal_id should be written to disk.

Precondition

contains(xlocal_id)

Postcondition

is_basic_query

Definition at line 533 of file explicit_index_space_collection.cc.

References _states, contains(), and new_product_structure().

Referenced by unglued_hub_pod().

◆ local_scope()

sheaf::index_space_collection::pod_type sheaf::explicit_index_space_collection::local_scope ( pod_type xspace_id ) const

virtual

Id relative to this collection equivalent to the id space family id xspace_id.

Postcondition

!is_valid(result) || contains(result)

Definition at line 204 of file explicit_index_space_collection.cc.

References contains(), family_scope(), sheaf::invalid_pod_index(), and sheaf::is_valid().

Referenced by allocated_id_space(), allocated_id_space_iterator(), contains_family(), insert(), release_id_space(), and release_id_space_iterator().

◆ new_product_structure()

void sheaf::explicit_index_space_collection::new_product_structure	(	pod_type	xlocal_id,
		const abstract_product_structure &	xproduct
	)

virtual

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

Precondition

contains(xlocal_id)

Postcondition

has_product_structure(xlocal_id)

Definition at line 565 of file explicit_index_space_collection.cc.

References _states, contains(), delete_product_structure(), and has_product_structure().

Referenced by is_persistent().

◆ operator=()

sheaf::explicit_index_space_collection & sheaf::explicit_index_space_collection::operator= ( const index_space_collection & xother )

protectedvirtual

Assignment operator.

Precondition

is_ancestor_of(&xother)

Postcondition

invariant()

(*this) == xother

Implements sheaf::index_space_collection.

Definition at line 250 of file explicit_index_space_collection.cc.

References _id_spaces, _states, explicit_state(), invariant(), and is_ancestor_of().

Referenced by family_scope().

◆ operator==()

bool sheaf::explicit_index_space_collection::operator== ( const index_space_collection & xother ) const

virtual

True if this is equivalent to xother.

Precondition

is_ancestor_of(&xother)

Error:: Since we still support tr1 unordered_maps the comparison operator may not be supported. See COM-374.

Implements sheaf::index_space_collection.

Definition at line 129 of file explicit_index_space_collection.cc.

References _id_spaces, contains(), and is_ancestor_of().

Referenced by explicit_index_space_collection().

◆ pod()

sheaf::index_space_collection::pod_type sheaf::explicit_index_space_collection::pod	(	pod_type	xlocal_id,
		pod_type	xid
	)		const

virtual

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

Precondition

contains(xlocal_id)

Postcondition

!is_valid(result) || contains(xlocal_id, result)

Definition at line 491 of file explicit_index_space_collection.cc.

References _states, contains(), sheaf::is_valid(), and unglued_hub_pod().

Referenced by contains().

◆ product_structure() [1/2]

const sheaf::abstract_product_structure & sheaf::explicit_index_space_collection::product_structure ( pod_type xlocal_id ) const

virtual

The product structure for the id space with id xlocal_id (const version).

Precondition

contains(xlocal_id)

has_product_structure(xlocal_id)

Postcondition

is_basic_query

Definition at line 608 of file explicit_index_space_collection.cc.

References _states, contains(), and has_product_structure().

Referenced by delete_product_structure().

◆ product_structure() [2/2]

sheaf::abstract_product_structure & sheaf::explicit_index_space_collection::product_structure ( pod_type xlocal_id )

virtual

The product structure for the id space with id xlocal_id (mutable version).

Precondition

contains(xlocal_id)

has_product_structure(xlocal_id)

Postcondition

is_basic_query

Definition at line 631 of file explicit_index_space_collection.cc.

References _states, contains(), and has_product_structure().

◆ release_id_space()

void sheaf::explicit_index_space_collection::release_id_space ( index_space_handle & xid_space ) const

virtual

Returns the id space handle xid_space to the handle pool.

Precondition

allocated_id_space(xid_space)

Postcondition

is_basic_query

Implements sheaf::index_space_collection.

Definition at line 708 of file explicit_index_space_collection.cc.

References _states, allocated_id_space(), sheaf::index_space_handle::index(), and local_scope().

Referenced by get_id_space().

◆ release_id_space_iterator()

void sheaf::explicit_index_space_collection::release_id_space_iterator ( index_space_iterator & xitr ) const

virtual

Returns the id space iterator xitr to the iterator pool.

Precondition

allocated_id_space_iterator(xitr)

Postcondition

is_basic_query

Implements sheaf::index_space_collection.

Definition at line 785 of file explicit_index_space_collection.cc.

References _states, allocated_id_space_iterator(), sheaf::index_space_iterator::index(), and local_scope().

Referenced by get_id_space_iterator().

◆ remove()

void sheaf::explicit_index_space_collection::remove ( pod_type xlocal_id )

virtual

Remove the id space with id xlocal_id.

Postcondition

!contains(xlocal_id)

Definition at line 343 of file explicit_index_space_collection.cc.

References _states, contains(), and ct().

Referenced by id_spaces().

◆ unglued_hub_pod()

sheaf::index_space_collection::pod_type sheaf::explicit_index_space_collection::unglued_hub_pod	(	pod_type	xlocal_id,
		pod_type	xid
	)		const

virtual

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

Precondition

contains(xlocal_id)

Postcondition

!is_valid(result) || contains_unglued_hub(xlocal_id, result)

Definition at line 512 of file explicit_index_space_collection.cc.

References _states, contains(), contains_unglued_hub(), is_persistent(), and sheaf::is_valid().

Referenced by pod().

Member Data Documentation

◆ _id_spaces

index_space_family* sheaf::explicit_index_space_collection::_id_spaces

protected

The index space family of this collection.

Definition at line 229 of file explicit_index_space_collection.h.

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

◆ _states

map_type sheaf::explicit_index_space_collection::_states

protected

The map from space id to explicit id space.

Definition at line 96 of file explicit_index_space_collection.h.

Referenced by allocated_id_space(), allocated_id_space_iterator(), begin(), capacity(), contains(), contains_family(), contains_unglued_hub(), ct(), delete_product_structure(), end(), explicit_state(), get_id_space(), get_id_space_iterator(), has_product_structure(), insert(), is_persistent(), new_product_structure(), operator=(), pod(), product_structure(), release_id_space(), release_id_space_iterator(), remove(), unglued_hub_pod(), and ~explicit_index_space_collection().

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

Friends

EXPLICIT_INDEX_SPACE_COLLECTION FACET

INDEX_SPACE_COLLECTION FACET

INDEX SPACE FACET

PRODUCT STRUCTURE FACET

HANDLE POOL FACET

ITERATOR POOL FACET

ANY FACET

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ map_type

Constructor & Destructor Documentation

◆ ~explicit_index_space_collection()

◆ explicit_index_space_collection() [1/2]

◆ explicit_index_space_collection() [2/2]

Member Function Documentation

◆ allocated_id_space()

◆ allocated_id_space_iterator()

◆ begin()

◆ capacity()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ contains_family()

◆ contains_unglued_hub()

◆ ct()

◆ delete_product_structure()

◆ end()

◆ explicit_state()

◆ family_scope()

◆ get_id_space()

◆ get_id_space_iterator()

◆ has_product_structure()

◆ id_spaces() [1/2]

◆ id_spaces() [2/2]

◆ insert()

◆ invariant()

◆ is_ancestor_of()

◆ is_persistent()

◆ local_scope()

◆ new_product_structure()

◆ operator=()

◆ operator==()

◆ pod()

◆ product_structure() [1/2]

◆ product_structure() [2/2]

◆ release_id_space()

◆ release_id_space_iterator()

◆ remove()

◆ unglued_hub_pod()

Member Data Documentation

◆ _id_spaces

◆ _states