An implemenation of class explicit_index_space_handle that has a sum id space state. More...

#include <sum_index_space_handle.h>

Inheritance diagram for sheaf::sum_index_space_handle:

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

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

SUM INDEX SPACE FACET
typedef std::list< pod_type >	equivalence_class_type
	The type used to represent an equivalence class. More...

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

INDEX_SPACE_HANDLE FACET
virtual sum_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 sum_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::index_space_handle
typedef pod_index_type	pod_type
	The "plain old data" index type for this. 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::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 implemenation of class explicit_index_space_handle that has a sum id space state.

Definition at line 45 of file sum_index_space_handle.h.

Member Typedef Documentation

◆ equivalence_class_type

typedef std::list<pod_type> sheaf::sum_index_space_handle::equivalence_class_type

The type used to represent an equivalence class.

Definition at line 117 of file sum_index_space_handle.h.

Constructor & Destructor Documentation

◆ sum_index_space_handle() [1/4]

sheaf::sum_index_space_handle::sum_index_space_handle ( )

Default constructor.

Postcondition

invariant()

Definition at line 34 of file sum_index_space_handle.cc.

References invariant().

Referenced by clone(), and sum_index_space_handle().

◆ sum_index_space_handle() [2/4]

sheaf::sum_index_space_handle::sum_index_space_handle ( const sum_index_space_handle & xother )

Copy constructor.

Postcondition

invariant()

(*this) == xother

Definition at line 51 of file sum_index_space_handle.cc.

References invariant(), and sum_index_space_handle().

◆ sum_index_space_handle() [3/4]

sheaf::sum_index_space_handle::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.

Precondition

xid_spaces.contains(xindex)

conforms_to_state(xid_spaces, xindex)

Postcondition

invariant()

is_attached()

&id_spaces() == &xid_spaces

index() == xindex

Definition at line 70 of file sum_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(), sheaf::explicit_index_space_handle::index(), invariant(), sheaf::explicit_index_space_handle::is_attached(), and sum_index_space_handle().

◆ sum_index_space_handle() [4/4]

sheaf::sum_index_space_handle::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.

Precondition

xid_spaces.contains(xname)

conforms_to_state(xid_spaces, xname)

Postcondition

invariant()

is_attached()

&id_spaces() == &xid_spaces

name() == xname

Definition at line 95 of file sum_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=().

◆ ~sum_index_space_handle()

sheaf::sum_index_space_handle::~sum_index_space_handle ( )

virtual

Destructor.

Definition at line 142 of file sum_index_space_handle.cc.

References state().

Referenced by operator=().

Member Function Documentation

◆ binary()

void sheaf::sum_index_space_handle::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.

Precondition

contains_hub(xindex)

Postcondition

contains_term_id(xterm_id)

term(xterm_id).contains(xlocal_id)

Definition at line 582 of file sum_index_space_handle.cc.

References sheaf::sum_index_space_state::binary(), sheaf::explicit_index_space_handle::contains(), sheaf::index_space_handle::contains_hub(), contains_term_id(), simple(), state(), and term().

Referenced by term_id().

◆ clear()

void sheaf::sum_index_space_handle::clear ( )

Deletes all entries.

Postcondition

invariant()

is_empty()

Definition at line 626 of file sum_index_space_handle.cc.

References sheaf::sum_index_space_state::clear(), invariant(), sheaf::index_space_handle::is_empty(), operator=(), and state().

Referenced by simple().

◆ clone()

sheaf::sum_index_space_handle * sheaf::sum_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::explicit_index_space_handle.

Reimplemented in sheaf::hub_index_space_handle.

Definition at line 690 of file sum_index_space_handle.cc.

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

Referenced by operator=().

◆ conforms_to_state()

bool sheaf::sum_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::explicit_index_space_handle.

Reimplemented in sheaf::hub_index_space_handle.

Definition at line 724 of file sum_index_space_handle.cc.

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

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

◆ contains_rep()

bool sheaf::sum_index_space_handle::contains_rep ( pod_type xhub_id ) const

True if and only if hub id xhub_id is the representative member of its equivalence class.

