#include <UpperEdgeGraph.hh>

Inheritance diagram for utility::graph::UEVertex< V, E >:

Public Types
typedef UEVertex< V, E >	VertexClass

typedef UEEdge< V, E >	EdgeClass

typedef UpperEdgeGraph< V, E >	GraphClass

typedef utility::vector1< EdgeClass >	UpperEdgeVector

typedef utility::vector1< EdgeClass >::iterator	UpperEdgeListIter

typedef utility::vector1< EdgeClass >::const_iterator	UpperEdgeListConstIter

Public Member Functions
	UEVertex (GraphClass *owner, platform::Size index)
	standard constructor; though if vertices are to be allocated in a single vector1, then this ctor requires creating and destroying an anonymous vertex to add each vertex to the graph... wasteful More...

	UEVertex ()
	default constructor; useful for allocating all vertices at once in a single vector1 using the resize() method. Note that both index_ and owner_ are set to 0. This state must be corrected before the vertex is of any use. More...

	~UEVertex () override=default
	dstor, should be non-virtual More...

void	reserve_edge_space ()
	reserves space for the edges. Due to the nature of vertex construction in the UEGraph, this method should be called separately from the constructor. More...

EdgeClass *	get_edge (platform::Size upper_vertex_id)

EdgeClass const *	get_edge (platform::Size upper_vertex_id) const

bool	edge_exists (platform::Size upper_vertex_id)

UpperEdgeListIter	upper_edge_list_begin ()

UpperEdgeListIter	upper_edge_list_end ()

UpperEdgeListConstIter	const_upper_edge_list_begin () const

UpperEdgeListConstIter	const_upper_edge_list_end () const

platform::Size	num_upper_neighbors () const

platform::Size	num_lower_neighbors () const

platform::Size	num_neighbors () const

platform::Size	num_neighbors_counting_self () const

void	drop_all_edges ()

V &	data ()

V const &	data () const

Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...

virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...

	VirtualBase (VirtualBase const &)=default

	VirtualBase (VirtualBase &&)=default

VirtualBase &	operator= (VirtualBase const &)=default

VirtualBase &	operator= (VirtualBase &&)=default

Private Member Functions
void	set_index_and_owner (platform::Size index, GraphClass *owner)
	method for completing the construction of a vertex if the defaul ctor was used. More...

void	add_edge (platform::Size upper_vertex_index)
	add an edge More...

void	add_edge (platform::Size upper_vertex_index, E const &edge_data)

void	note_upper_edge_deleted ()

void	note_lower_edge_deleted ()

void	note_lower_edge_added ()

void	make_edge_vector_current () const

void	add_edge_common ()

Private Attributes
platform::Size	index_

UpperEdgeVector	upper_edges_

platform::Size	num_upper_edges_

platform::Size	num_lower_edges_

bool	lazily_deleted_edges_present_

GraphClass *	owner_

V	data_

Friends
class	UEEdge< V, E >

class	UpperEdgeGraph< V, E >

Member Typedef Documentation

◆ EdgeClass

template<class V , class E >

typedef UEEdge< V, E > utility::graph::UEVertex< V, E >::EdgeClass

◆ GraphClass

template<class V , class E >

typedef UpperEdgeGraph< V, E > utility::graph::UEVertex< V, E >::GraphClass

◆ UpperEdgeListConstIter

template<class V , class E >

typedef utility::vector1< EdgeClass >::const_iterator utility::graph::UEVertex< V, E >::UpperEdgeListConstIter

◆ UpperEdgeListIter

template<class V , class E >

typedef utility::vector1< EdgeClass >::iterator utility::graph::UEVertex< V, E >::UpperEdgeListIter

◆ UpperEdgeVector

template<class V , class E >

typedef utility::vector1< EdgeClass > utility::graph::UEVertex< V, E >::UpperEdgeVector

◆ VertexClass

template<class V , class E >

typedef UEVertex< V, E > utility::graph::UEVertex< V, E >::VertexClass

Constructor & Destructor Documentation

◆ UEVertex() [1/2]

template<class V , class E >

utility::graph::UEVertex< V, E >::UEVertex	(	GraphClass *	owner,
		platform::Size	index
	)

