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

#include <EnergyGraph.hh>

Public Types

typedef graph::Node parent
 
- Public Types inherited from core::graph::Node
typedef EdgeListIterator EdgeListIter
 
typedef EdgeListConstIterator EdgeListConstIter
 

Public Member Functions

 EnergyNode (graph::Graph *owner, Size index)
 
virtual ~EnergyNode ()
 
virtual void copy_from (parent const *source)
 copy mmember data from source node More...
 
virtual void print () const
 send summaray data about this node to the screen More...
 
virtual Size count_static_memory () const
 memory accounting scheme More...
 
virtual Size count_dynamic_memory () const
 memory accounting scheme More...
 
bool moved () const
 
void moved (bool)
 
- 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...
 
Edgefind_edge (platform::Size other_node_index)
 non-const edge finding method; changes no data, but returns a non-const pointer 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 Attributes

bool moved_
 

Additional Inherited Members

- Protected Member Functions inherited from core::graph::Node
Graphget_owner () const
 derived class access to the owner More...
 

Detailed Description

Class EnergyNode holds the result of a domainmap update from the Conformation object held by a pose; if the internal degrees of freedom for a residue (corresponding to a node in this graph) have changed (and are marked with color "0" in the domainmap), then the EnergyNode object will hold that information for the ScoringFunction to retrieve

Member Typedef Documentation

Constructor & Destructor Documentation

core::scoring::EnergyNode::EnergyNode ( graph::Graph owner,
Size  index 
)

Referenced by count_static_memory().

core::scoring::EnergyNode::~EnergyNode ( )
virtual

Member Function Documentation

void core::scoring::EnergyNode::copy_from ( parent const *  source)
virtual

copy mmember data from source node

invoked by copy ctor and operator= methods from Graph base class

Reimplemented from core::graph::Node.

References moved_.

Size core::scoring::EnergyNode::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.

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

Size core::scoring::EnergyNode::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.

References EnergyNode().

bool core::scoring::EnergyNode::moved ( ) const

References moved_.

void core::scoring::EnergyNode::moved ( bool  setting)

References moved_.

void core::scoring::EnergyNode::print ( ) const
virtual

send summaray data about this node to the screen

virtual function to print node to standard out

Reimplemented from core::graph::Node.

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

Member Data Documentation

bool core::scoring::EnergyNode::moved_
private

Referenced by copy_from(), and moved().


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