An list implementation of class gathered_insertion_index_space_state. This representation is intended to efficiently represent id spaces that are gathered, that is, the domain ids are in the domain [0, end()). This representation is optimized for sequential access and will have linear asymptotic performance in time for random access lookup and remove. More...

#include <list_index_space_state.h>

Inheritance diagram for sheaf::list_index_space_state:

Public Member Functions
virtual const std::string &	class_name () const
	The name of this class. More...

virtual list_index_space_state *	clone () const
	Virtual constructor; create a new instance of the same type at this. More...

Public Member Functions inherited from sheaf::gathered_insertion_index_space_state
void	push_back (const scoped_index &xhub_id)
	Make the next id in this space equivalent to xhub_id in the hub id space. synonym for push_back(xhub_id.hub_pod()). More...

void	push_back (pod_type xid)
	Make the next id in this space equivalent to xhub_id in the hub id space. More...

void	push (index_space_iterator &xitr, const scoped_index &xhub_id)
	Makes id xitr.id() in this id space equivalent to xhub_id in the hub id space. Increments all ids greater than xitr.id() by one, if any. Xitr will be set to the entry with id, xitr.id()+1. synonym for push(xitr, xhub_id.pod()). More...

void	push (index_space_iterator &xitr, pod_type xhub_id)
	Makes id xitr.id() in this id space equivalent to xhub_id in the hub id space. Increments all ids greater than xitr.id() if any by one. Xitr will be set to the entry with id xitr.id()+1. More...

pod_type	next_id () const
	The id inserted by the next call to push_back. More...

size_type	remove (const scoped_index &xid, bool update_extrema)
	Removes the equivalence associated with xid.hub_pod(). synonym for remove_hub(xid.hub_pod(), xupdate_extrema). Returns the number of entries actually removed, either 0 or 1. More...

size_type	remove (pod_type xid, bool update_extrema)
	Removes the equivalence associated with id xid. Returns the number of entries actually removed, either 0 or 1. More...

size_type	remove_hub (pod_type xhub_id, bool update_extrema)
	Removes the equivalence associated with hub id xhub_id. Returns the number of entries actually removed, either 0 or 1. More...

void	remove (index_space_iterator &xitr, bool update_extrema)
	Removes the equivalence associated with id xitr.pod(). Increments xitr to the next entry if any. More...

void	gather ()
	Gathers this id space into a 0-based, contiguous interval. More...

void	clear ()
	Delete all ids. More...

void	put_is_persistent (bool xis_persistent)
	Set if this id space should be written to disk. More...

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

const index_space_collection &	host () const
	The host collection (const version). More...

index_space_collection &	host ()
	The host collection (mutable version). More...

pod_type	index () const
	The index of this id space. More...

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

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

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

size_type	ct () const
	The number of members. More...

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

pod_type	begin () const
	Beginning id of this space. More...

pod_type	end () const
	Ending id of this space. More...

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

virtual bool	contains (pod_type xid) const =0
	True if this space contains id xid. More...

bool	contains (const scoped_index &xid) const
	True if this space contains an id equivalent to xid. synonym for contains_hub(xid.hub_pod()). More...

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

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

virtual bool	contains_glued_hub (pod_type xid) const
	True if this space contains an id equivalent to xid in the hub id space. More...

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

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

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

pod_type	pod (const scoped_index &xid) const
	The pod index in this space equivalent to xid. synonym for pod(xid.hub_pod()). More...

pod_type	hub_pod (pod_type xid) const
	The pod index in the unglued hub id space equivalent to xid in this id space. synonym for unglued_hub_pod(xid). More...

virtual pod_type	unglued_hub_pod (pod_type xid) const =0
	The pod index in the unglued hub id space equivalent to xid in this id space. More...

virtual pod_type	glued_hub_pod (pod_type xid) const
	The pod index in the glued hub id space equivalent to xid in this id space. More...

bool	is_persistent () const
	True if this id space should be written to disk. More...

virtual void	new_product_structure (const abstract_product_structure &xproduct)
	Creates a new product structure for this id space by cloning the product structure, xproduct. More...

virtual void	delete_product_structure ()
	Deletes the product structure for this id space. More...

const abstract_product_structure &	product_structure () const
	The product structure for this id space (const version). More...

abstract_product_structure &	product_structure ()
	The product structure for this id space (mutable version). More...

bool	has_product_structure () const
	True if this id space has a product structure. 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...

Friends
class	list_index_space_iterator

class	namespace_poset

SHEAF_DLL_SPEC size_t	deep_size (const list_index_space_state &xn, bool xinclude_shallow)
	The deep size of list_index_space_state& xn. More...

