core::scoring::TenANeighborGraph Class Reference

#include <TenANeighborGraph.hh>

Inheritance diagram for core::scoring::TenANeighborGraph:

Collaboration diagram for core::scoring::TenANeighborGraph:

List of all members.

Public Types
typedef ContextGraph	parent
Public Member Functions
virtual	~TenANeighborGraph ()
	TenANeighborGraph ()
	TenANeighborGraph (Size num_nodes)
	TenANeighborGraph (TenANeighborGraph const &source)
TenANeighborGraph &	operator= (TenANeighborGraph const &source)
virtual Distance	neighbor_cutoff () const
virtual void	conditionally_add_edge (Size lower_node_id, Size upper_node_id, DistanceSquared dsq)
virtual ContextGraphOP	clone () const
virtual void	update_from_pose (pose::Pose const &pose)
virtual void	delete_edge (graph::Edge *edge)
	remove an edge from the graph. (NEW AS OF 12/9/07) Never call C++'s "delete" function on an edge pointer directly. Derived classes must implement this function. If they wish to use unordered_object_pools to manage their memory
Protected Member Functions
virtual Size	count_static_memory () const
virtual Size	count_dynamic_memory () const
virtual graph::Node *	create_new_node (Size node_index)
	factory method for node creation, defined by derived graph classes, called by the base class
virtual graph::Edge *	create_new_edge (Size index1, Size index2)
	factory method for edge creation, defined by derived graph classes, called by the base class
virtual graph::Edge *	create_new_edge (graph::Edge const *example_edge)
	factory method for edge copy-construction. Derived class should downcast the example_edge pointer and may read that edge's data.

---

Member Typedef Documentation

typedef ContextGraph core::scoring::TenANeighborGraph::parent

Reimplemented from core::scoring::ContextGraph.

---

Constructor & Destructor Documentation

core::scoring::TenANeighborGraph::~TenANeighborGraph

(

)

[virtual]

References core::graph::Graph::delete_everything().

core::scoring::TenANeighborGraph::TenANeighborGraph

(

)

Referenced by clone(), and count_static_memory().

core::scoring::TenANeighborGraph::TenANeighborGraph

(

Size

num_nodes

)

References core::graph::Graph::set_num_nodes().

core::scoring::TenANeighborGraph::TenANeighborGraph

(

TenANeighborGraph const &

source

)

References core::scoring::ContextGraph::operator=().

---

Member Function Documentation

ContextGraphOP core::scoring::TenANeighborGraph::clone

(

)

const [virtual]

Implements core::scoring::ContextGraph.

References TenANeighborGraph().

void core::scoring::TenANeighborGraph::conditionally_add_edge	(	Size	lower_node_id,
		Size	upper_node_id,
		DistanceSquared	dsq
	)		[virtual]

Implements core::scoring::ContextGraph.

References core::graph::Graph::add_edge().

Size core::scoring::TenANeighborGraph::count_dynamic_memory

(

)

const [protected, virtual]

Reimplemented from core::scoring::ContextGraph.

References core::scoring::ContextGraph::count_dynamic_memory().

Size core::scoring::TenANeighborGraph::count_static_memory

(

)

const [protected, virtual]

Implements core::scoring::ContextGraph.

References TenANeighborGraph().

graph::Edge * core::scoring::TenANeighborGraph::create_new_edge

(

graph::Edge const *

example_edge

)

[protected, virtual]

factory method for edge copy-construction. Derived class should downcast the example_edge pointer and may read that edge's data.

Reimplemented from core::graph::Graph.

References boost::unordered_object_pool< T, UserAllocator >::construct(), core::graph::Edge::get_first_node_ind(), and core::graph::Edge::get_second_node_ind().

graph::Edge * core::scoring::TenANeighborGraph::create_new_edge	(	Size	index1,
		Size	index2
	)		[protected, virtual]

factory method for edge creation, defined by derived graph classes, called by the base class

factory method for edge creation Should be overriden in derived classes

Reimplemented from core::graph::Graph.

References boost::unordered_object_pool< T, UserAllocator >::construct().

graph::Node * core::scoring::TenANeighborGraph::create_new_node

(

Size

node_index

)

[protected, virtual]

factory method for node creation, defined by derived graph classes, called by the base class

factory method for node creation Should be overriden in derived classes

Reimplemented from core::graph::Graph.

void core::scoring::TenANeighborGraph::delete_edge

(

graph::Edge *

edge

)

[virtual]

remove an edge from the graph. (NEW AS OF 12/9/07) Never call C++'s "delete" function on an edge pointer directly. Derived classes must implement this function. If they wish to use unordered_object_pools to manage their memory

Reimplemented from core::graph::Graph.

References boost::unordered_object_pool< T, UserAllocator >::destroy().

Distance core::scoring::TenANeighborGraph::neighbor_cutoff

(

)

const [virtual]

Implements core::scoring::ContextGraph.

TenANeighborGraph & core::scoring::TenANeighborGraph::operator=

(

TenANeighborGraph const &

source

)

References core::scoring::ContextGraph::operator=().

void core::scoring::TenANeighborGraph::update_from_pose

(

pose::Pose const &

pose

)

[virtual]

Implements core::scoring::ContextGraph.

---

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

• src/core/scoring/TenANeighborGraph.hh
• src/core/scoring/TenANeighborGraph.cc