An implementation of class sum_index_space_handle that has a primary sum id space state. More...

#include <hub_index_space_handle.h>

Inheritance diagram for sheaf::hub_index_space_handle:

Friends
class	primary_sum_index_space_state

HUB_INDEX_SPACE_HANDLE FACET
	hub_index_space_handle ()
	Default constructor. More...

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

	hub_index_space_handle (const index_space_family &xid_spaces, pod_type xindex)
	Constructor: Attach to state with index xindex in the family xid_spaces. More...

	hub_index_space_handle (const index_space_family &xid_spaces, const std::string &xname)
	Constructor: Attach to state with name xname in the family xid_spaces. More...

hub_index_space_handle &	operator= (const hub_index_space_handle &xother)
	Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother). More...

virtual	~hub_index_space_handle ()
	Destructor. More...

	hub_index_space_handle (primary_sum_index_space_state &xstate)
	Constructor: Attach to state xstate. More...

primary_sum_index_space_state &	state ()
	The primary sum id space state (mutable version). More...

const primary_sum_index_space_state &	state () const
	The primary sum id space state (const version). More...

PRIMARY SUM INDEX SPACE FACET
pod_type	new_id ()
	Allocate the next available id in this space. More...

pod_type	new_id (pod_type xid)
	Allocate an xid in this space. More...

void	delete_id (pod_type xid)
	Deallocate the id xid in this space. More...

bool	is_valid_reserved_id (pod_type xid) const
	True if and only if the reserved term containing xid is already a reserved term or is available for allocation. More...

pod_type	next_id () const
	The next available id. More...

pod_type	new_primary_term (size_type xct)
	Create a new primary term [next_id(), next_id()+xct). Returns the index of the term created. More...

pod_type	new_primary_term (pod_type xid, size_type xct)
	Create a new primary term [xid, xid+xct). Returns the index of the term created. More...

void	remove_term (pod_type xi)
	Remove xi-th term of this sum. More...

void	extend_last_term (size_type xct)
	Extends the last term to ct() == xct. More...

bool	interval_is_full (pod_type xbegin, pod_type xend) const
	True if all ids in the interval [xbegin, xend) are in this space. More...

bool	interval_is_empty (pod_type xbegin, pod_type xend) const
	True if all ids in the interval [xbegin, xend) are not in this space. More...

bool	interval_is_available (pod_type xbegin, pod_type xend) const
	True if the ids in the internal [xbegin, xend) are available in this space. More...

GLUING FACET
void	glue (pod_type xid, pod_type xrep)
	Glues xid to xrep; adds xid to the equivalence class with representative member xrep. More...

void	unglue (pod_type xid)
	Unglues xid; makes xid its own representative. More...

void	unglue_all (pod_type xrep_id)
	Unglue all ids glued to representative xrep_id; makes each id in the equivalence class of xrep_id its own representative. More...

bool	has_gluing () const
	Ture if there is any gluing. More...

GATHERED ID SPACE FACET
const index_space_handle &	new_gathered_id_space (bool xexclude_bottom)
	Construct a gathered id space from this id space. If xexclude_bottom, construct the id space without BOTTOM_INDEX. More...

void	update_gathered_id_space ()
	Update the gathered id space. More...

const index_space_handle &	gathered_id_space () const
	The gathered id space. More...

bool	gathered_id_space_excludes_bottom () const
	True, if the gathered id space excludes BOTTOM_INDEX. More...

bool	has_gathered_id_space () const
	True, if the gathered id space exists. More...

STANDARD IDS FACET
void	update_standard_ids ()
	Make end() the standard id end. More...

bool	has_only_standard_ids () const
	True if and only if there are only standard ids. More...

void	clear_ids ()
	Deallocate all non-standard ids. More...

INDEX_SPACE_HANDLE FACET
virtual hub_index_space_handle &	operator= (const index_space_handle &xother)
	Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother). More...

virtual hub_index_space_handle *	clone () const
	Virtual constructor, makes a new instance of the same type as this. If the handle is attached, attach to the same state. More...

HANDLE FACET
virtual bool	conforms_to_state (const index_space_collection &xhost, pod_type xlocal_id) const
	True if this conforms to the handle type required by the state with local scope id xlocal_id in the host id space collection xhost. More...

ANY FACET
virtual bool	is_ancestor_of (const any *other) const
	Conformance test; true if other conforms to this. More...