SPACE FACTORY FACET
static list_index_space_handle	new_space (index_space_family &xid_spaces, const std::string &xname, bool xis_persistent)
	Create a new list id space in the id space family xid_space at the next available id space index with name xname, and persistence xis_persistent. Returns a handle to the id space created. More...

static list_index_space_handle	new_space (index_space_family &xid_spaces, pod_type xid, const std::string &xname, bool xis_persistent)
	Create a new list id space in the id space family xid_space at the id space index xid with name xname, and persistence xis_persistent. Returns a handle to the id space created. More...

LIST_INDEX_SPACE_STATE FACET
void	reverse (bool xupdate_extrema)
	Reverse the order, for instance hub_pod(new 0) = hub_pod(old last);. More...

pod_type	front () const
	The front of the list used to represent this id space; equivalent to hub_pod(begin()). More...

pod_type	back () const
	The back of the list used to represent this id space; equivalent to hub_pod(last id). More...

void	push_front (pod_type xhub_id)
	Pushes hub id xhub_id onto the front of the list used to represent this id space; increments the domain ids of all existing members. More...

void	replace_range_id (pod_type xold_range_id, pod_type xnew_range_id)
	Replaces xold_range_id with xnew_range_id. More...

	list_index_space_state ()
	Default constructor. More...

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

virtual	~list_index_space_state ()
	Destructor. More...

GATHERED_INSERTION INDEX SPACE FACET
virtual void	update_extrema ()
	Update the id extrema. More...

virtual void	reserve (size_type xcapacity)
	Reserve enough memory for xcapacity number of ids. More...

virtual size_type	capacity () const
	The number of ids reserved in memory. More...

MAP REPRESENTATION FACET
typedef std::list< pod_type >	to_range_type
	The type of the domain id to range id map. More...

to_range_type	_to_range
	The representation of the domain id to range id map. More...

pod_type	_capacity
	The capacity of this map. More...

to_range_type &	to_range ()
	The representation of the domain id to range id map. Warning: direct manipulation of the to_range map can invalid the state of the index space, make sure to invoke update_extrema_after_remove() before using the rest of the index space interface. More...

const to_range_type &	to_range () const
	The representation of the domain id to range id map, const version. Warning: direct manipulation of the to_range map can invalid the state of the index space, make sure to invoke update_extrema_after_remove() before using the rest of the index space interface. More...

virtual void	map_rep_push_back (pod_type xrange_id)
	Inserts entry (next_id(), xrange_id) into the map representation. More...

virtual void	map_rep_push (index_space_iterator &xitr, pod_type xrange_id)
	Inserts entry (xitr.pod(), xrange_id) into the map representation. Increments all domain ids greater than xitr.pod() by one. Sets xitr to the entry at xitr.pod()+1. More...

virtual size_type	map_rep_remove_entry (pod_type xid, bool xis_range_id)
	Removes the entry containing range id xid (xis_range_id true) or domain id xid (xis_range_id false) from the map representation; returns the number of entries actully removed, either 0 or 1. More...

virtual void	map_rep_remove_entry (index_space_iterator &xitr)
	Removes the equivalence associated with id xitr.pod()/ Increments xitr to the next entry if any. More...

virtual void	map_rep_clear ()
	Removes all entrires from the map representation. More...

virtual void	map_rep_gather ()
	Gathers the map representation into an interval. More...

to_range_type::iterator	to_range_itr (pod_type xid, bool xis_range_id)
	An iterator pointing to the _to_range entry with range id (xis_range_id true) or domain id (xis_range_id false) xid. More...

to_range_type::const_iterator	to_range_const_itr (pod_type xid, bool xis_range_id) const
	A const_iterator pointing to the _to_range entry with range id (xis_range_id true) or domain id (xis_range_id false) xid. More...

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

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

virtual list_index_space_state &	operator= (const explicit_index_space_state &xother)
	Assignment operator. More...

INDEX SPACE FACET
virtual bool	contains (pod_type xid) const
	True if this space contains id xid. More...

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

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

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

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

HANDLE POOL FACET
static size_type	handle_pool_ct ()
	The number of handles in the pool. More...

static size_type	handle_pool_deep_size ()
	The deep size of the handle pool. More...

virtual index_space_handle &	get_id_space () const
	The id space handle with this state. More...

virtual void	release_id_space (index_space_handle &xid_space) const
	Release the id space handle xid_space. 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
static size_type	iterator_pool_ct ()
	The number of iterators in the pool. More...

static size_type	iterator_pool_deep_size ()
	The deep size of the iterator pool. More...