Postcondition

result ? contains_hub(xhub_id) : true

Definition at line 256 of file sum_index_space_handle.cc.

References sheaf::index_space_handle::contains_hub(), sheaf::sum_index_space_state::contains_rep(), contains_unique_rep(), and state().

Referenced by contains_unique_rep(), equivalence_ct(), sheaf::hub_index_space_handle::glue(), sheaf::hub_index_space_handle::unglue(), and sheaf::hub_index_space_handle::unglue_all().

◆ contains_term_id()

bool sheaf::sum_index_space_handle::contains_term_id ( pod_type xi ) const

True if this map contains the xi-th term.

Postcondition

is_basic_query

Definition at line 375 of file sum_index_space_handle.cc.

References sheaf::sum_index_space_state::contains_term_id(), state(), and term().

Referenced by binary(), sheaf::hub_index_space_handle::remove_term(), simple(), term(), term_begin(), term_end(), term_hub_begin(), term_hub_end(), term_id(), and term_id_end().

◆ contains_unique_rep()

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

Postcondition

result ? contains_hub(xhub_id) : true

result ? contains_rep(xhub_id) : true

Definition at line 275 of file sum_index_space_handle.cc.

References sheaf::index_space_handle::contains_hub(), contains_rep(), sheaf::sum_index_space_state::contains_unique_rep(), rep(), and state().

Referenced by contains_rep(), sheaf::hub_index_space_handle::glue(), sheaf::hub_index_space_handle::unglue(), and sheaf::hub_index_space_handle::unglue_all().

◆ equivalence_class()

void sheaf::sum_index_space_handle::equivalence_class	(	pod_type	xhub_id,
		equivalence_class_type &	result
	)		const

The equivalence class associated with the hub id xhub_id.

Precondition

contains_hub(xhub_id)

Postcondition

!result.empty()

Definition at line 214 of file sum_index_space_handle.cc.

References sheaf::index_space_handle::contains_hub(), sheaf::sum_index_space_state::equivalence_class(), equivalence_ct(), and state().

Referenced by state().

◆ equivalence_ct()

sheaf::size_type sheaf::sum_index_space_handle::equivalence_ct ( pod_type xhub_id ) const

The number of members of the equivalence class of hub id xhub_id.

Precondition

contains_hub(xhub_id)

Postcondition

result > 0

Definition at line 235 of file sum_index_space_handle.cc.

References sheaf::index_space_handle::contains_hub(), contains_rep(), sheaf::sum_index_space_state::equivalence_ct(), and state().

Referenced by equivalence_class().

◆ host_rep()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::host_rep ( pod_type xhub_id ) const

The host id associated with the representative member of the equivalence class of hub id xhub_id.

Precondition

contains_hub(xhub_id)

Postcondition

contains(result)

Definition at line 316 of file sum_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::index_space_handle::contains_hub(), sheaf::sum_index_space_state::host_rep(), state(), and term_id_begin().

Referenced by rep().

◆ invariant()

bool sheaf::sum_index_space_handle::invariant ( ) const

virtual

Class invariant.

Invariant

explicit_index_space_handle::invariant()

Reimplemented from sheaf::explicit_index_space_handle.

Reimplemented in sheaf::hub_index_space_handle.

Definition at line 779 of file sum_index_space_handle.cc.

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

Referenced by clear(), sheaf::hub_index_space_handle::invariant(), is_ancestor_of(), operator=(), and sum_index_space_handle().

◆ is_ancestor_of()

bool sheaf::sum_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::explicit_index_space_handle.

Reimplemented in sheaf::hub_index_space_handle.

Definition at line 758 of file sum_index_space_handle.cc.

References invariant().

Referenced by conforms_to_state().

◆ last_term()

const sheaf::index_space_handle & sheaf::sum_index_space_handle::last_term ( ) const

The last term.

Precondition

!is_empty()

Postcondition

is_basic_query

Definition at line 458 of file sum_index_space_handle.cc.

References sheaf::index_space_handle::is_empty(), sheaf::sum_index_space_state::last_term(), state(), and term_begin().

