Rosetta Core  2014.35
Public Types | Public Member Functions | List of all members
core::scoring::TwelveANeighborEdge Class Reference

#include <TwelveANeighborGraph.hh>

Public Types

typedef graph::Edge parent
 
- Public Types inherited from core::graph::Edge
typedef EdgeListIterator EdgeListIter
 

Public Member Functions

virtual ~TwelveANeighborEdge ()
 
 TwelveANeighborEdge (graph::Graph *owner, Size first_node_ind, Size second_node_ind)
 
virtual void copy_from (graph::Edge const *source)
 copy-from for use in Graph::operator= and copy ctors More...
 
virtual Size count_static_memory () const
 how much memory is statically allocated by this edge More...
 
virtual Size count_dynamic_memory () const
 how much memory is dynamically allocated by this edge – must be recursively invoked by a derived class. More...
 
- Public Member Functions inherited from core::graph::Edge
virtual ~Edge ()
 destructor More...
 
 Edge (Graph *owner, platform::Size first_node_ind, platform::Size second_node_ind)
 Main edge constructor. This should only be invoked by create_new_edge, which itself is only called by add_edge. The ONLY way an edge should be added to a graph is through add_edge. NOTE: edges should be only be deleted by a call to the Graph's delete_edge method, and this method absolutely must be implemented by derived Graph classes. More...
 
platform::Size get_other_ind (platform::Size node_index) const
 returns the index of the one node given the index of the other. node_index must be one of the two nodes that this edge is incident upon. More...
 
Node const * get_other_node (platform::Size node_index) const
 returns a const pointer to one node given the index of the other. node_index must be one of the two nodes that this edge is incident upon. More...
 
Nodeget_other_node (platform::Size node_index)
 returns a non-const pointer to one node given the index of the other. node_index must be one of the two nodes that this edge is incident upon. More...
 
platform::Size get_first_node_ind () const
 returns the index of the lower node More...
 
platform::Size get_second_node_ind () const
 returns the index of the upper node More...
 
void set_pos_in_owners_list (EdgeListIter edge_iterator)
 called only by class Graph, this function gives the Edge the data it needs to later delete itself from its owner's edge list in constant time. More...
 
bool same_edge (platform::Size node1, platform::Size node2) const
 Is this the same edge as another edge (node1,node2)? Note: this graph does not work for multi-graphs. Edges must be unique. More...
 
bool is_loop () const
 Is this edge a loop? In Pseudographs, loop edges are incident twice on a single vertex. More...
 

Additional Inherited Members

- Protected Member Functions inherited from core::graph::Edge
platform::Size get_node_index (platform::Size index) const
 get the node index for one of the two nodes this edge is incident upon uses c-style index-from-0. More...
 
Node const * get_node (platform::Size index) const
 get a const * to one node that this edge is incident upon uses c-style index-from-0 for these two nodes More...
 
Nodeget_node (platform::Size index)
 get a non-const * to one node that this edge is incident upon uses c-style index-from-0 for these two nodes More...
 
Graph const * get_owner () const
 get a const * to the owning graph More...
 
Graphget_owner ()
 get a non-const * to the owning graph More...
 

Member Typedef Documentation

Constructor & Destructor Documentation

core::scoring::TwelveANeighborEdge::~TwelveANeighborEdge ( )
virtual
core::scoring::TwelveANeighborEdge::TwelveANeighborEdge ( graph::Graph owner,
Size  first_node_ind,
Size  second_node_ind 
)

Referenced by count_static_memory().

Member Function Documentation

void core::scoring::TwelveANeighborEdge::copy_from ( graph::Edge const *  source)
virtual

copy-from for use in Graph::operator= and copy ctors

derived classes should recursively call the copy_from method to ensure all parent class data is copied. It just so happens that this method does nothing, but that could change and the derived class should include a call to this function for that reason.

Reimplemented from core::graph::Edge.

Size core::scoring::TwelveANeighborEdge::count_dynamic_memory ( ) const
virtual

how much memory is dynamically allocated by this edge – must be recursively invoked by a derived class.

memory accounting scheme

This method should be called recursively by derived classes – that is, each class should recurse to its parent.

Reimplemented from core::graph::Edge.

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

Size core::scoring::TwelveANeighborEdge::count_static_memory ( ) const
virtual

how much memory is statically allocated by this edge

memory accouting scheme

This is called non-recursively on the most-derived class

Reimplemented from core::graph::Edge.

References TwelveANeighborEdge().


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