virtual index_space_iterator &	get_iterator () const
	Allocates an id space iterator from the iterator pool. More...

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

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

Static Public Member Functions inherited from sheaf::explicit_index_space_state
static factory< explicit_index_space_state > &	id_space_factory ()
	A factory for making descendants of this class. More...

Protected Member Functions inherited from sheaf::gathered_insertion_index_space_state
	gathered_insertion_index_space_state ()
	Default constructor. More...

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

virtual	~gathered_insertion_index_space_state ()
	Destructor. More...

virtual void	update_extrema_after_remove ()
	Update the id extrema after a remove operation. More...

void	update_extrema (pod_type xid)
	Update the extrema for the inserted id xid. More...

virtual void	map_rep_push_back (pod_type xrange_id)=0
	Inserts entry (next_id(), xrange_id) into the map representation. More...

virtual void	map_rep_push (index_space_iterator &xitr, pod_type xrange_id)=0
	Inserts entry (xitr.pod(), xrange_id) into the map representation. Increments all domain ids greater than xitr.pod() by one. Sets xitr to the entry at xitr.pod()+1. More...

virtual size_type	map_rep_remove_entry (pod_type xid, bool xis_range_id)=0
	Removes the entry containing range id xid (xis_range_id true) or domain id xid (xis_range_id false) from the map representation; returns the number of entries actully removed, either 0 or 1. More...

Protected Member Functions inherited from sheaf::explicit_index_space_state
	explicit_index_space_state ()
	Default constructor. More...

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

void	new_state (index_space_family &xid_spaces, const std::string &xname, bool xis_persistent)
	Create a new id space state in the id space family xid_spaces at the next available id space index with name xname, and persistence xis_persistent. More...

void	new_state (index_space_family &xid_spaces, pod_type xid, const std::string &xname, bool xis_persistent)
	Create a new id space state in the id space family xid_spaces at the id space index xid with name xname, and persistence xis_persistent. More...

void	invalidate_extrema ()
	Invalidate the extrema. More...

void	attach (explicit_index_space_handle &xid_space) const
	Attach the id space handle xid_space to this state. More...

void	attach (explicit_index_space_iterator &xitr) const
	Attach the id space iterator xitr to this state. More...

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

Protected Attributes inherited from sheaf::explicit_index_space_state
index_space_collection *	_host
	The host collection. More...

pod_type	_index
	The index of this id space. More...

size_type	_ct
	The number of members. More...

pod_type	_begin
	Beginning id of this space. More...

pod_type	_end
	Ending id of this space. More...

bool	_is_persistent
	True if this id space should be written to disk. More...

abstract_product_structure *	_product
	The product structure for this id space. More...

Detailed Description

An list implementation of class gathered_insertion_index_space_state. This representation is intended to efficiently represent id spaces that are gathered, that is, the domain ids are in the domain [0, end()). This representation is optimized for sequential access and will have linear asymptotic performance in time for random access lookup and remove.

Definition at line 60 of file list_index_space_state.h.

Member Typedef Documentation

◆ to_range_type

typedef std::list<pod_type> sheaf::list_index_space_state::to_range_type

The type of the domain id to range id map.

Definition at line 201 of file list_index_space_state.h.

Constructor & Destructor Documentation

◆ list_index_space_state() [1/2]

sheaf::list_index_space_state::list_index_space_state ( )

protected

Default constructor.

Postcondition

invariant()

is_empty()

capacity() == 0

Definition at line 244 of file list_index_space_state.cc.

References _capacity, capacity(), invariant(), sheaf::explicit_index_space_state::is_empty(), and ~list_index_space_state().

Referenced by clone(), new_space(), and replace_range_id().

◆ list_index_space_state() [2/2]

sheaf::list_index_space_state::list_index_space_state ( const list_index_space_state & xother )

inlineprotected

Copy constructor; disabled.

Definition at line 147 of file list_index_space_state.h.

References sheaf::gathered_insertion_index_space_state::update_extrema().

◆ ~list_index_space_state()

sheaf::list_index_space_state::~list_index_space_state ( )

protectedvirtual

Destructor.

Definition at line 265 of file list_index_space_state.cc.

References update_extrema().

Referenced by list_index_space_state().

Member Function Documentation

◆ allocated_id_space()

bool sheaf::list_index_space_state::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::explicit_index_space_state.

Definition at line 1124 of file list_index_space_state.cc.

References iterator_pool_ct().

Referenced by release_id_space().

◆ allocated_iterator()

bool sheaf::list_index_space_state::allocated_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::explicit_index_space_state.