virtual bool	invariant () const
	Class invariant. More...

Additional Inherited Members
Public Types inherited from sheaf::sum_index_space_handle
typedef std::list< pod_type >	equivalence_class_type
	The type used to represent an equivalence class. More...

Public Types inherited from sheaf::index_space_handle
typedef pod_index_type	pod_type
	The "plain old data" index type for this. More...

Public Member Functions inherited from sheaf::sum_index_space_handle
void	equivalence_class (pod_type xhub_id, equivalence_class_type &result) const
	The equivalence class associated with the hub id xhub_id. More...

size_type	equivalence_ct (pod_type xhub_id) const
	The number of members of the equivalence class of hub id xhub_id. More...

bool	contains_rep (pod_type xhub_id) const
	True if and only if hub id xhub_id is the representative member of its equivalence class. More...

bool	contains_unique_rep (pod_type xhub_id) const
	True if and only if hub id xhub_id is the only member of its equivalence class. More...

pod_type	rep (pod_type xhub_id) const
	The representative member of the equivalence class of hub id xhub_id. More...

pod_type	host_rep (pod_type xhub_id) const
	The host id associated with the representative member of the equivalence class of hub id xhub_id. More...

pod_type	term_id_begin () const
	Beginning index of the terms in this sum. More...

pod_type	term_id_end () const
	Ending index of the terms in this sum. More...

bool	contains_term_id (pod_type xi) const
	True if this map contains the xi-th term. More...

const index_space_handle &	term (pod_type xi) const
	The xi-th term. More...

const index_space_handle &	term_of (pod_type xid) const
	The term containing id xid. More...

const index_space_handle &	term_of (const scoped_index &xid) const
	The term contains id xid. More...

const index_space_handle &	last_term () const
	The last term. More...

pod_type	term_begin (pod_type xi) const
	Beginning id of the xi-th term. More...

pod_type	term_end (pod_type xi) const
	Ending id of the xi-th term. More...

pod_type	term_hub_begin (pod_type xi) const
	Beginning hub id of the xi-th term. More...

pod_type	term_hub_end (pod_type xi) const
	Ending hub id of the xi-th term. More...

pod_type	term_id (pod_type xid) const
	The id of the term containing id xid. More...

void	binary (pod_type xindex, pod_type &xterm_id, pod_type &xlocal) const
	Converts simple index xindex to its binary components xterm_id and xlocal_id. More...

void	simple (pod_type xterm_id, pod_type xlocal_id, pod_type &xindex) const
	Converts binary components xterm_id, xlocal_id to simple index xindex. More...

void	clear ()
	Deletes all entries. More...

	sum_index_space_handle ()
	Default constructor. More...

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

	sum_index_space_handle (const index_space_family &xid_spaces, pod_type xindex)
	Constructor: Attach to state with index xindex in the family xid_spaces. More...

	sum_index_space_handle (const index_space_family &xid_spaces, const std::string &xname)
	Constructor: Attach to state with name xname in the family xid_spaces. More...

sum_index_space_handle &	operator= (const sum_index_space_handle &xother)
	Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother). More...

virtual	~sum_index_space_handle ()
	Destructor. More...

Public Member Functions inherited from sheaf::explicit_index_space_handle
	explicit_index_space_handle ()
	Default constructor. More...

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

	explicit_index_space_handle (const index_space_family &xid_spaces, pod_type xindex)
	Constructor: Attach to state with index xindex in the family xid_spaces. More...

	explicit_index_space_handle (const index_space_family &xid_spaces, const std::string &xname)
	Constructor: Attach to state with name xname in the family xid_spaces. More...

explicit_index_space_handle &	operator= (const explicit_index_space_handle &xother)
	Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother). More...

virtual	~explicit_index_space_handle ()
	Destructor. 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 size_type	ct () const
	The number of members. More...

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

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

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_glued_hub (pod_type xid) const
	True if this space contains an id equivalent to xid in the glued 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...

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

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

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

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

virtual bool	has_product_structure () const
	True if this id space has a product structure. More...

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

virtual pod_type	index () const
	Index of this space. More...

virtual bool	is_attached () const
	True if this handle is attached to a state. More...

virtual void	attach_to (pod_type xindex)
	Attach to the state with index xindex in the id space family id_spaces(). More...

virtual void	attach_to (const index_space_collection &xhost, pod_type xlocal_id)
	Attach to the state with local scope id, xlocal_id in the host id space collection xhost. More...

