protocols::toolbox::KCluster Class Reference

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

#include <KCluster.hh>

Inheritance diagram for protocols::toolbox::KCluster:

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

FA2d

typedef ObjexxFCL::FArray2_double protocols::toolbox::KCluster::FA2d

FA2Dd

typedef ObjexxFCL::FArray2D_double protocols::toolbox::KCluster::FA2Dd

FA2Pd

typedef ObjexxFCL::FArray2P_double protocols::toolbox::KCluster::FA2Pd

Constructor & Destructor Documentation

KCluster()

protocols::toolbox::KCluster::KCluster

(

)

~KCluster()

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

overridedefault

Member Function Documentation

assign()

virtual core::Real protocols::toolbox::KCluster::assign ( KClusterElementOP  , KClusterData &    )

pure virtual

Implemented in protocols::toolbox::GreedyKCenter, and protocols::toolbox::KMedoid.

cluster()

void protocols::toolbox::KCluster::cluster	(	KClusterElementOP	c,
		KClusterData &	d,
		core::Size	first = 0
	)

References core::init::init(), protocols::hybridization::score, and protocols::TR().

get_threshold()

virtual core::Real protocols::toolbox::KCluster::get_threshold ( )

pure virtual

Implemented in protocols::toolbox::GreedyKCenter, and protocols::toolbox::KMedoid.

init()

virtual void protocols::toolbox::KCluster::init ( KClusterElementOP  , core::Size  first = 0  )

pure virtual

Implemented in protocols::toolbox::GreedyKCenter, and protocols::toolbox::KMedoid.

set_ncluster()

void protocols::toolbox::KCluster::set_ncluster ( core::Size  nc )

inline

References n_cluster_.

set_threshold()

virtual void protocols::toolbox::KCluster::set_threshold ( core::Real  )

pure virtual

Implemented in protocols::toolbox::GreedyKCenter, and protocols::toolbox::KMedoid.

update()

virtual void protocols::toolbox::KCluster::update ( KClusterElementOP  , KClusterData &    )

pure virtual

Implemented in protocols::toolbox::GreedyKCenter, and protocols::toolbox::KMedoid.

whoami()

virtual bool protocols::toolbox::KCluster::whoami ( )

pure virtual

Implemented in protocols::toolbox::GreedyKCenter, and protocols::toolbox::KMedoid.

Member Data Documentation

n_cluster_

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

protected

Referenced by protocols::toolbox::KMedoid::init(), set_ncluster(), and protocols::toolbox::GreedyKCenter::update().

---

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

• src/protocols/toolbox/KCluster.hh
• src/protocols/toolbox/KCluster.cc