Definition at line 1261 of file list_index_space_state.cc.

References class_name().

Referenced by map_rep_push(), map_rep_remove_entry(), and release_iterator().

◆ back()

sheaf::list_index_space_state::pod_type sheaf::list_index_space_state::back ( ) const

The back of the list used to represent this id space; equivalent to hub_pod(last id).

Definition at line 150 of file list_index_space_state.cc.

References _to_range, and push_front().

Referenced by sheaf::list_index_space_handle::back(), and front().

◆ capacity()

sheaf::size_type sheaf::list_index_space_state::capacity ( ) const

virtual

The number of ids reserved in memory.

Postcondition

is_basic_query

Implements sheaf::gathered_insertion_index_space_state.

Definition at line 343 of file list_index_space_state.cc.

References _capacity, and to_range().

Referenced by list_index_space_state(), and reserve().

◆ class_name()

const std::string & sheaf::list_index_space_state::class_name ( ) const

virtual

The name of this class.

Reimplemented from sheaf::gathered_insertion_index_space_state.

Definition at line 1313 of file list_index_space_state.cc.

References clone().

Referenced by allocated_iterator().

◆ clone()

sheaf::list_index_space_state * sheaf::list_index_space_state::clone ( ) const

virtual

Virtual constructor; create a new instance of the same type at this.

Postcondition

result != 0

is_same_type(result)

Implements sheaf::explicit_index_space_state.

Definition at line 1321 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::id_space_factory(), is_ancestor_of(), sheaf::any::is_same_type(), and list_index_space_state().

Referenced by class_name().

◆ contains() [1/2]

bool sheaf::list_index_space_state::contains ( pod_type xid ) const

virtual

True if this space contains id xid.

Postcondition

is_basic_query

Definition at line 854 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::_begin, sheaf::explicit_index_space_state::_end, contains_unglued_hub(), and sheaf::is_valid().

Referenced by contains_unglued_hub(), map_rep_push(), map_rep_push_back(), map_rep_remove_entry(), operator=(), and pod().

◆ contains() [2/2]

bool sheaf::list_index_space_state::contains	(	pod_type	xid,
		pod_type	xhub_id
	)		const

virtual

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

Postcondition

is_basic_query

Definition at line 928 of file list_index_space_state.cc.

References _to_range, pod(), and to_range_const_itr().

◆ contains_unglued_hub()

bool sheaf::list_index_space_state::contains_unglued_hub ( pod_type xid ) const

virtual

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

Postcondition

is_basic_query

Definition at line 895 of file list_index_space_state.cc.

References _to_range, contains(), and to_range_const_itr().

Referenced by contains(), push_front(), replace_range_id(), and unglued_hub_pod().

◆ deep_size()

sheaf::size_type sheaf::list_index_space_state::deep_size ( bool xinclude_shallow ) const

virtual

The deep size of this.

Postcondition

result >= 0

Reimplemented from sheaf::explicit_index_space_state.

Definition at line 796 of file list_index_space_state.cc.

References sheaf::deep_size(), and operator=().

◆ front()

sheaf::list_index_space_state::pod_type sheaf::list_index_space_state::front ( ) const

The front of the list used to represent this id space; equivalent to hub_pod(begin()).

Definition at line 143 of file list_index_space_state.cc.

References _to_range, and back().

Referenced by sheaf::list_index_space_handle::front(), and reverse().

◆ get_id_space()

sheaf::index_space_handle & sheaf::list_index_space_state::get_id_space ( ) const

virtual

The id space handle with this state.

Postcondition

result.is_attached()

Implements sheaf::explicit_index_space_state.

Definition at line 1077 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::attach(), sheaf::explicit_index_space_handle::is_attached(), and release_id_space().

Referenced by handle_pool_deep_size().

◆ get_iterator()

sheaf::index_space_iterator & sheaf::list_index_space_state::get_iterator ( ) const

virtual

Allocates an id space iterator from the iterator pool.

Postcondition

result.is_attached()

Implements sheaf::explicit_index_space_state.

Definition at line 1214 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::attach(), sheaf::explicit_index_space_iterator::is_attached(), and release_iterator().

Referenced by iterator_pool_deep_size().

◆ handle_pool_ct()

sheaf::size_type sheaf::list_index_space_state::handle_pool_ct ( )

static

The number of handles in the pool.

Postcondition

result >= 0

Definition at line 1039 of file list_index_space_state.cc.

References handle_pool_deep_size().

Referenced by unglued_hub_pod().

◆ handle_pool_deep_size()

sheaf::size_type sheaf::list_index_space_state::handle_pool_deep_size ( )