virtual void	detach ()
	Detach this handle form its state, if any. More...

virtual index_space_handle &	get_id_space () const
	Allocates an id space handle from the handle pool. More...

virtual void	release_id_space () const
	Returns this id space handle to the handle pool. More...

virtual bool	allocated_id_space () const
	True if and only if this id space handle was allocated by the handle 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...

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

bool	operator== (const index_space_handle &xother) const
	True if this is a handle has the same state as xother. More...

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

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

bool	is_gathered () const
	True if begin() == 0 and end() == ct(). 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...

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

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(pod_type). More...

template<typename T >
const T &	product_structure () const
	The product structure of type T for this id space (const version). More...

template<typename T >
T &	product_structure ()
	The product structure of type T for this id space (mutable version). More...

template<typename T >
bool	product_structure_conforms_to () const
	True if the product structure for this id space conforms to type T. More...

std::string	name () const
	Name of this space. More...

void	put_name (const std::string &xname)
	Associate name xname with this id space. More...

void	attach_to (const index_space_family &xid_spaces, pod_type xindex)
	Attach to the state with index xindex in the id space family xid_spaces. More...

void	attach_to (const index_space_family &xid_spaces, const std::string &xname)
	Attach to the state with name xname in the id space family xid_spaces. More...

void	attach_to (const std::string &xname)
	Attach to the state with name xname in the id space family id_spaces(). More...

void	attach_to (const index_space_handle &xother)
	Attach to the state of the id space xother. More...

bool	conforms_to_state (const index_space_family &xid_spaces, pod_type xindex) const
	True if this conforms to the handle type required by the state with index xindex in the id space family, xid_spaces. More...

bool	conforms_to_state (const index_space_family &xid_spaces, const std::string &xname) const
	True if this conforms to the handle type required by the state with name xname in the id space family, xid_spaces. More...

bool	conforms_to_state (pod_type xid) const
	True if this conforms to the handle type required by the state with id xid. More...

bool	conforms_to_state (const std::string &xname) const
	True if this conforms to the handle type required by the state with name xname. More...

bool	conforms_to_state (const index_space_handle &xother) const
	True if this conforms to the handle type required by the state of xother. More...

Public Member Functions inherited from sheaf::any
bool	is_same_type (const any *other) const
	True if other is the same type as this. More...

virtual	~any ()
	Destructor. More...

bool	invariant_check () const
	True if invariant checking is enabled. More...

void	enable_invariant_check () const
	Enable invariant checking. More...

void	disable_invariant_check () const
	Disable invariant check. Intended for preventing recursive calls to invariant and for suppressing invariant checking during multi-phase initialization. More...

int	disable_invariance_check_request_depth () const
	Number of times disable_invariant_check has been called without matching call to enable_invariant_check. More...

Protected Member Functions inherited from sheaf::sum_index_space_handle
sum_index_space_state &	state ()
	The sum id space state (mutable version). More...

const sum_index_space_state &	state () const
	The sum id space state (const version). More...

Protected Member Functions inherited from sheaf::explicit_index_space_handle
explicit_index_space_state &	state ()
	The explicit state (mutable version). More...

const explicit_index_space_state &	state () const
	The explicit state (const version). More...

void	attach_to (explicit_index_space_state *xstate)
	Attach to the explicit id space state xstate. More...

virtual bool	conforms_to_state (explicit_index_space_state *xstate) const
	True if this conforms to the iterator type required by the explicit id space state xstate. More...

explicit_index_space_state *	state (pod_type xindex) const
	The explicit id space state at id xindex in id space family id_spaces(). Returns null if no id space stae is available at index xindex. More...

explicit_index_space_state *	state (const index_space_collection &xhost, pod_type xlocal_id) const
	The explicit id space state with local scope id xlocal_id in the host id space collection xhost. More...

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

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

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

Protected Attributes inherited from sheaf::explicit_index_space_handle
explicit_index_space_state *	_state
	The explicit state. More...

Detailed Description

An implementation of class sum_index_space_handle that has a primary sum id space state.

Definition at line 41 of file hub_index_space_handle.h.

Constructor & Destructor Documentation

◆ hub_index_space_handle() [1/5]

sheaf::hub_index_space_handle::hub_index_space_handle ( )

Default constructor.

Postcondition

invariant()

Definition at line 33 of file hub_index_space_handle.cc.

References invariant().

