Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
numeric::ClusteringTreeNode Class Reference

#include <ClusteringTreeNode.hh>

Inheritance diagram for numeric::ClusteringTreeNode:
Inheritance graph
[legend]

Public Member Functions

 ~ClusteringTreeNode () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. 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 (ClusteringTreeNodeAP new_left)
 
void right (ClusteringTreeNodeAP new_right)
 
void parent (ClusteringTreeNodeAP 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::VirtualBase
 VirtualBase ()=default
 Default constructor. More...
 
virtual ~VirtualBase ()=default
 The virtual destructor is one of the main reasons for the VirtualBase class. More...
 
 VirtualBase (VirtualBase const &)=default
 
 VirtualBase (VirtualBase &&)=default
 
VirtualBaseoperator= (VirtualBase const &)=default
 
VirtualBaseoperator= (VirtualBase &&)=default
 

Static Public Member Functions

static ClusteringTreeNodeOP newClusteringTreeNode ()
 Creates a node with no leaves. More...
 
static ClusteringTreeNodeOP newClusteringTreeNode (Size id)
 
static ClusteringTreeNodeOP newClusteringTreeNode (Size id, ClusteringTreeNodeOP left, ClusteringTreeNodeOP right, Real distance=0.0)
 Creates a node with given leaves. More...
 

Private Member Functions

 ClusteringTreeNode ()
 

Private Attributes

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

Constructor & Destructor Documentation

numeric::ClusteringTreeNode::ClusteringTreeNode ( )
inlineprivate

Referenced by newClusteringTreeNode().

numeric::ClusteringTreeNode::~ClusteringTreeNode ( )
overridedefault

Automatically generated virtual destructor for class deriving directly from VirtualBase.

Auto-generated virtual destructor

Member Function Documentation

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

References id_, left(), left_, right(), 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 newClusteringTreeNode().

Size numeric::ClusteringTreeNode::id ( )
inline

References id_.

Referenced by newClusteringTreeNode().

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

References left_.

static ClusteringTreeNodeOP numeric::ClusteringTreeNode::newClusteringTreeNode ( )
inlinestatic

Creates a node with no leaves.

leaves are NULLs, parent is set to this

References ClusteringTreeNode().

Referenced by numeric::AgglomerativeHierarchicalClusterer::cluster(), and newClusteringTreeNode().

static ClusteringTreeNodeOP numeric::ClusteringTreeNode::newClusteringTreeNode ( Size  id)
inlinestatic

References id(), and newClusteringTreeNode().

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

Creates a node with given leaves.

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

References distance(), id(), left(), newClusteringTreeNode(), and right().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::parent ( )
inline

References parent_.

void numeric::ClusteringTreeNode::parent ( ClusteringTreeNodeAP  new_parent)
inline

References parent_.

void numeric::ClusteringTreeNode::reset_all_flags ( )
inline

References flag_, left(), and right().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::right ( )
inline
void numeric::ClusteringTreeNode::right ( ClusteringTreeNodeAP  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 distance().

Size numeric::ClusteringTreeNode::flag_
private
Size numeric::ClusteringTreeNode::id_
private

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

ClusteringTreeNodeOP numeric::ClusteringTreeNode::left_
private

Referenced by copy_leaf_ids(), left(), and right().

ClusteringTreeNodeAP numeric::ClusteringTreeNode::parent_
private

Referenced by parent().

ClusteringTreeNodeOP numeric::ClusteringTreeNode::right_
private

Referenced by copy_leaf_ids(), and right().

Size numeric::ClusteringTreeNode::size_
private

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

Referenced by size().

ClusteringTreeNodeAP numeric::ClusteringTreeNode::this_weak_ptr_
private

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