static

The deep size of the handle pool.

Postcondition

result >= 0

Definition at line 1058 of file list_index_space_state.cc.

References sheaf::deep_size(), and get_id_space().

Referenced by handle_pool_ct().

◆ invariant()

bool sheaf::list_index_space_state::invariant ( ) const

virtual

Class invariant.

Invariant

gathered_insertion_index_space_state::invariant()

is_valid(begin()) == is_valid(end())

(begin() == 0) || !is_valid(begin())

Reimplemented from sheaf::gathered_insertion_index_space_state.

Definition at line 1392 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::begin(), sheaf::deep_size(), sheaf::any::disable_invariant_check(), sheaf::any::enable_invariant_check(), sheaf::explicit_index_space_state::end(), sheaf::gathered_insertion_index_space_state::invariant(), sheaf::any::invariant_check(), and sheaf::is_valid().

Referenced by is_ancestor_of(), list_index_space_state(), operator=(), push_front(), and reserve().

◆ is_ancestor_of()

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

virtual

Conformance test; true if other conforms to this.

Precondition

other != 0

Reimplemented from sheaf::gathered_insertion_index_space_state.

Definition at line 1371 of file list_index_space_state.cc.

References invariant().

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

◆ iterator_pool_ct()

sheaf::size_type sheaf::list_index_space_state::iterator_pool_ct ( )

static

The number of iterators in the pool.

Postcondition

result >= 0

Definition at line 1176 of file list_index_space_state.cc.

References iterator_pool_deep_size().

Referenced by allocated_id_space().

◆ iterator_pool_deep_size()

sheaf::size_type sheaf::list_index_space_state::iterator_pool_deep_size ( )

static

The deep size of the iterator pool.

Postcondition

result >= 0

Definition at line 1195 of file list_index_space_state.cc.

References sheaf::deep_size(), and get_iterator().

Referenced by iterator_pool_ct().

◆ map_rep_clear()

void sheaf::list_index_space_state::map_rep_clear ( )

protectedvirtual

Removes all entrires from the map representation.

Postcondition

-unexecutable( "map rep is empty" )

Implements sheaf::gathered_insertion_index_space_state.

Definition at line 609 of file list_index_space_state.cc.

References _to_range, and map_rep_gather().

Referenced by map_rep_remove_entry().

◆ map_rep_gather()

void sheaf::list_index_space_state::map_rep_gather ( )

protectedvirtual

Gathers the map representation into an interval.

Postcondition

-unexecutable( "map rep is gathered" )

Implements sheaf::gathered_insertion_index_space_state.

Definition at line 631 of file list_index_space_state.cc.

References to_range_itr().

Referenced by map_rep_clear().

◆ map_rep_push()

void sheaf::list_index_space_state::map_rep_push	(	index_space_iterator &	xitr,
		pod_type	xrange_id
	)

protectedvirtual

Inserts entry (xitr.pod(), xrange_id) into the map representation. Increments all domain ids greater than xitr.pod() by one. Sets xitr to the entry at xitr.pod()+1.

Precondition

allocated_iterator(xitr)

!contains_hub(xrange_id)

Postcondition

contains(old_itr_pod, xrange_id)

xitr.pod() == old_itr_pod+1

xitr.hub_pod() == old_itr_hub_pod

Definition at line 415 of file list_index_space_state.cc.

References sheaf::list_index_space_iterator::_itr, _to_range, allocated_iterator(), contains(), sheaf::explicit_index_space_state::contains_hub(), sheaf::index_space_iterator::hub_pod(), map_rep_remove_entry(), and sheaf::index_space_iterator::pod().

Referenced by map_rep_push_back().

◆ map_rep_push_back()

void sheaf::list_index_space_state::map_rep_push_back ( pod_type xrange_id )

protectedvirtual

Inserts entry (next_id(), xrange_id) into the map representation.

Precondition

!contains_hub(xrange_id)

Postcondition

contains(old_next_id, xrange_id)

Definition at line 390 of file list_index_space_state.cc.

References _to_range, contains(), sheaf::explicit_index_space_state::contains_hub(), map_rep_push(), and sheaf::gathered_insertion_index_space_state::next_id().

Referenced by to_range().

◆ map_rep_remove_entry() [1/2]

sheaf::size_type sheaf::list_index_space_state::map_rep_remove_entry	(	pod_type	xid,
		bool	xis_range_id
	)

protectedvirtual

Removes the entry containing range id xid (xis_range_id true) or domain id xid (xis_range_id false) from the map representation; returns the number of entries actully removed, either 0 or 1.