Referenced by clone(), hub_index_space_handle(), and ~hub_index_space_handle().

◆ hub_index_space_handle() [2/5]

sheaf::hub_index_space_handle::hub_index_space_handle ( const hub_index_space_handle & xother )

Copy constructor.

Postcondition

invariant()

(*this) == xother

Definition at line 50 of file hub_index_space_handle.cc.

References hub_index_space_handle(), and invariant().

◆ hub_index_space_handle() [3/5]

sheaf::hub_index_space_handle::hub_index_space_handle	(	const index_space_family &	xid_spaces,
		pod_type	xindex
	)

Constructor: Attach to state with index xindex in the family xid_spaces.

Precondition

xid_spaces.contains(xindex)

conforms_to_state(xid_spaces, xindex)

Postcondition

invariant()

is_attached()

&id_spaces() == &xid_spaces

index() == xindex

Definition at line 69 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::attach_to(), conforms_to_state(), sheaf::index_space_family::contains(), hub_index_space_handle(), sheaf::explicit_index_space_handle::id_spaces(), sheaf::explicit_index_space_handle::index(), invariant(), and sheaf::explicit_index_space_handle::is_attached().

◆ hub_index_space_handle() [4/5]

sheaf::hub_index_space_handle::hub_index_space_handle	(	const index_space_family &	xid_spaces,
		const std::string &	xname
	)

Constructor: Attach to state with name xname in the family xid_spaces.

Precondition

xid_spaces.contains(xname)

conforms_to_state(xid_spaces, xname)

Postcondition

invariant()

is_attached()

&id_spaces() == &xid_spaces

name() == xname

Definition at line 94 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::attach_to(), conforms_to_state(), sheaf::index_space_family::contains(), sheaf::explicit_index_space_handle::id_spaces(), invariant(), sheaf::explicit_index_space_handle::is_attached(), sheaf::index_space_handle::name(), and operator=().

◆ ~hub_index_space_handle()

sheaf::hub_index_space_handle::~hub_index_space_handle ( )

virtual

Destructor.

Definition at line 141 of file hub_index_space_handle.cc.

References hub_index_space_handle().

Referenced by operator=().

◆ hub_index_space_handle() [5/5]

sheaf::hub_index_space_handle::hub_index_space_handle ( primary_sum_index_space_state & xstate )

protected

Constructor: Attach to state xstate.

Postcondition

invariant()

is_attached()

&state() == &xstate

Definition at line 159 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::attach_to(), invariant(), sheaf::explicit_index_space_handle::is_attached(), and state().

Member Function Documentation

◆ clear_ids()

void sheaf::hub_index_space_handle::clear_ids ( )

Deallocate all non-standard ids.

Postcondition

has_only_standard_ids()

Definition at line 774 of file hub_index_space_handle.cc.

References sheaf::primary_sum_index_space_state::clear_ids(), has_only_standard_ids(), operator=(), and state().

Referenced by sheaf::index_space_family::clear_id_spaces(), and has_only_standard_ids().

◆ clone()

sheaf::hub_index_space_handle * sheaf::hub_index_space_handle::clone ( ) const

virtual

Virtual constructor, makes a new instance of the same type as this. If the handle is attached, attach to the same state.

Postcondition

result != 0

is_same_type(result)

*result == *this

Reimplemented from sheaf::sum_index_space_handle.

Definition at line 848 of file hub_index_space_handle.cc.

References conforms_to_state(), hub_index_space_handle(), and sheaf::any::is_same_type().

Referenced by operator=().

◆ conforms_to_state()

bool sheaf::hub_index_space_handle::conforms_to_state	(	const index_space_collection &	xhost,
		pod_type	xlocal_id
	)		const

virtual

True if this conforms to the handle type required by the state with local scope id xlocal_id in the host id space collection xhost.

Precondition

xhost.contains(xlocal_id)

Postcondition

is_basic_query

Reimplemented from sheaf::sum_index_space_handle.

Definition at line 881 of file hub_index_space_handle.cc.

References sheaf::index_space_collection::contains(), is_ancestor_of(), and state().

Referenced by clone(), hub_index_space_handle(), sheaf::primary_sum_index_space_state::new_space(), and operator=().

◆ delete_id()

void sheaf::hub_index_space_handle::delete_id ( pod_type xid )

Deallocate the id xid in this space.

Postcondition

!contains(xid)