inline

standard constructor; though if vertices are to be allocated in a single vector1, then this ctor requires creating and destroying an anonymous vertex to add each vertex to the graph... wasteful

References utility::graph::UEVertex< V, E >::upper_edges_.

◆ UEVertex() [2/2]

template<class V , class E >

utility::graph::UEVertex< V, E >::UEVertex ( )

inline

default constructor; useful for allocating all vertices at once in a single vector1 using the resize() method. Note that both index_ and owner_ are set to 0. This state must be corrected before the vertex is of any use.

References utility::graph::UEVertex< V, E >::upper_edges_.

◆ ~UEVertex()

template<class V , class E >

utility::graph::UEVertex< V, E >::~UEVertex ( )

overridedefault

dstor, should be non-virtual

Member Function Documentation

◆ add_edge() [1/2]

template<class V , class E >

void utility::graph::UEVertex< V, E >::add_edge ( platform::Size upper_vertex_index )

inlineprivate

add an edge

do not try to use this method or the other add_edge method to add edges to a vertex; they are for class UpperEdgeGraph only. Invoke add_edge on the graph itself.

References utility::graph::UEVertex< V, E >::add_edge_common(), utility::graph::UEVertex< V, E >::index_, utility::graph::UEVertex< V, E >::owner_, and utility::graph::UEVertex< V, E >::upper_edges_.

◆ add_edge() [2/2]

template<class V , class E >

void utility::graph::UEVertex< V, E >::add_edge	(	platform::Size	upper_vertex_index,
		E const &	edge_data
	)

inlineprivate

References utility::graph::UEVertex< V, E >::add_edge_common(), utility::graph::UEVertex< V, E >::index_, utility::graph::UEVertex< V, E >::owner_, and utility::graph::UEVertex< V, E >::upper_edges_.

◆ add_edge_common()

template<class V , class E >

void utility::graph::UEVertex< V, E >::add_edge_common ( )

inlineprivate

References utility::graph::UEVertex< V, E >::num_upper_edges_.

Referenced by utility::graph::UEVertex< V, E >::add_edge().

◆ const_upper_edge_list_begin()

template<class V , class E >

UpperEdgeListConstIter utility::graph::UEVertex< V, E >::const_upper_edge_list_begin ( ) const

inline

References utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::upper_edges_.

Referenced by utility::graph::UpperEdgeGraph< V, E >::copy_from().

◆ const_upper_edge_list_end()

template<class V , class E >

UpperEdgeListConstIter utility::graph::UEVertex< V, E >::const_upper_edge_list_end ( ) const

inline

References utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::upper_edges_.

Referenced by utility::graph::UpperEdgeGraph< V, E >::copy_from().

◆ data() [1/2]

template<class V , class E >

V& utility::graph::UEVertex< V, E >::data ( )

inline

References utility::graph::UEVertex< V, E >::data_.

Referenced by MetalSiteFinderMover::apply().

◆ data() [2/2]

template<class V , class E >

V const& utility::graph::UEVertex< V, E >::data ( ) const

inline

References utility::graph::UEVertex< V, E >::data_.

◆ drop_all_edges()

template<class V , class E >

void utility::graph::UEVertex< V, E >::drop_all_edges ( )

inline

References utility::graph::UEVertex< V, E >::lazily_deleted_edges_present_, utility::graph::UEVertex< V, E >::num_lower_edges_, utility::graph::UEVertex< V, E >::num_upper_edges_, and utility::graph::UEVertex< V, E >::upper_edges_.

◆ edge_exists()

template<class V , class E >

bool utility::graph::UEVertex< V, E >::edge_exists ( platform::Size upper_vertex_id )

inline

References create_a3b_hbs::ii, utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::upper_edges_.

Referenced by BacksideHbondFinderMover::apply(), and MetalSiteFinderMover::apply().

◆ get_edge() [1/2]

template<class V , class E >

EdgeClass* utility::graph::UEVertex< V, E >::get_edge ( platform::Size upper_vertex_id )

inline

References create_a3b_hbs::ii, utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::upper_edges_.

Referenced by utility::graph::UEVertex< V, E >::get_edge().

◆ get_edge() [2/2]