Postcondition

!old_contains_entry || !contains(old_pod, old_hub_pod)

(result == 0) || (result == 1)

Definition at line 458 of file list_index_space_state.cc.

References _to_range, contains(), sheaf::explicit_index_space_state::contains_hub(), sheaf::explicit_index_space_state::hub_pod(), pod(), and to_range_itr().

Referenced by map_rep_push().

◆ map_rep_remove_entry() [2/2]

void sheaf::list_index_space_state::map_rep_remove_entry ( index_space_iterator & xitr )

protectedvirtual

Removes the equivalence associated with id xitr.pod()/ Increments xitr to the next entry if any.

Precondition

allocated_iterator(xitr)

!xitr.is_done()

contains(xitr.pod())

Postcondition

!contains_hub(old_itr_hub_id)

xitr.is_done() || xitr.pod() == old_itr_id

-unexecutable( "xitr.is_done() || xitr.hub_pod() == old_next_itr_hub_pod" )

Implements sheaf::gathered_insertion_index_space_state.

Definition at line 560 of file list_index_space_state.cc.

References sheaf::list_index_space_iterator::_itr, _to_range, allocated_iterator(), contains(), sheaf::explicit_index_space_state::contains_hub(), sheaf::index_space_iterator::hub_pod(), sheaf::index_space_iterator::is_done(), map_rep_clear(), and sheaf::index_space_iterator::pod().

◆ new_space() [1/2]

sheaf::list_index_space_handle sheaf::list_index_space_state::new_space	(	index_space_family &	xid_spaces,
		const std::string &	xname,
		bool	xis_persistent
	)

static

Create a new list id space in the id space family xid_space at the next available id space index with name xname, and persistence xis_persistent. Returns a handle to the id space created.

Precondition

!xname.empty()

!xid_spaces.contains(xname)

Postcondition

&result.id_spaces() == &xid_spaces

xid_spaces.contains(xname)

result.conforms_to_state(xname)

result.is_persistent() == xis_persistent

result.name() == xname

result.capacity() >= 0

Definition at line 37 of file list_index_space_state.cc.

References sheaf::gathered_insertion_index_space_handle::capacity(), sheaf::list_index_space_handle::conforms_to_state(), sheaf::index_space_family::contains(), sheaf::explicit_index_space_handle::id_spaces(), sheaf::explicit_index_space_handle::index(), sheaf::index_space_family::is_explicit_interval(), sheaf::explicit_index_space_handle::is_persistent(), list_index_space_state(), sheaf::index_space_handle::name(), and reverse().

Referenced by sheaf::crg_interval::force_explicit_cover(), sheaf::list_index_space_handle::new_space(), and sheaf::implicit_crg_interval::put_private_data().

◆ new_space() [2/2]

static list_index_space_handle sheaf::list_index_space_state::new_space	(	index_space_family &	xid_spaces,
		pod_type	xid,
		const std::string &	xname,
		bool	xis_persistent
	)

static

Create a new list id space in the id space family xid_space at the id space index xid with name xname, and persistence xis_persistent. Returns a handle to the id space created.

◆ operator=()

sheaf::list_index_space_state & sheaf::list_index_space_state::operator= ( const explicit_index_space_state & xother )

protectedvirtual

Assignment operator.

Precondition

is_ancestor_of(&xother)

Postcondition

invariant()

(*this) == xother

Reimplemented from sheaf::gathered_insertion_index_space_state.

Definition at line 817 of file list_index_space_state.cc.

References _capacity, _to_range, contains(), invariant(), and is_ancestor_of().

Referenced by deep_size().

◆ operator==()

bool sheaf::list_index_space_state::operator== ( const explicit_index_space_state & xother ) const

virtual

True if this is equivalent to xother.

Precondition

is_ancestor_of(&xother)

Reimplemented from sheaf::gathered_insertion_index_space_state.

Definition at line 772 of file list_index_space_state.cc.

References _capacity, _to_range, deep_size, is_ancestor_of(), and sheaf::gathered_insertion_index_space_state::operator==().

Referenced by to_range_const_itr().

◆ pod()

sheaf::explicit_index_space_state::pod_type sheaf::list_index_space_state::pod ( pod_type xid ) const

virtual

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

Postcondition

!is_valid(result) || contains(result)

Definition at line 963 of file list_index_space_state.cc.

References _to_range, contains(), sheaf::invalid_pod_index(), sheaf::is_valid(), and unglued_hub_pod().

Referenced by contains(), map_rep_remove_entry(), and replace_range_id().

◆ push_front()