Definition at line 273 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::primary_sum_index_space_state::delete_id(), is_valid_reserved_id(), and state().

Referenced by sheaf::index_space_family::delete_id(), and new_id().

◆ extend_last_term()

void sheaf::hub_index_space_handle::extend_last_term ( size_type xct )

Extends the last term to ct() == xct.

Postcondition

invariant()

ct() == (old_ct - old_last_term_ct + xct)

term_id_end() == old_term_id_end

interval_is_full(old_last_term_begin, old_last_term_begin + xct)

Definition at line 420 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::ct(), sheaf::primary_sum_index_space_state::extend_last_term(), interval_is_full(), invariant(), sheaf::sum_index_space_handle::last_term(), state(), sheaf::sum_index_space_handle::term_begin(), and sheaf::sum_index_space_handle::term_id_end().

Referenced by sheaf::index_space_family::extend_last_term(), and remove_term().

◆ gathered_id_space()

const sheaf::index_space_handle & sheaf::hub_index_space_handle::gathered_id_space ( ) const

The gathered id space.

Precondition

has_gathered_id_space()

Postcondition

is_basic_query

Definition at line 666 of file hub_index_space_handle.cc.

References sheaf::primary_sum_index_space_state::gathered_id_space(), gathered_id_space_excludes_bottom(), has_gathered_id_space(), and state().

Referenced by sheaf::index_space_family::gathered_hub_id_space(), new_gathered_id_space(), and update_gathered_id_space().

◆ gathered_id_space_excludes_bottom()

bool sheaf::hub_index_space_handle::gathered_id_space_excludes_bottom ( ) const

True, if the gathered id space excludes BOTTOM_INDEX.

Postcondition

is_basic_query

Definition at line 687 of file hub_index_space_handle.cc.

References sheaf::primary_sum_index_space_state::gathered_id_space_excludes_bottom(), has_gathered_id_space(), and state().

Referenced by sheaf::index_space_family::gathered_hub_id_space_excludes_bottom(), gathered_id_space(), and new_gathered_id_space().

◆ glue()

void sheaf::hub_index_space_handle::glue	(	pod_type	xid,
		pod_type	xrep
	)

Glues xid to xrep; adds xid to the equivalence class with representative member xrep.

Precondition

contains_unique_rep(xid)

contains_rep(xrep)

term_id(xid) > term_id(xrep)

Postcondition

invariant()

!contains_rep(xid)

glued_hub_pod(xid) == xrep

Definition at line 521 of file hub_index_space_handle.cc.

References sheaf::sum_index_space_handle::contains_rep(), sheaf::sum_index_space_handle::contains_unique_rep(), sheaf::primary_sum_index_space_state::glue(), sheaf::explicit_index_space_handle::glued_hub_pod(), invariant(), state(), sheaf::sum_index_space_handle::term_id(), and unglue().

Referenced by sheaf::index_space_family::glue(), and interval_is_available().

◆ has_gathered_id_space()

bool sheaf::hub_index_space_handle::has_gathered_id_space ( ) const

True, if the gathered id space exists.

Postcondition

is_basic_query

Definition at line 706 of file hub_index_space_handle.cc.

References sheaf::primary_sum_index_space_state::has_gathered_id_space(), state(), and update_standard_ids().

Referenced by gathered_id_space(), gathered_id_space_excludes_bottom(), sheaf::index_space_family::has_gathered_hub_id_space(), new_gathered_id_space(), and update_gathered_id_space().

◆ has_gluing()

bool sheaf::hub_index_space_handle::has_gluing ( ) const

Ture if there is any gluing.

Postcondition

is_basic_query

Definition at line 591 of file hub_index_space_handle.cc.

References sheaf::primary_sum_index_space_state::has_gluing(), new_gathered_id_space(), and state().

Referenced by sheaf::index_space_family::has_gluing(), and unglue_all().

◆ has_only_standard_ids()

bool sheaf::hub_index_space_handle::has_only_standard_ids ( ) const

True if and only if there are only standard ids.

Postcondition

is_basic_query

Definition at line 755 of file hub_index_space_handle.cc.

References clear_ids(), sheaf::primary_sum_index_space_state::has_only_standard_ids(), and state().

Referenced by clear_ids(), and update_standard_ids().

◆ interval_is_available()

bool sheaf::hub_index_space_handle::interval_is_available	(	pod_type	xbegin,
		pod_type	xend
	)		const