Referenced by sheaf::hub_index_space_handle::extend_last_term(), sheaf::index_space_family::last_term(), and term_of().

◆ operator=() [1/2]

sheaf::sum_index_space_handle & sheaf::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).

Precondition

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

Postcondition

invariant()

(*this) == xother

Definition at line 121 of file sum_index_space_handle.cc.

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

Referenced by clear(), and sum_index_space_handle().

◆ operator=() [2/2]

sheaf::sum_index_space_handle & sheaf::sum_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::explicit_index_space_handle.

Reimplemented in sheaf::hub_index_space_handle.

Definition at line 668 of file sum_index_space_handle.cc.

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

◆ rep()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::rep ( pod_type xhub_id ) const

The representative member of the equivalence class of hub id xhub_id.

Precondition

contains_hub(xhub_id)

Postcondition

is_basic_query

Definition at line 295 of file sum_index_space_handle.cc.

References sheaf::index_space_handle::contains_hub(), host_rep(), sheaf::sum_index_space_state::rep(), and state().

Referenced by contains_unique_rep().

◆ simple()

void sheaf::sum_index_space_handle::simple	(	pod_type	xterm_id,
		pod_type	xlocal_id,
		pod_type &	xindex
	)		const

Converts binary components xterm_id, xlocal_id to simple index xindex.

Precondition

contains_term_id(xterm_id)

term(xterm_id).contains(xlocal_id)

Postcondition

contains_hub(xindex)

Definition at line 604 of file sum_index_space_handle.cc.

References clear(), sheaf::explicit_index_space_handle::contains(), sheaf::index_space_handle::contains_hub(), contains_term_id(), sheaf::sum_index_space_state::simple(), state(), and term().

Referenced by binary().

◆ state() [1/2]

sheaf::sum_index_space_state & sheaf::sum_index_space_handle::state ( )

protected

The sum id space state (mutable version).

Precondition

is_attached()

Postcondition

is_basic_query

Definition at line 161 of file sum_index_space_handle.cc.

References sheaf::explicit_index_space_handle::is_attached().

Referenced by binary(), clear(), conforms_to_state(), contains_rep(), contains_term_id(), contains_unique_rep(), equivalence_class(), equivalence_ct(), host_rep(), last_term(), rep(), simple(), term(), term_begin(), term_end(), term_hub_begin(), term_hub_end(), term_id(), term_id_begin(), term_id_end(), term_of(), and ~sum_index_space_handle().

◆ state() [2/2]

const sheaf::sum_index_space_state & sheaf::sum_index_space_handle::state ( ) const

protected

The sum id space state (const version).

Precondition

is_attached()

Postcondition

is_basic_query

Definition at line 183 of file sum_index_space_handle.cc.

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

◆ term()

const sheaf::index_space_handle & sheaf::sum_index_space_handle::term ( pod_type xi ) const

The xi-th term.

Precondition

contains_term_id(xi)

Postcondition

is_basic_query

Definition at line 394 of file sum_index_space_handle.cc.

References contains_term_id(), state(), sheaf::sum_index_space_state::term(), and term_of().

Referenced by binary(), contains_term_id(), sheaf::hub_index_space_handle::remove_term(), and simple().

◆ term_begin()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_begin ( pod_type xi ) const

Beginning id of the xi-th term.

Precondition

contains_term_id(xi)

Postcondition

is_basic_query

Definition at line 479 of file sum_index_space_handle.cc.

References contains_term_id(), state(), sheaf::sum_index_space_state::term_begin(), and term_end().

Referenced by sheaf::hub_index_space_handle::extend_last_term(), last_term(), and sheaf::hub_index_space_handle::remove_term().

◆ term_end()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_end ( pod_type xi ) const

Ending id of the xi-th term.

Precondition

contains_term_id(xi)

Postcondition

is_basic_query

Definition at line 500 of file sum_index_space_handle.cc.

References contains_term_id(), state(), sheaf::sum_index_space_state::term_end(), and term_hub_begin().

Referenced by sheaf::hub_index_space_handle::remove_term(), and term_begin().