template<class V , class E >

EdgeClass const* utility::graph::UEVertex< V, E >::get_edge ( platform::Size upper_vertex_id ) const

inline

References utility::graph::UEVertex< V, E >::get_edge().

◆ make_edge_vector_current()

template<class V , class E >

void utility::graph::UEVertex< V, E >::make_edge_vector_current ( ) const

inlineprivate

References debug_assert, create_a3b_hbs::ii, utility::graph::UEVertex< V, E >::lazily_deleted_edges_present_, utility::graph::UEVertex< V, E >::num_upper_edges_, shift, and utility::graph::UEVertex< V, E >::upper_edges_.

Referenced by utility::graph::UEVertex< V, E >::const_upper_edge_list_begin(), utility::graph::UEVertex< V, E >::const_upper_edge_list_end(), utility::graph::UEVertex< V, E >::edge_exists(), utility::graph::UEVertex< V, E >::get_edge(), utility::graph::UEVertex< V, E >::upper_edge_list_begin(), and utility::graph::UEVertex< V, E >::upper_edge_list_end().

◆ note_lower_edge_added()

template<class V , class E >

void utility::graph::UEVertex< V, E >::note_lower_edge_added ( )

inlineprivate

References utility::graph::UEVertex< V, E >::num_lower_edges_.

Referenced by utility::graph::UEEdge< V, E >::UEEdge().

◆ note_lower_edge_deleted()

template<class V , class E >

void utility::graph::UEVertex< V, E >::note_lower_edge_deleted ( )

inlineprivate

References utility::graph::UEVertex< V, E >::num_lower_edges_.

Referenced by utility::graph::UEEdge< V, E >::delete_edge().

◆ note_upper_edge_deleted()

template<class V , class E >

void utility::graph::UEVertex< V, E >::note_upper_edge_deleted ( )

inlineprivate

References utility::graph::UEVertex< V, E >::lazily_deleted_edges_present_, and utility::graph::UEVertex< V, E >::num_upper_edges_.

Referenced by utility::graph::UEEdge< V, E >::delete_edge().

◆ num_lower_neighbors()

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::num_lower_neighbors ( ) const

inline

References utility::graph::UEVertex< V, E >::num_lower_edges_.

◆ num_neighbors()

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::num_neighbors ( ) const

inline

References utility::graph::UEVertex< V, E >::num_lower_edges_, and utility::graph::UEVertex< V, E >::num_upper_edges_.

◆ num_neighbors_counting_self()

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::num_neighbors_counting_self ( ) const

inline

References utility::graph::UEVertex< V, E >::num_lower_edges_, and utility::graph::UEVertex< V, E >::num_upper_edges_.

◆ num_upper_neighbors()

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::num_upper_neighbors ( ) const

inline

References utility::graph::UEVertex< V, E >::num_upper_edges_.

◆ reserve_edge_space()

template<class V , class E >

void utility::graph::UEVertex< V, E >::reserve_edge_space ( )

inline

reserves space for the edges. Due to the nature of vertex construction in the UEGraph, this method should be called separately from the constructor.

class V must define a static member "NUM_EDGES_TO_RESERVE()"; the UEVertex constructor allocates space for that many edges – if fewer than that many edges are added to a sigle node, then new() need never be called. if more are added, the class does not crash – it simply grows the vector out

References utility::graph::UEVertex< V, E >::upper_edges_.

◆ set_index_and_owner()

template<class V , class E >

void utility::graph::UEVertex< V, E >::set_index_and_owner	(	platform::Size	index,
		GraphClass *	owner
	)

inlineprivate

method for completing the construction of a vertex if the defaul ctor was used.

to be called by class UEGraph only

References debug_assert, utility::graph::UEVertex< V, E >::index_, and utility::graph::UEVertex< V, E >::owner_.

◆ upper_edge_list_begin()

template<class V , class E >

UpperEdgeListIter utility::graph::UEVertex< V, E >::upper_edge_list_begin ( )

inline

References utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::upper_edges_.

◆ upper_edge_list_end()

template<class V , class E >

UpperEdgeListIter utility::graph::UEVertex< V, E >::upper_edge_list_end ( )

inline

References utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::upper_edges_.

Friends And Related Function Documentation

◆ UEEdge< V, E >

template<class V , class E >

friend class UEEdge< V, E >

friend

◆ UpperEdgeGraph< V, E >

template<class V , class E >

friend class UpperEdgeGraph< V, E >

friend

Member Data Documentation

◆ data_

template<class V , class E >

V utility::graph::UEVertex< V, E >::data_

private

Referenced by utility::graph::UEVertex< V, E >::data().

◆ index_

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::index_

private

Referenced by utility::graph::UEVertex< V, E >::add_edge(), and utility::graph::UEVertex< V, E >::set_index_and_owner().

◆ lazily_deleted_edges_present_

template<class V , class E >

bool utility::graph::UEVertex< V, E >::lazily_deleted_edges_present_

mutableprivate

Referenced by utility::graph::UEVertex< V, E >::drop_all_edges(), utility::graph::UEVertex< V, E >::make_edge_vector_current(), and utility::graph::UEVertex< V, E >::note_upper_edge_deleted().

◆ num_lower_edges_

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::num_lower_edges_

private

Referenced by utility::graph::UEVertex< V, E >::drop_all_edges(), utility::graph::UEVertex< V, E >::note_lower_edge_added(), utility::graph::UEVertex< V, E >::note_lower_edge_deleted(), utility::graph::UEVertex< V, E >::num_lower_neighbors(), utility::graph::UEVertex< V, E >::num_neighbors(), and utility::graph::UEVertex< V, E >::num_neighbors_counting_self().

◆ num_upper_edges_

template<class V , class E >

platform::Size utility::graph::UEVertex< V, E >::num_upper_edges_

private

Referenced by utility::graph::UEVertex< V, E >::add_edge_common(), utility::graph::UEVertex< V, E >::drop_all_edges(), utility::graph::UEVertex< V, E >::make_edge_vector_current(), utility::graph::UEVertex< V, E >::note_upper_edge_deleted(), utility::graph::UEVertex< V, E >::num_neighbors(), utility::graph::UEVertex< V, E >::num_neighbors_counting_self(), and utility::graph::UEVertex< V, E >::num_upper_neighbors().

◆ owner_

template<class V , class E >

GraphClass* utility::graph::UEVertex< V, E >::owner_

private

Referenced by utility::graph::UEVertex< V, E >::add_edge(), and utility::graph::UEVertex< V, E >::set_index_and_owner().

◆ upper_edges_

template<class V , class E >

UpperEdgeVector utility::graph::UEVertex< V, E >::upper_edges_

mutableprivate

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

src/utility/graph/UpperEdgeGraph.fwd.hh
src/utility/graph/UpperEdgeGraph.hh

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Member Typedef Documentation

◆ EdgeClass

◆ GraphClass

◆ UpperEdgeListConstIter

◆ UpperEdgeListIter

◆ UpperEdgeVector

◆ VertexClass

Constructor & Destructor Documentation

◆ UEVertex() [1/2]

◆ UEVertex() [2/2]

◆ ~UEVertex()

Member Function Documentation

◆ add_edge() [1/2]

◆ add_edge() [2/2]

◆ add_edge_common()

◆ const_upper_edge_list_begin()

◆ const_upper_edge_list_end()

◆ data() [1/2]

◆ data() [2/2]

◆ drop_all_edges()

◆ edge_exists()

◆ get_edge() [1/2]

◆ get_edge() [2/2]

◆ make_edge_vector_current()

◆ note_lower_edge_added()

◆ note_lower_edge_deleted()

◆ note_upper_edge_deleted()

◆ num_lower_neighbors()

◆ num_neighbors()

◆ num_neighbors_counting_self()

◆ num_upper_neighbors()

◆ reserve_edge_space()

◆ set_index_and_owner()

◆ upper_edge_list_begin()

◆ upper_edge_list_end()

Friends And Related Function Documentation

◆ UEEdge< V, E >

◆ UpperEdgeGraph< V, E >

Member Data Documentation

◆ data_

◆ index_

◆ lazily_deleted_edges_present_

◆ num_lower_edges_

◆ num_upper_edges_

◆ owner_

◆ upper_edges_