True if the ids in the internal [xbegin, xend) are available in this space.

Precondition

xbegin < xend

Postcondition

is_basic_query

Definition at line 489 of file hub_index_space_handle.cc.

References glue(), sheaf::primary_sum_index_space_state::interval_is_available(), and state().

Referenced by interval_is_empty(), and new_primary_term().

◆ interval_is_empty()

bool sheaf::hub_index_space_handle::interval_is_empty	(	pod_type	xbegin,
		pod_type	xend
	)		const

True if all ids in the interval [xbegin, xend) are not in this space.

Precondition

xbegin < xend

Postcondition

is_basic_query

Definition at line 468 of file hub_index_space_handle.cc.

References interval_is_available(), sheaf::primary_sum_index_space_state::interval_is_empty(), and state().

Referenced by interval_is_full(), and remove_term().

◆ interval_is_full()

bool sheaf::hub_index_space_handle::interval_is_full	(	pod_type	xbegin,
		pod_type	xend
	)		const

True if all ids in the interval [xbegin, xend) are in this space.

Precondition

xbegin < xend

Postcondition

is_basic_query

Definition at line 447 of file hub_index_space_handle.cc.

References interval_is_empty(), sheaf::primary_sum_index_space_state::interval_is_full(), and state().

Referenced by extend_last_term(), and new_primary_term().

◆ invariant()

bool sheaf::hub_index_space_handle::invariant ( ) const

virtual

Class invariant.

Invariant

sum_index_space_handle::invariant()

Reimplemented from sheaf::sum_index_space_handle.

Definition at line 937 of file hub_index_space_handle.cc.

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

Referenced by extend_last_term(), glue(), hub_index_space_handle(), is_ancestor_of(), new_primary_term(), operator=(), remove_term(), unglue(), and unglue_all().

◆ is_ancestor_of()

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

virtual

Conformance test; true if other conforms to this.

Precondition

other != 0

Reimplemented from sheaf::sum_index_space_handle.

Definition at line 915 of file hub_index_space_handle.cc.

References invariant().

Referenced by conforms_to_state().

◆ is_valid_reserved_id()

bool sheaf::hub_index_space_handle::is_valid_reserved_id ( pod_type xid ) const

True if and only if the reserved term containing xid is already a reserved term or is available for allocation.

Postcondition

is_basic_query

Definition at line 292 of file hub_index_space_handle.cc.

References sheaf::primary_sum_index_space_state::is_valid_reserved_id(), next_id(), and state().

Referenced by delete_id(), sheaf::index_space_family::is_valid_reserved_id(), and new_id().

◆ new_gathered_id_space()

const sheaf::index_space_handle & sheaf::hub_index_space_handle::new_gathered_id_space ( bool xexclude_bottom )

Construct a gathered id space from this id space. If xexclude_bottom, construct the id space without BOTTOM_INDEX.

Precondition

!has_gathered_id_space()

Postcondition

has_gathered_id_space()

gathered_id_space().is_gathered()

xexclude_bottom == gathered_id_space_excludes_bottom()

Definition at line 621 of file hub_index_space_handle.cc.

References gathered_id_space(), gathered_id_space_excludes_bottom(), has_gathered_id_space(), sheaf::index_space_handle::is_gathered(), sheaf::primary_sum_index_space_state::new_gathered_id_space(), state(), and update_gathered_id_space().

Referenced by has_gluing(), and sheaf::index_space_family::new_gathered_hub_id_space().

◆ new_id() [1/2]

sheaf::hub_index_space_handle::pod_type sheaf::hub_index_space_handle::new_id ( )

Allocate the next available id in this space.

Postcondition

contains(result)

Definition at line 233 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::primary_sum_index_space_state::new_id(), and state().

Referenced by sheaf::index_space_family::new_id(), and state().

◆ new_id() [2/2]

sheaf::hub_index_space_handle::pod_type sheaf::hub_index_space_handle::new_id ( pod_type xid )

Allocate an xid in this space.

Precondition

is_valid_reserved_id(xid)

Postcondition

contains(xid)

Definition at line 252 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), delete_id(), is_valid_reserved_id(), sheaf::primary_sum_index_space_state::new_id(), and state().

◆ new_primary_term() [1/2]

sheaf::hub_index_space_handle::pod_type sheaf::hub_index_space_handle::new_primary_term ( size_type xct )

Create a new primary term [next_id(), next_id()+xct). Returns the index of the term created.

