Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | List of all members
core::pack::interaction_graph::FirstClassEdge< V, E, G > Class Template Reference

#include <AdditionalBackgroundNodesInteractionGraph.hh>

Inheritance diagram for core::pack::interaction_graph::FirstClassEdge< V, E, G >:
Inheritance graph
[legend]

Public Member Functions

 ~FirstClassEdge () override
 FirstClassEdge destructor. More...
 
 FirstClassEdge (G *owner, int first_node_ind, int second_node_ind)
 FirstClassEdge constructor. More...
 
unsigned int count_dynamic_memory () const override
 

Private Member Functions

 FirstClassEdge ()
 
 FirstClassEdge (FirstClassEdge< V, E, G > const &)
 
FirstClassEdge< V, E, G > & operator= (FirstClassEdge< V, E, G > const &)
 

Detailed Description

template<typename V, typename E, typename G>
class core::pack::interaction_graph::FirstClassEdge< V, E, G >

Remarks
Defines only a constructor and count_dynamic_memory().

Constructor & Destructor Documentation

template<typename V , typename E , typename G >
core::pack::interaction_graph::FirstClassEdge< V, E, G >::~FirstClassEdge ( )
override

FirstClassEdge destructor.

template<typename V , typename E , typename G >
core::pack::interaction_graph::FirstClassEdge< V, E, G >::FirstClassEdge ( G owner,
int  first_node_ind,
int  second_node_ind 
)

FirstClassEdge constructor.

This class is almost empty; a FirstClassEdge connects two first class vertices, and is ignorant of the existence of both second class nodes (synonymous with BackgroundNode) and second-to-first-class edges (synonymous with BackgroundToFirstClassEdge). I (apl) cannot think of any data that a FirstClassEdge should hold that is not held in a PrecomputedPairEnergiesEdge. Nor can I think of any methods that the edge should implement. However, I include the class in the inheritance hierarchy just in case I come up with something later.

Parameters
owner- [in] - the owning interaction graph first_node_index - [in] - the index of the lower-indexed first class node second_node_index - [in] - the index of the higher-indexed first class node
template<typename V, typename E, typename G>
core::pack::interaction_graph::FirstClassEdge< V, E, G >::FirstClassEdge ( )
private
template<typename V, typename E, typename G>
core::pack::interaction_graph::FirstClassEdge< V, E, G >::FirstClassEdge ( FirstClassEdge< V, E, G > const &  )
private

Member Function Documentation

template<typename V, typename E, typename G>
unsigned int core::pack::interaction_graph::FirstClassEdge< V, E, G >::count_dynamic_memory ( ) const
inlineoverride
template<typename V, typename E, typename G>
FirstClassEdge< V, E, G >& core::pack::interaction_graph::FirstClassEdge< V, E, G >::operator= ( FirstClassEdge< V, E, G > const &  )
private

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