void sheaf::list_index_space_state::push_front ( pod_type xhub_id )

Pushes hub id xhub_id onto the front of the list used to represent this id space; increments the domain ids of all existing members.

Precondition

!contains_unglued_hub(xhub_id)

Postcondition

invariant()

unglued_hub_pod(0) == xhub_id

ct() == old_ct + 1

begin() == 0

ct() > 1 ? end() == old_end+1 : end() == 1

Definition at line 157 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::_begin, sheaf::explicit_index_space_state::_ct, sheaf::explicit_index_space_state::_end, _to_range, sheaf::explicit_index_space_state::begin(), contains_unglued_hub(), sheaf::explicit_index_space_state::ct(), sheaf::explicit_index_space_state::end(), invariant(), replace_range_id(), and unglued_hub_pod().

Referenced by back(), and sheaf::list_index_space_handle::push_front().

◆ release_id_space()

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

virtual

Release the id space handle xid_space.

Precondition

allocated_id_space(xid_space)

Postcondition

is_basic_query

Implements sheaf::explicit_index_space_state.

Definition at line 1097 of file list_index_space_state.cc.

References allocated_id_space(), and sheaf::index_space_handle::detach().

Referenced by get_id_space().

◆ release_iterator()

void sheaf::list_index_space_state::release_iterator ( index_space_iterator & xitr ) const

virtual

Returns the id space iterator xitr to the iterator pool.

Precondition

allocated_iterator(xitr)

Postcondition

is_basic_query

Implements sheaf::explicit_index_space_state.

Definition at line 1234 of file list_index_space_state.cc.

References allocated_iterator(), and sheaf::index_space_iterator::detach().

Referenced by get_iterator().

◆ replace_range_id()

void sheaf::list_index_space_state::replace_range_id	(	pod_type	xold_range_id,
		pod_type	xnew_range_id
	)

Replaces xold_range_id with xnew_range_id.

Precondition

(xnew_range_id != xold_range_id) ? !contains_unglued_hub(xnew_range_id) : true

Postcondition

old_contains_xold_range_id ? contains_unglued_hub(xnew_range_id) : true

(xnew_range_id != xold_range_id) ? !contains_unglued_hub(xold_range_id) : true

old_contains_xold_range_id ? pod(xnew_range_id) == old_domain_id : true

Definition at line 208 of file list_index_space_state.cc.

References _to_range, contains_unglued_hub(), list_index_space_state(), pod(), and to_range_itr().

Referenced by push_front(), and sheaf::list_index_space_handle::replace_range_id().

◆ reserve()

void sheaf::list_index_space_state::reserve ( size_type xcapacity )

virtual

Reserve enough memory for xcapacity number of ids.

Postcondition

invariant()

capacity() >= xcapacity

Implements sheaf::gathered_insertion_index_space_state.

Definition at line 323 of file list_index_space_state.cc.

References _capacity, capacity(), and invariant().

Referenced by update_extrema().

◆ reverse()

void sheaf::list_index_space_state::reverse ( bool xupdate_extrema )

Reverse the order, for instance hub_pod(new 0) = hub_pod(old last);.

Definition at line 120 of file list_index_space_state.cc.

References _to_range, front(), and update_extrema().

Referenced by new_space(), and sheaf::list_index_space_handle::reverse().

◆ to_range() [1/2]

sheaf::list_index_space_state::to_range_type & sheaf::list_index_space_state::to_range ( )

The representation of the domain id to range id map. Warning: direct manipulation of the to_range map can invalid the state of the index space, make sure to invoke update_extrema_after_remove() before using the rest of the index space interface.

Definition at line 373 of file list_index_space_state.cc.

References _to_range.

Referenced by capacity(), sheaf::operator<<(), and sheaf::list_index_space_handle::to_range().

◆ to_range() [2/2]

const sheaf::list_index_space_state::to_range_type & sheaf::list_index_space_state::to_range ( ) const

The representation of the domain id to range id map, const version. Warning: direct manipulation of the to_range map can invalid the state of the index space, make sure to invoke update_extrema_after_remove() before using the rest of the index space interface.

Definition at line 380 of file list_index_space_state.cc.

References _to_range, and map_rep_push_back().

◆ to_range_const_itr()

sheaf::list_index_space_state::to_range_type::const_iterator sheaf::list_index_space_state::to_range_const_itr	(	pod_type	xid,
		bool	xis_range_id
	)		const

protected

A const_iterator pointing to the _to_range entry with range id (xis_range_id true) or domain id (xis_range_id false) xid.

Definition at line 718 of file list_index_space_state.cc.

References _to_range, and operator==().

