Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
protocols::toolbox::KCluster Class Referenceabstract

basic class for performing a K-style Clustering algorithm More...

#include <KCluster.hh>

Inheritance diagram for protocols::toolbox::KCluster:
Inheritance graph
[legend]

Public Types

typedef ObjexxFCL::FArray2_double FA2d
 
typedef ObjexxFCL::FArray2P_double FA2Pd
 
typedef ObjexxFCL::FArray2D_double FA2Dd
 

Public Member Functions

 KCluster ()
 
 ~KCluster () override
 
virtual void init (KClusterElementOP, core::Size first=0)=0
 
virtual void update (KClusterElementOP, KClusterData &)=0
 
virtual bool whoami ()=0
 
virtual core::Real get_threshold ()=0
 
virtual void set_threshold (core::Real)=0
 
virtual core::Real assign (KClusterElementOP, KClusterData &)=0
 
void cluster (KClusterElementOP, KClusterData &, core::Size first=0)
 
void set_ncluster (core::Size nc)
 

Protected Attributes

core::Size n_cluster_
 

Detailed Description

basic class for performing a K-style Clustering algorithm

Member Typedef Documentation

typedef ObjexxFCL::FArray2_double protocols::toolbox::KCluster::FA2d
typedef ObjexxFCL::FArray2D_double protocols::toolbox::KCluster::FA2Dd
typedef ObjexxFCL::FArray2P_double protocols::toolbox::KCluster::FA2Pd

Constructor & Destructor Documentation

protocols::toolbox::KCluster::KCluster ( )
protocols::toolbox::KCluster::~KCluster ( )
overridedefault

Member Function Documentation

virtual core::Real protocols::toolbox::KCluster::assign ( KClusterElementOP  ,
KClusterData  
)
pure virtual
void protocols::toolbox::KCluster::cluster ( KClusterElementOP  c,
KClusterData d,
core::Size  first = 0 
)
virtual core::Real protocols::toolbox::KCluster::get_threshold ( )
pure virtual
virtual void protocols::toolbox::KCluster::init ( KClusterElementOP  ,
core::Size  first = 0 
)
pure virtual
void protocols::toolbox::KCluster::set_ncluster ( core::Size  nc)
inline

References n_cluster_.

virtual void protocols::toolbox::KCluster::set_threshold ( core::Real  )
pure virtual
virtual void protocols::toolbox::KCluster::update ( KClusterElementOP  ,
KClusterData  
)
pure virtual
virtual bool protocols::toolbox::KCluster::whoami ( )
pure virtual

Member Data Documentation

core::Size protocols::toolbox::KCluster::n_cluster_
protected

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