IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::statistics::PartitionalClustering Class Referenceabstract

A base class for clustering results where each item is in one cluster. More...

#include <IMP/statistics/PartitionalClustering.h>

+ Inheritance diagram for IMP::statistics::PartitionalClustering:

Detailed Description

A base class for clustering results where each item is in one cluster.

Data items are represented by an index. In a partitional clustering each item can only be contained in one cluster. The indexes used refer to the index used in the Metric or Embedding used to generate the clustering.

Definition at line 25 of file PartitionalClustering.h.

Public Member Functions

 PartitionalClustering (std::string name)
 
virtual const Intsget_cluster (unsigned int cluster_index) const =0
 Return the list of indexes in the ith cluster. More...
 
virtual int get_cluster_representative (unsigned int cluster_index) const =0
 Return the index of an item that "typifies" the ith cluster. More...
 
virtual unsigned int get_number_of_clusters () const =0
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
virtual VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
void set_was_used (bool tf) const
 
void show (std::ostream &out=std::cout) const
 
const std::string & get_name () const
 
void set_name (std::string name)
 
virtual std::string get_type_name () const
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Member Function Documentation

virtual const Ints& IMP::statistics::PartitionalClustering::get_cluster ( unsigned int  cluster_index) const
pure virtual

Return the list of indexes in the ith cluster.

Implemented in IMP::statistics::PartitionalClusteringWithCenter.

virtual int IMP::statistics::PartitionalClustering::get_cluster_representative ( unsigned int  cluster_index) const
pure virtual

Return the index of an item that "typifies" the ith cluster.

Implemented in IMP::statistics::PartitionalClusteringWithCenter.


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