◆ term_hub_begin()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_hub_begin ( pod_type xi ) const

Beginning hub id of the xi-th term.

Precondition

contains_term_id(xi)

Postcondition

is_basic_query

Definition at line 521 of file sum_index_space_handle.cc.

References contains_term_id(), state(), sheaf::sum_index_space_state::term_hub_begin(), and term_hub_end().

Referenced by term_end().

◆ term_hub_end()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_hub_end ( pod_type xi ) const

Ending hub id of the xi-th term.

Precondition

contains_term_id(xi)

Postcondition

is_basic_query

Definition at line 542 of file sum_index_space_handle.cc.

References contains_term_id(), state(), sheaf::sum_index_space_state::term_hub_end(), and term_id().

Referenced by term_hub_begin().

◆ term_id()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_id ( pod_type xid ) const

The id of the term containing id xid.

Postcondition

!is_valid(result) || contains_term_id(result)

Definition at line 563 of file sum_index_space_handle.cc.

References binary(), contains_term_id(), sheaf::is_valid(), state(), and sheaf::sum_index_space_state::term_id().

Referenced by sheaf::hub_index_space_handle::glue(), and term_hub_end().

◆ term_id_begin()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_id_begin ( ) const

Beginning index of the terms in this sum.

Postcondition

is_basic_query

Definition at line 337 of file sum_index_space_handle.cc.

References state(), sheaf::sum_index_space_state::term_id_begin(), and term_id_end().

Referenced by host_rep(), and sheaf::hub_index_space_handle::remove_term().

◆ term_id_end()

sheaf::sum_index_space_handle::pod_type sheaf::sum_index_space_handle::term_id_end ( ) const

Ending index of the terms in this sum.

Postcondition

is_basic_query

Definition at line 356 of file sum_index_space_handle.cc.

References contains_term_id(), state(), and sheaf::sum_index_space_state::term_id_end().

Referenced by sheaf::hub_index_space_handle::extend_last_term(), sheaf::hub_index_space_handle::new_primary_term(), sheaf::hub_index_space_handle::remove_term(), and term_id_begin().

◆ term_of() [1/2]

const sheaf::index_space_handle & sheaf::sum_index_space_handle::term_of ( pod_type xid ) const

The term containing id xid.

Precondition

contains(xid)

Postcondition

is_basic_query

Definition at line 415 of file sum_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), state(), and sheaf::sum_index_space_state::term_of().

Referenced by term(), and sheaf::index_space_family::term_of().

◆ term_of() [2/2]

const sheaf::index_space_handle & sheaf::sum_index_space_handle::term_of ( const scoped_index & xid ) const

The term contains id xid.

Precondition

xid.in_scope()

contains(xid)

Postcondition

is_basic_query

Definition at line 436 of file sum_index_space_handle.cc.

References sheaf::explicit_index_space_handle::contains(), sheaf::scoped_index::in_scope(), last_term(), state(), and sheaf::sum_index_space_state::term_of().

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

SUM_INDEX_SPACE_HANDLE FACET

SUM INDEX SPACE FACET

INDEX_SPACE_HANDLE FACET

HANDLE FACET

ANY FACET

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ equivalence_class_type

Constructor & Destructor Documentation

◆ sum_index_space_handle() [1/4]

◆ sum_index_space_handle() [2/4]

◆ sum_index_space_handle() [3/4]

◆ sum_index_space_handle() [4/4]

◆ ~sum_index_space_handle()

Member Function Documentation

◆ binary()

◆ clear()

◆ clone()

◆ conforms_to_state()

◆ contains_rep()

◆ contains_term_id()

◆ contains_unique_rep()

◆ equivalence_class()

◆ equivalence_ct()

◆ host_rep()

◆ invariant()

◆ is_ancestor_of()

◆ last_term()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rep()

◆ simple()

◆ state() [1/2]

◆ state() [2/2]

◆ term()

◆ term_begin()

◆ term_end()

◆ term_hub_begin()

◆ term_hub_end()

◆ term_id()

◆ term_id_begin()

◆ term_id_end()

◆ term_of() [1/2]

◆ term_of() [2/2]