Vespucci  1.0.0
Vespucci::Math::Clustering::AHCANode Class Reference

The AHCANode class This class stores a node in the data structure representing the AHCA dendrogram The AHCA dendrogram is a binary tree, each node stores two children, and its parent, if it exists. The root node has a NULL parent. The "leaves", which store single indices have null children. More...

#include <ahcanode.h>

Inheritance diagram for Vespucci::Math::Clustering::AHCANode:
Vespucci::Math::Clustering::AHCALeaf

Public Member Functions

 AHCANode (Vespucci::Math::Clustering::AHCANode *child1, Vespucci::Math::Clustering::AHCANode *child2, double distance)
 
virtual ~AHCANode ()
 
double distance ()
 
Vespucci::Math::Clustering::AHCANodechild1 ()
 
Vespucci::Math::Clustering::AHCANodechild2 ()
 
virtual arma::uvec GetChildIndices ()
 
void SetParent (Vespucci::Math::Clustering::AHCANode *parent)
 
Vespucci::Math::Clustering::AHCANodeparent ()
 
bool HasChildren ()
 Vespucci::Math::Clustering::AHCANode::HasChildren. More...
 

Detailed Description

The AHCANode class This class stores a node in the data structure representing the AHCA dendrogram The AHCA dendrogram is a binary tree, each node stores two children, and its parent, if it exists. The root node has a NULL parent. The "leaves", which store single indices have null children.

Definition at line 34 of file ahcanode.h.

Constructor & Destructor Documentation

Vespucci::Math::Clustering::AHCANode::AHCANode ( Vespucci::Math::Clustering::AHCANode child1,
Vespucci::Math::Clustering::AHCANode child2,
double  distance 
)

Definition at line 21 of file ahcanode.cpp.

Vespucci::Math::Clustering::AHCANode::~AHCANode ( )
virtual

Definition at line 31 of file ahcanode.cpp.

Member Function Documentation

Vespucci::Math::Clustering::AHCANode * Vespucci::Math::Clustering::AHCANode::child1 ( )

Definition at line 42 of file ahcanode.cpp.

Vespucci::Math::Clustering::AHCANode * Vespucci::Math::Clustering::AHCANode::child2 ( )

Definition at line 47 of file ahcanode.cpp.

double Vespucci::Math::Clustering::AHCANode::distance ( )

Definition at line 37 of file ahcanode.cpp.

arma::uvec Vespucci::Math::Clustering::AHCANode::GetChildIndices ( )
virtual

Reimplemented in Vespucci::Math::Clustering::AHCALeaf.

Definition at line 52 of file ahcanode.cpp.

bool Vespucci::Math::Clustering::AHCANode::HasChildren ( )

Vespucci::Math::Clustering::AHCANode::HasChildren.

Returns
A way of determining if this node has children or not, without having to check the cast to AHCALeaf

Definition at line 72 of file ahcanode.cpp.

Vespucci::Math::Clustering::AHCANode * Vespucci::Math::Clustering::AHCANode::parent ( )

Definition at line 62 of file ahcanode.cpp.

void Vespucci::Math::Clustering::AHCANode::SetParent ( Vespucci::Math::Clustering::AHCANode parent)

Definition at line 57 of file ahcanode.cpp.


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