numeric::ClusteringTreeNode Class Reference

#include <ClusteringTreeNode.hh>

Public Member Functions
virtual	~ClusteringTreeNode ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...
	ClusteringTreeNode (Size id)
	Creates a node with no leaves. More...
	ClusteringTreeNode (Size id, ClusteringTreeNodeOP left, ClusteringTreeNodeOP right, Real distance=0.0)
	Creates a node with given leaves. More...
void	reset_all_flags ()
void	set_all_flags (Size new_flag_value)
ClusteringTreeNodeOP	left ()
ClusteringTreeNodeOP	right ()
ClusteringTreeNodeOP	parent ()
Real	distance ()
Size	size ()
Size	id ()
void	left (ClusteringTreeNodeOP new_left)
void	right (ClusteringTreeNodeOP new_right)
void	parent (ClusteringTreeNodeOP new_parent)
bool	was_visited ()
void	set_visited ()
ClusteringTreeNodeOP	visit_next_leaf ()
void	copy_member_ids (utility::vector1< Size > &dst)
void	copy_leaf_ids (utility::vector1< Size > &dst)
Public Member Functions inherited from utility::pointer::ReferenceCount
void	ctor ()
virtual	~ReferenceCount ()
	Destructor. More...
Size	ref_count () const
	Reference count. More...

Private Attributes
ClusteringTreeNodeOP	parent_
ClusteringTreeNodeOP	left_
ClusteringTreeNodeOP	right_
Size	flag_
Size	size_
	0 - not visited; 1 - visited 1; 2 - visited 1 & 2 More...
Size	id_
Real	distance_

Additional Inherited Members
Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size	Size
typedef platform::Size	size_type
Protected Member Functions inherited from utility::pointer::ReferenceCount
	ReferenceCount ()
	Default constructor. More...
	ReferenceCount (ReferenceCount const &)
	Copy constructor. More...
ReferenceCount &	operator= (ReferenceCount const &)
	Copy assignment. More...

Constructor & Destructor Documentation

numeric::ClusteringTreeNode::~ClusteringTreeNode ( )

virtual

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

numeric::ClusteringTreeNode::ClusteringTreeNode ( Size  id )

inline

Creates a node with no leaves.

Detailed: leaves are NULLs, parent is set to this

References distance_, id(), id_, left_, parent_, right_, and size_.

numeric::ClusteringTreeNode::ClusteringTreeNode ( Size  id, ClusteringTreeNodeOP  left, ClusteringTreeNodeOP  right, Real  distance = 0.0  )

inline

Creates a node with given leaves.

Detailed: parent of the newly created node is set to itself (this pointer); left and right nodes are also chilred of this

References distance(), distance_, id(), id_, left(), left_, parent_, right(), right_, and size_.

Member Function Documentation

void numeric::ClusteringTreeNode::copy_leaf_ids ( utility::vector1< Size > &  dst )

inline

References id_, left_, and right_.

void numeric::ClusteringTreeNode::copy_member_ids ( utility::vector1< Size > &  dst )

inline

References id_, left_, and right_.

Real numeric::ClusteringTreeNode::distance ( )

inline

References distance_.

Referenced by ClusteringTreeNode().

Size numeric::ClusteringTreeNode::id ( )

inline

References id_.

Referenced by ClusteringTreeNode().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::left ( )

inline

References left_.

Referenced by ClusteringTreeNode().

void numeric::ClusteringTreeNode::left ( ClusteringTreeNodeOP  new_left )

inline

References left_.

ClusteringTreeNodeOP numeric::ClusteringTreeNode::parent ( )

inline

References parent_.

void numeric::ClusteringTreeNode::parent ( ClusteringTreeNodeOP  new_parent )

inline

References parent_.

void numeric::ClusteringTreeNode::reset_all_flags ( )

inline

References flag_, left_, and right_.

ClusteringTreeNodeOP numeric::ClusteringTreeNode::right ( )

inline

References right_.

Referenced by ClusteringTreeNode().

void numeric::ClusteringTreeNode::right ( ClusteringTreeNodeOP  new_right )

inline

References left_.

void numeric::ClusteringTreeNode::set_all_flags ( Size  new_flag_value )

inline

References flag_, left_, and right_.

void numeric::ClusteringTreeNode::set_visited ( )

inline

References flag_.

Size numeric::ClusteringTreeNode::size ( )

inline

References size_.

ClusteringTreeNodeOP numeric::ClusteringTreeNode::visit_next_leaf

(

)

References flag_, left_, and right_.

bool numeric::ClusteringTreeNode::was_visited ( )

inline

References flag_.

Member Data Documentation

Real numeric::ClusteringTreeNode::distance_

private

Referenced by ClusteringTreeNode(), and distance().

Size numeric::ClusteringTreeNode::flag_

private

Referenced by reset_all_flags(), set_all_flags(), set_visited(), visit_next_leaf(), and was_visited().

Size numeric::ClusteringTreeNode::id_

private

Referenced by ClusteringTreeNode(), copy_leaf_ids(), copy_member_ids(), and id().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::left_

private

Referenced by ClusteringTreeNode(), copy_leaf_ids(), copy_member_ids(), left(), reset_all_flags(), right(), set_all_flags(), and visit_next_leaf().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::parent_

private

Referenced by ClusteringTreeNode(), and parent().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::right_

private

Referenced by ClusteringTreeNode(), copy_leaf_ids(), copy_member_ids(), reset_all_flags(), right(), set_all_flags(), and visit_next_leaf().

Size numeric::ClusteringTreeNode::size_

private

0 - not visited; 1 - visited 1; 2 - visited 1 & 2

Referenced by ClusteringTreeNode(), and size().

---

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

• src/numeric/ClusteringTreeNode.hh
• src/numeric/ClusteringTreeNode.cc