Referenced by contains(), contains_unglued_hub(), to_range_itr(), and unglued_hub_pod().

◆ to_range_itr()

sheaf::list_index_space_state::to_range_type::iterator sheaf::list_index_space_state::to_range_itr	(	pod_type	xid,
		bool	xis_range_id
	)

protected

An iterator pointing to the _to_range entry with range id (xis_range_id true) or domain id (xis_range_id false) xid.

Definition at line 674 of file list_index_space_state.cc.

References _to_range, and to_range_const_itr().

Referenced by map_rep_gather(), map_rep_remove_entry(), and replace_range_id().

◆ unglued_hub_pod()

sheaf::explicit_index_space_state::pod_type sheaf::list_index_space_state::unglued_hub_pod ( pod_type xid ) const

virtual

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

Postcondition

!is_valid(result) || contains_unglued_hub(result)

Definition at line 994 of file list_index_space_state.cc.

References _to_range, contains_unglued_hub(), handle_pool_ct(), sheaf::invalid_pod_index(), sheaf::is_valid(), and to_range_const_itr().

Referenced by pod(), and push_front().

◆ update_extrema()

void sheaf::list_index_space_state::update_extrema ( )

virtual

Update the id extrema.

Implements sheaf::gathered_insertion_index_space_state.

Definition at line 293 of file list_index_space_state.cc.

References sheaf::explicit_index_space_state::_begin, sheaf::explicit_index_space_state::_ct, sheaf::explicit_index_space_state::_end, sheaf::invalid_pod_index(), and reserve().

Referenced by reverse(), and ~list_index_space_state().

Friends And Related Function Documentation

◆ deep_size

SHEAF_DLL_SPEC size_t deep_size	(	const list_index_space_state &	xn,
		bool	xinclude_shallow
	)

friend

The deep size of list_index_space_state& xn.

Referenced by sheaf::deep_size(), and operator==().

Member Data Documentation

◆ _capacity

pod_type sheaf::list_index_space_state::_capacity

protected

The capacity of this map.

Definition at line 264 of file list_index_space_state.h.

Referenced by capacity(), list_index_space_state(), operator=(), operator==(), and reserve().

◆ _to_range

to_range_type sheaf::list_index_space_state::_to_range

protected

The representation of the domain id to range id map.

Definition at line 259 of file list_index_space_state.h.

Referenced by back(), contains(), contains_unglued_hub(), sheaf::deep_size(), front(), map_rep_clear(), map_rep_push(), map_rep_push_back(), map_rep_remove_entry(), operator=(), operator==(), pod(), push_front(), replace_range_id(), reverse(), to_range(), to_range_const_itr(), to_range_itr(), and unglued_hub_pod().

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

Public Member Functions

Friends

SPACE FACTORY FACET

LIST_INDEX_SPACE_STATE FACET

GATHERED_INSERTION INDEX SPACE FACET

MAP REPRESENTATION FACET

EXPLICIT_INDEX_SPACE_STATE FACET

INDEX SPACE FACET

HANDLE POOL FACET

ITERATOR POOL FACET

ANY FACET

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ to_range_type

Constructor & Destructor Documentation

◆ list_index_space_state() [1/2]

◆ list_index_space_state() [2/2]

◆ ~list_index_space_state()

Member Function Documentation

◆ allocated_id_space()

◆ allocated_iterator()

◆ back()

◆ capacity()

◆ class_name()

◆ clone()

◆ contains() [1/2]

◆ contains() [2/2]

◆ contains_unglued_hub()

◆ deep_size()

◆ front()

◆ get_id_space()

◆ get_iterator()

◆ handle_pool_ct()

◆ handle_pool_deep_size()

◆ invariant()

◆ is_ancestor_of()

◆ iterator_pool_ct()

◆ iterator_pool_deep_size()

◆ map_rep_clear()

◆ map_rep_gather()

◆ map_rep_push()

◆ map_rep_push_back()

◆ map_rep_remove_entry() [1/2]

◆ map_rep_remove_entry() [2/2]

◆ new_space() [1/2]

◆ new_space() [2/2]

◆ operator=()

◆ operator==()

◆ pod()

◆ push_front()

◆ release_id_space()

◆ release_iterator()

◆ replace_range_id()

◆ reserve()

◆ reverse()

◆ to_range() [1/2]

◆ to_range() [2/2]

◆ to_range_const_itr()

◆ to_range_itr()

◆ unglued_hub_pod()

◆ update_extrema()

Friends And Related Function Documentation

◆ deep_size

Member Data Documentation

◆ _capacity

◆ _to_range