This is a vertex of a Directed Graph (DG) More...

#include <dgvertex.h>

Inheritance diagram for libint2::DGVertex:

Collaboration diagram for libint2::DGVertex:

Public Types
typedef MemoryManager::Address	Address
	The address on the stack during computation is described using this type.

typedef MemoryManager::Size	Size
	The size of a block the stack during computation is described using this type.

typedef NotSet< Address >	AddressNotSet
	Exception thrown if address is not set.

typedef NotSet< std::string >	GraphLabelNotSet
	Exception thrown if graph label is not set.

typedef NotSet< std::string >	SymbolNotSet
	Exception thrown if code symbol is not set.

typedef KeyTypes::ClassID	ClassID
	Type identifier.

typedef KeyTypes::InstanceID	InstanceID
	Instance identifier.

typedef KeyTypes::InstanceID	KeyType
	DGVertex provides function key() which computes key of type KeyType and returns it using KeyReturnType.

typedef Hashable< KeyType, ComputeKey >::KeyReturnType	KeyReturnType

typedef std::list< std::shared_ptr< DGArc > >	ArcSetType
	ArcSetType is a container used to maintain entry and exit arcs.

Public Types inherited from libint2::Hashable< KeyTypes::InstanceID, ComputeKey >
typedef KeyTraits< KeyTypes::InstanceID >::ReturnType	KeyReturnType

Public Member Functions
	DGVertex (ClassID tid)
	Sets typeid to tid.

	DGVertex (ClassID tid, const std::vector< std::shared_ptr< DGArc > > &parents, const std::vector< std::shared_ptr< DGArc > > &children)
	Sets typeid to tid.

	DGVertex (const DGVertex &v)
	This is a copy constructor.

void	make_a_target ()
	make_a_target() marks this vertex as a target

bool	is_a_target () const
	is_a_target() returns true if this vertex is a target

virtual void	add_exit_arc (const std::shared_ptr< DGArc > &)
	add_exit_arc(arc) adds arc as an arc connecting to children of this vertex.

virtual void	del_exit_arcs ()
	del_exit_arcs() removes all exit arcs from this and corresponding children vertices.

void	replace_exit_arc (const std::shared_ptr< DGArc > &A, const std::shared_ptr< DGArc > &B)
	replace_exit_arc() replaces A with B.

void	detach ()
	this function detaches the vertex from other vertices.

const ArcSetType &	exit_arcs () const

const ArcSetType &	entry_arcs () const

unsigned int	num_entry_arcs () const
	returns the number of parents

ArcSetType::const_iterator	first_entry_arc () const
	returns parents::begin()

ArcSetType::const_iterator	plast_entry_arc () const
	returns parents::end()

unsigned int	num_exit_arcs () const
	returns the number of children

ArcSetType::const_iterator	first_exit_arc () const
	returns children::begin()

ArcSetType::const_iterator	plast_exit_arc () const
	returns children::end()

const std::shared_ptr< DGArc > &	exit_arc (const std::shared_ptr< DGVertex > &v) const
	return arc connecting this to v, otherwise null pointer

virtual KeyReturnType	key () const =0
	computes key

virtual bool	equiv (const std::shared_ptr< DGVertex > &) const =0
	equiv(const DGVertex* aVertex) returns true if this vertex is equivalent to *aVertex.

bool	precomputed () const
	precomputed() returns whether this DGVertex is precomputed.

virtual unsigned int	size () const =0
	Returns the amount of memory (in floating-point words) to be allocated for the vertex.