Precondition

interval_is_available(next_id(), next_id()+xct)

Postcondition

invariant()

term_id_end() == old_term_id_end + 1

id_spaces().contains(result)

interval_is_full(old_next_id, old_next_id+xct)

ct() == old_ct + xct

next_id() == old_next_id + xct

Definition at line 330 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::explicit_index_space_handle::ct(), sheaf::explicit_index_space_handle::id_spaces(), interval_is_available(), interval_is_full(), invariant(), sheaf::primary_sum_index_space_state::new_primary_term(), next_id(), state(), and sheaf::sum_index_space_handle::term_id_end().

Referenced by sheaf::index_space_family::new_primary_state(), and next_id().

◆ new_primary_term() [2/2]

sheaf::hub_index_space_handle::pod_type sheaf::hub_index_space_handle::new_primary_term	(	pod_type	xid,
		size_type	xct
	)

Create a new primary term [xid, xid+xct). Returns the index of the term created.

Precondition

interval_is_available(xid, xid+xct)

Postcondition

invariant()

term_id_end() == old_term_id_end + 1

id_spaces().contains(result)

interval_is_full(xid, xid+xct)

ct() == old_ct + xct

Definition at line 360 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::explicit_index_space_handle::ct(), sheaf::explicit_index_space_handle::id_spaces(), interval_is_available(), interval_is_full(), invariant(), sheaf::primary_sum_index_space_state::new_primary_term(), remove_term(), state(), and sheaf::sum_index_space_handle::term_id_end().

◆ next_id()

sheaf::hub_index_space_handle::pod_type sheaf::hub_index_space_handle::next_id ( ) const

The next available id.

Postcondition

is_basic_query

Definition at line 311 of file hub_index_space_handle.cc.

References new_primary_term(), sheaf::primary_sum_index_space_state::next_id(), and state().

Referenced by is_valid_reserved_id(), and new_primary_term().

◆ operator=() [1/2]

sheaf::hub_index_space_handle & sheaf::hub_index_space_handle::operator= ( const hub_index_space_handle & xother )

Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother).

Precondition

xother.is_attached() ? conforms_to_state(xother) : true

Postcondition

invariant()

(*this) == xother

Definition at line 120 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::attach_to(), conforms_to_state(), invariant(), sheaf::explicit_index_space_handle::is_attached(), and ~hub_index_space_handle().

Referenced by clear_ids(), and hub_index_space_handle().

◆ operator=() [2/2]

sheaf::hub_index_space_handle & sheaf::hub_index_space_handle::operator= ( const index_space_handle & xother )

virtual

Assignment operator; attach this handle to the state of xother. synonym for attach_to(xother).

Precondition

xother.is_attached() ? conforms_to_state(xother) : true

Postcondition

invariant()

(*this) == xother

Reimplemented from sheaf::sum_index_space_handle.

Definition at line 826 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::attach_to(), clone(), conforms_to_state(), invariant(), and sheaf::index_space_handle::is_attached().

◆ remove_term()

void sheaf::hub_index_space_handle::remove_term ( pod_type xi )

Remove xi-th term of this sum.

Precondition

contains_term_id(xi)

Postcondition

invariant()

ct() <= old_ct

term_id_begin() >= old_term_id_begin

term_id_end() <= old_term_id_end

interval_is_empty(old_begin, old_end - 1)

Definition at line 388 of file hub_index_space_handle.cc.

References sheaf::sum_index_space_handle::contains_term_id(), sheaf::explicit_index_space_handle::ct(), extend_last_term(), interval_is_empty(), invariant(), sheaf::primary_sum_index_space_state::remove_term(), state(), sheaf::sum_index_space_handle::term(), sheaf::sum_index_space_handle::term_begin(), sheaf::sum_index_space_handle::term_end(), sheaf::sum_index_space_handle::term_id_begin(), and sheaf::sum_index_space_handle::term_id_end().

Referenced by sheaf::index_space_family::delete_primary_state(), and new_primary_term().

◆ state() [1/2]

sheaf::primary_sum_index_space_state & sheaf::hub_index_space_handle::state ( )

protected

The primary sum id space state (mutable version).

Precondition

is_attached()

Postcondition

is_basic_query

Definition at line 180 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::is_attached().

