#include <TenANeighborGraph.hh>

Inheritance diagram for core::scoring::TenANeighborNode:

Collaboration diagram for core::scoring::TenANeighborNode:

Public Types
typedef graph::Node	parent

Public Types inherited from core::graph::Node
typedef EdgeListIterator	EdgeListIter

typedef EdgeListConstIterator	EdgeListConstIter

Public Member Functions
virtual	~TenANeighborNode ()

	TenANeighborNode (graph::Graph *, Size node_id)

virtual void	copy_from (Node const *source)
	invoked during graph assignment operators to copy any node data from one graph to another graph. The source node must be the same type as this node. More...

virtual Size	count_static_memory () const
	memory accounting scheme More...

virtual Size	count_dynamic_memory () const
	memory accounting scheme More...

void	neighbor_mass (Real mass)
	set the neighbor mass for a vertex More...

Real	neighbor_mass () const
	return the neighbor mass for a vertex More...

Real	sum_of_neighbors_masses () const

void	add_neighbors_mass (Real neighbors_mass)
	To be called by TenANeighborEdge only called at the time of edge addition. More...

void	subtract_neighbors_mass (Real neighbors_mass)
	To be called by TenANeighborEdge only called at the time of edge deletion. More...

Public Member Functions inherited from core::graph::Node
virtual	~Node ()
	virtual destructor More...

	Node (Graph *, platform::Size node_id)
	Main constructor, no default constructor nor copy constructor. More...

void	add_edge (Edge *edge_ptr, EdgeListIter &)
	adds edge pointer to edge list; returns an iterator to the new list element More...

void	drop_edge (EdgeListIter edge_iterator)
	removes an edge iterator from the node's edge list. Only called by Edge class. More...

void	drop_all_edges ()
	deletes all edges incident upon this node More...

void	set_num_neighbors_counting_self_static (platform::Size neighbor)

Edge const *	find_edge (platform::Size other_node_index) const
	a "slow" (linear) search for an edge. More...

Edge *	find_edge (platform::Size other_node_index)
	non-const edge finding method; changes no data, but returns a non-const pointer More...

virtual void	print () const
	send summaray data about this node to the screen More...

EdgeListIter	edge_list_begin ()
	returns a non-const iterator to the beginning of its edge list More...

EdgeListConstIter	const_edge_list_begin () const
	returns a const iterator to the beginning of its edge list More...

EdgeListIter	edge_list_end ()
	returns a non-const iterator to the end of its edge list More...

EdgeListConstIter	const_edge_list_end () const
	returns a const iterator to the end of its edge list More...

EdgeListIter	lower_edge_list_begin ()
	returns a non-const iterator to the beginning of its lower-edge list More...

EdgeListConstIter	const_lower_edge_list_begin () const
	returns a const iterator to the beginning of its lower-edge list More...

EdgeListIter	lower_edge_list_end ()
	returns a non-const iterator to the end of its lower-edge list More...

EdgeListConstIter	const_lower_edge_list_end () const
	returns a const iterator to the end of its lower-edge list More...

EdgeListIter	upper_edge_list_begin ()
	returns a non-const iterator to the beginning of its upper-edge list More...

EdgeListConstIter	const_upper_edge_list_begin () const
	returns a const iterator to the beginning of its upper-edge list More...

EdgeListIter	upper_edge_list_end ()
	returns a non-const iterator to the end of its upper-edge list More...

EdgeListConstIter	const_upper_edge_list_end () const
	returns a const iterator to the end of its upper-edge list More...

platform::Size	get_node_index () const
	the index for this node More...

platform::Size	num_edges () const
	the number of edges incident on this node, which may include a loop edge More...

platform::Size	num_neighbors_counting_self () const
	the number of neighbors counting "self" as a neighbor. More...

platform::Size	num_neighbors_counting_self_static () const
	the number of neighbors counting "self" as neighbor. Defaults to num_neighbors_counting_self() but can be set to other values as well. Useful in calculation of symmetrical structures. More...

platform::Size	get_num_edges_to_smaller_indexed_nodes () const
	the number of lower neighbors More...

platform::Size	get_num_edges_to_larger_indexed_nodes () const
	the number of upper neighbors – which "self" neighborness is counted if a loop edge is present More...

bool	loop_incident () const
	NOTE TO SELF: remove loop support. More...

Private Member Functions
void	update_neighbor_mass_sum () const

Private Attributes
Real	neighbor_mass_

Real	sum_of_neighbors_masses_

Size	since_last_sonm_update_

Static Private Attributes
static Size const	TIME_TO_UPDATE = 1024

Additional Inherited Members
Protected Member Functions inherited from core::graph::Node
Graph *	get_owner () const
	derived class access to the owner More...

Detailed Description

Definition at line 34 of file TenANeighborGraph.hh.

Member Typedef Documentation

typedef graph::Node core::scoring::TenANeighborNode::parent

Definition at line 37 of file TenANeighborGraph.hh.

Constructor & Destructor Documentation

core::scoring::TenANeighborNode::~TenANeighborNode ( )

virtual

Definition at line 32 of file TenANeighborGraph.cc.

core::scoring::TenANeighborNode::TenANeighborNode	(	graph::Graph *	owner,
		Size	node_id
	)

Definition at line 34 of file TenANeighborGraph.cc.

Referenced by count_static_memory().

Member Function Documentation

void core::scoring::TenANeighborNode::add_neighbors_mass ( Real neighbors_mass)

inline

To be called by TenANeighborEdge only called at the time of edge addition.

Definition at line 67 of file TenANeighborGraph.hh.

References since_last_sonm_update_, and sum_of_neighbors_masses_.

Referenced by core::scoring::TenANeighborEdge::TenANeighborEdge().

void core::scoring::TenANeighborNode::copy_from ( Node const * source)

virtual

invoked during graph assignment operators to copy any node data from one graph to another graph. The source node must be the same type as this node.

copy-from for use in Graph::operator= and copy ctors; derived classes must define their own version of this function

Reimplemented from core::graph::Node.

Definition at line 43 of file TenANeighborGraph.cc.

References neighbor_mass_, since_last_sonm_update_, and sum_of_neighbors_masses_.

Size core::scoring::TenANeighborNode::count_dynamic_memory ( ) const

virtual

memory accounting scheme

recursively descend through heirarchy accounting for heap memory usage. Each derived class in the heirarchy should recursively add the amount of dynamic memory its parent allocates by calling parent::count_dynamic_memory

Reimplemented from core::graph::Node.

Definition at line 72 of file TenANeighborGraph.cc.

References core::graph::Node::count_dynamic_memory().

Size core::scoring::TenANeighborNode::count_static_memory ( ) const

virtual

memory accounting scheme

called on most-derived class. The most-derived class should NOT recursively call this method on its parent class. The sizeof function will handle the whole Node (or DerivedNode).

Reimplemented from core::graph::Node.

Definition at line 66 of file TenANeighborGraph.cc.

References TenANeighborNode().

void core::scoring::TenANeighborNode::neighbor_mass ( Real mass)

set the neighbor mass for a vertex

triggers update of the neighbor mass sums for this nodes' neighbors

Definition at line 54 of file TenANeighborGraph.cc.

References core::graph::Node::const_edge_list_begin(), core::graph::Node::const_edge_list_end(), core::graph::Node::get_node_index(), neighbor_mass_, and update_neighbor_mass_sum().

Real core::scoring::TenANeighborNode::neighbor_mass ( ) const

inline

return the neighbor mass for a vertex

Definition at line 53 of file TenANeighborGraph.hh.