virtual const std::string &	label () const =0
	label() returns a unique, short, descriptive label of DGVertex (e.g.

virtual const std::string &	id () const =0
	id() returns a very short label of DGVertex which is (almost) guaranteed to be a symbol (e.g.

virtual std::string	description () const =0
	description() returns a full, human-readable description of DGVertex (e.g.

virtual void	print (std::ostream &os) const
	print(os) prints vertex info to os

const DirectedGraph *	dg () const
	Returns pointer to the DirectedGraph to which this DGVertex belongs to.

void	dg (const DirectedGraph *d)
	Sets pointer to the DirectedGraph to which this DGVertex belongs to.

const std::string &	graph_label () const
	returns the label used for this vertex when visualizing graph.

void	set_graph_label (const std::string &graph_label)
	sets the graph label

const std::shared_ptr< DRTree > &	subtree () const
	Returns the subtree to which this vertex belongs.

void	refer_this_to (const std::shared_ptr< DGVertex > &V)
	refer_this_to(V) makes this vertex act like a reference to V so that calls to symbol() and address() report code symbol and stack address of V

bool	refers_to_another () const
	refers to another vertex?

const std::string &	symbol () const
	returns the code symbol. can throw SymbolNotSet

void	set_symbol (const std::string &symbol)
	sets the code symbol

bool	symbol_set () const
	returns true if the symbol has been set

void	reset_symbol ()
	this function void the symbol, i.e.

Address	address () const
	returns the address of this quantity on Libint's stack.

void	set_address (const Address &address)
	sets the address of this quantity on Libint's stack

bool	address_set () const
	returns true if the address has been set

void	need_to_compute (bool ntc)
	indicates whether this vertex needs to be computed.

void	not_need_to_compute ()
	shortcut to need_to_compute(false)

bool	need_to_compute () const
	returns true if this index needs to be computed.

bool	declared () const

void	declared (bool d)

void	prepare_to_traverse ()
	prepare_to_traverse() must be called before traversal of the graph starts

unsigned int	tag ()
	tag() tags the vertex and returns the total number of tags this vertex has received

void	schedule ()
	schedule() marks the vertex as scheduled, hence its code exists

bool	scheduled () const
	scheduled() returns true if the vertex has been scheduled

std::shared_ptr< DGVertex >	postcalc () const
	Returns pointer to vertex to be computed after this vertex, 0 if this is the last vertex.

void	set_postcalc (const std::shared_ptr< DGVertex > &postcalc)
	Sets postcalc.

void	reset ()
	Resets the vertex, releasing all arcs.

virtual void	unregister () const
	If vertex is a singleton then remove it from the SingletonManager.

virtual bool	this_precomputed () const =0
	this_precomputed() is used by precomputed() to determine whether this object really is precomputed.

Public Attributes
ClassID	typeid_
	typeid stores the ClassID of the concrete type.

InstanceID	instid_
	instid stores the InstanceID of the object.

Friends
void	DRTree::add_vertex (const std::shared_ptr< DGVertex > &vertex)
	Only DRTree::set_subtree and DRTree::detach_from can change subtree_.

void	DRTree::detach_from (const std::shared_ptr< DGVertex > &v)

Additional Inherited Members
Protected Attributes inherited from libint2::Hashable< KeyTypes::InstanceID, ComputeKey >
KeyStore< KeyTypes::InstanceID, OwnKey< KeyMP >::result >	key_

Detailed Description

This is a vertex of a Directed Graph (DG)

Member Function Documentation

◆ add_exit_arc()

void DGVertex::add_exit_arc ( const std::shared_ptr< DGArc > & arc )

virtual

add_exit_arc(arc) adds arc as an arc connecting to children of this vertex.

Thus, arcs are owned by their PARENTS. This function is virtual because certain types of vertices have duplicate references to children in their definition (such as AlgebraicOperator). Such DGVertices need to update their private members.

Reimplemented in libint2::AlgebraicOperator< T >, and libint2::AlgebraicOperator< T >.

Referenced by libint2::AlgebraicOperator< T >::add_exit_arc().

◆ address()

DGVertex::Address DGVertex::address ( ) const

returns the address of this quantity on Libint's stack.

can throw AddressNotSet

References address(), and address_set().

Referenced by address(), print(), and set_address().

◆ del_exit_arcs()

void DGVertex::del_exit_arcs ( )

virtual

del_exit_arcs() removes all exit arcs from this and corresponding children vertices.

See documentation for del_exit_arc().

Reimplemented in libint2::AlgebraicOperator< T >.

References num_exit_arcs().

Referenced by detach().

◆ description()

virtual std::string libint2::DGVertex::description ( ) const

pure virtual

description() returns a full, human-readable description of DGVertex (e.g.

"This is a ( p_x s | 1/r_{12} | d_xy s )^{(1)} integral"). returned by value since not guaranteed to be cached.

Referenced by refer_this_to(), set_symbol(), and symbol().

◆ detach()

void DGVertex::detach ( )

this function detaches the vertex from other vertices.

It cannot safely remove entry arcs, so the user must previously delete or replace them (see documentation for del_exit_arc()). can throw CannotPerformOperation.

References del_exit_arcs(), and num_entry_arcs().

◆ dg()

void libint2::DGVertex::dg ( const DirectedGraph * d )

inline

Sets pointer to the DirectedGraph to which this DGVertex belongs to.

Should be used with utmost caution

◆ equiv()

virtual bool libint2::DGVertex::equiv ( const std::shared_ptr< DGVertex > & ) const

pure virtual

equiv(const DGVertex* aVertex) returns true if this vertex is equivalent to *aVertex.

Referenced by refer_this_to().

◆ graph_label()

const std::string & DGVertex::graph_label ( ) const

returns the label used for this vertex when visualizing graph.

can throw GraphLabelNotSet.

◆ id()

virtual const std::string & libint2::DGVertex::id ( ) const

pure virtual

id() returns a very short label of DGVertex which is (almost) guaranteed to be a symbol (e.g.

"(p_x s|d_xy s)^1")

◆ key()

virtual KeyReturnType libint2::DGVertex::key ( ) const

pure virtual

computes key

Implements libint2::Hashable< KeyTypes::InstanceID, ComputeKey >.

◆ label()

virtual const std::string & libint2::DGVertex::label ( ) const

pure virtual

label() returns a unique, short, descriptive label of DGVertex (e.g.

"( p_x s | 1/r_{12} | d_xy s )^{(1)}")

Referenced by libint2::DirectedGraph::append_vertex(), print(), and set_graph_label().

◆ need_to_compute()

void DGVertex::need_to_compute ( bool ntc )

indicates whether this vertex needs to be computed.

Even if this vertex is not precomputed, it may not be desired to compute it. By default, all vertices need to be computed.

Referenced by need_to_compute().

◆ precomputed()

bool DGVertex::precomputed ( ) const

precomputed() returns whether this DGVertex is precomputed.

See this_precomputed() for description.

References precomputed(), and this_precomputed().

Referenced by precomputed(), and print().

◆ print()

void DGVertex::print ( std::ostream & os ) const

virtual

print(os) prints vertex info to os

Reimplemented in libint2::AlgebraicOperator< T >.

References address(), address_set(), first_entry_arc(), first_exit_arc(), label(), num_entry_arcs(), num_exit_arcs(), plast_entry_arc(), plast_exit_arc(), postcalc(), precomputed(), size(), symbol(), and symbol_set().

Referenced by libint2::AlgebraicOperator< T >::print().

◆ replace_exit_arc()

void DGVertex::replace_exit_arc	(	const std::shared_ptr< DGArc > &	A,
		const std::shared_ptr< DGArc > &	B )

replace_exit_arc() replaces A with B.

See documentation for del_exit_arc().

◆ reset_symbol()

void DGVertex::reset_symbol ( )

this function void the symbol, i.e.

it is no longer set after calling this member

Referenced by reset().

◆ size()

virtual unsigned int libint2::DGVertex::size ( ) const

pure virtual

Returns the amount of memory (in floating-point words) to be allocated for the vertex.

Referenced by print().

◆ this_precomputed()

virtual bool libint2::DGVertex::this_precomputed ( ) const

pure virtual

this_precomputed() is used by precomputed() to determine whether this object really is precomputed.

E.g. (ss|ss) shell is considered not precomputed, i.e. this_precomputed() will return false. But the (ss|ss) integral is considered precomputed. Usually the shell vertex will refer to the integral vertex. Thus calling precomputed() on it will return true.

Referenced by precomputed().

◆ unregister()

void DGVertex::unregister ( ) const

virtual

If vertex is a singleton then remove it from the SingletonManager.

Must be reimplemented in derived singleton class

Member Data Documentation

◆ instid_

InstanceID libint2::DGVertex::instid_

instid stores the InstanceID of the object.

Only makes sense for Singletons. For other objects it's zero. Can be used to compare objects quickly.

◆ typeid_

ClassID libint2::DGVertex::typeid_

typeid stores the ClassID of the concrete type.

It is used to check quickly whether 2 DGVertices are of the same type. Dynamic casts are too expensive.

Referenced by libint2::AlgebraicOperator< T >::equiv(), libint2::RTimeEntity< T >::equiv(), and libint2::CTimeEntity< T >::equiv().

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

dgvertex.h
dgvertex.cc

Public Types

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_exit_arc()

◆ address()

◆ del_exit_arcs()

◆ description()

◆ detach()

◆ dg()

◆ equiv()

◆ graph_label()

◆ id()

◆ key()

◆ label()

◆ need_to_compute()

◆ precomputed()

◆ print()

◆ replace_exit_arc()

◆ reset_symbol()

◆ size()

◆ this_precomputed()

◆ unregister()

Member Data Documentation

◆ instid_

◆ typeid_