SingleLinkage ClusterMethod. More...
#include <OpenMS/COMPARISON/CLUSTERING/SingleLinkage.h>
Inheritance diagram for SingleLinkage:
Public Member Functions | |
| SingleLinkage () | |
| default constructor | |
| SingleLinkage (const SingleLinkage &source) | |
| copy constructor | |
| virtual | ~SingleLinkage () |
| destructor | |
| SingleLinkage & | operator= (const SingleLinkage &source) |
| assignment operator | |
| void | operator() (DistanceMatrix< Real > &original_distance, std::vector< BinaryTreeNode > &cluster_tree, const Real threshold=1) const |
| clusters the indices according to their respective element distances | |
Static Public Member Functions | |
| static ClusterFunctor * | create () |
| creates a new instance of a SingleLinkage object | |
| static const String | getProductName () |
| get the identifier for this object | |
Detailed Description
SingleLinkage ClusterMethod.
The details of the method can be found in: SLINK: An optimally efficient algorithm for the single-link cluster method, The Computer Journal 1973 16(1):30-34; doi:10.1093/comjnl/16.1.30
- See also:
- ClusterFunctor() base class.
Constructor & Destructor Documentation
| SingleLinkage | ( | ) |
default constructor
| SingleLinkage | ( | const SingleLinkage & | source | ) |
copy constructor
| virtual ~SingleLinkage | ( | ) | [virtual] |
destructor
Member Function Documentation
| static ClusterFunctor* create | ( | ) | [inline, static] |
creates a new instance of a SingleLinkage object
| static const String getProductName | ( | ) | [inline, static] |
get the identifier for this object
| void operator() | ( | DistanceMatrix< Real > & | original_distance, | |
| std::vector< BinaryTreeNode > & | cluster_tree, | |||
| const Real | threshold = 1 | |||
| ) | const |
clusters the indices according to their respective element distances
- Parameters:
-
original_distance DistanceMatrix<Real> containing the distances of the elements to be clustered cluster_tree vector< BinaryTreeNode >, represents the clustering, each node contains the next two clusters merged and their distance, strict order is kept: left_child < right_child threshold Real value to meet Baseclass interface, will not be used because algorithm used is considerably fast and does not work by growing distances
- Exceptions:
-
ClusterFunctor::InsufficientInput thrown if input is <2 The clustering method is single linkage, where the updated distances after merging two clusters are each the minimal distance between the elements of their clusters.
- See also:
- ClusterFunctor , BinaryTreeNode
| SingleLinkage& operator= | ( | const SingleLinkage & | source | ) |
assignment operator
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:50 using doxygen 1.7.1 |