Referenced by clear_ids(), conforms_to_state(), delete_id(), extend_last_term(), gathered_id_space(), gathered_id_space_excludes_bottom(), glue(), has_gathered_id_space(), has_gluing(), has_only_standard_ids(), hub_index_space_handle(), interval_is_available(), interval_is_empty(), interval_is_full(), is_valid_reserved_id(), new_gathered_id_space(), new_id(), new_primary_term(), next_id(), remove_term(), unglue(), unglue_all(), update_gathered_id_space(), and update_standard_ids().

◆ state() [2/2]

const sheaf::primary_sum_index_space_state & sheaf::hub_index_space_handle::state ( ) const

protected

The primary sum id space state (const version).

Precondition

is_attached()

Postcondition

is_basic_query

Definition at line 202 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::is_attached(), and new_id().

◆ unglue()

void sheaf::hub_index_space_handle::unglue ( pod_type xid )

Unglues xid; makes xid its own representative.

Precondition

contains(xid)

!contains_rep(xid)

Postcondition

invariant()

contains_unique_rep(xid)

Definition at line 546 of file hub_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::sum_index_space_handle::contains_rep(), sheaf::sum_index_space_handle::contains_unique_rep(), invariant(), state(), sheaf::primary_sum_index_space_state::unglue(), and unglue_all().

Referenced by glue(), and sheaf::index_space_family::unglue().

◆ unglue_all()

void sheaf::hub_index_space_handle::unglue_all ( pod_type xrep_id )

Unglue all ids glued to representative xrep_id; makes each id in the equivalence class of xrep_id its own representative.

Precondition

contains_rep(xrep_id)

Postcondition

invariant()

contains_unique_rep(xrep_id)

Definition at line 569 of file hub_index_space_handle.cc.

References sheaf::sum_index_space_handle::contains_rep(), sheaf::sum_index_space_handle::contains_unique_rep(), has_gluing(), invariant(), state(), and sheaf::primary_sum_index_space_state::unglue_all().

Referenced by unglue(), and sheaf::index_space_family::unglue_all().

◆ update_gathered_id_space()

void sheaf::hub_index_space_handle::update_gathered_id_space ( )

Update the gathered id space.

Precondition

has_gathered_id_space()

Postcondition

gathered_id_space().is_gathered()

Definition at line 645 of file hub_index_space_handle.cc.

References gathered_id_space(), has_gathered_id_space(), sheaf::index_space_handle::is_gathered(), state(), and sheaf::primary_sum_index_space_state::update_gathered_id_space().

Referenced by new_gathered_id_space(), and sheaf::index_space_family::update_gathered_hub_id_space().

◆ update_standard_ids()

void sheaf::hub_index_space_handle::update_standard_ids ( )

Make end() the standard id end.

Postcondition

has_only_standard_ids()

Definition at line 736 of file hub_index_space_handle.cc.

References has_only_standard_ids(), state(), and sheaf::primary_sum_index_space_state::update_standard_ids().

Referenced by has_gathered_id_space(), and sheaf::index_space_family::update_standard_id_spaces().

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

Friends

HUB_INDEX_SPACE_HANDLE FACET

PRIMARY SUM INDEX SPACE FACET

GLUING FACET

GATHERED ID SPACE FACET

STANDARD IDS FACET

INDEX_SPACE_HANDLE FACET

HANDLE FACET

ANY FACET

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ hub_index_space_handle() [1/5]

◆ hub_index_space_handle() [2/5]

◆ hub_index_space_handle() [3/5]

◆ hub_index_space_handle() [4/5]

◆ ~hub_index_space_handle()

◆ hub_index_space_handle() [5/5]

Member Function Documentation

◆ clear_ids()

◆ clone()

◆ conforms_to_state()

◆ delete_id()

◆ extend_last_term()

◆ gathered_id_space()

◆ gathered_id_space_excludes_bottom()

◆ glue()

◆ has_gathered_id_space()

◆ has_gluing()

◆ has_only_standard_ids()

◆ interval_is_available()

◆ interval_is_empty()

◆ interval_is_full()

◆ invariant()

◆ is_ancestor_of()

◆ is_valid_reserved_id()

◆ new_gathered_id_space()

◆ new_id() [1/2]

◆ new_id() [2/2]

◆ new_primary_term() [1/2]

◆ new_primary_term() [2/2]

◆ next_id()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ remove_term()

◆ state() [1/2]

◆ state() [2/2]

◆ unglue()

◆ unglue_all()

◆ update_gathered_id_space()

◆ update_standard_ids()