Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
protocols::cluster::DataPoint Class Reference

Data structure for one input data point for affinity propagation clustering. More...

#include <APCluster.hh>

Public Member Functions

 DataPoint (core::Size i_in)
 
 ~DataPoint ()=default
 
void add_similarity (core::Size k, core::Real s_ik, core::Size max_sims)
 Set similarity s(i,k), the suitability of point k to be an exemplar for this point. More...
 
bool is_set_s_kk () const
 

Public Attributes

core::Size i
 
core::Real s_kk
 
core::Real r_kk
 
core::Real a_kk
 
core::Real sum
 
core::Size curr_exemplar
 
core::Size best_exemplar
 
utility::vector1< Exemplarcandidates
 
utility::vector1< Exemplar * > candidate_for
 

Detailed Description

Data structure for one input data point for affinity propagation clustering.

There should be one instance of this class for each input point. Fields are public because it's a glorified struct – clients shouldn't use this directly.

Constructor & Destructor Documentation

protocols::cluster::DataPoint::DataPoint ( core::Size  i_in)
inline
protocols::cluster::DataPoint::~DataPoint ( )
default

Member Function Documentation

void protocols::cluster::DataPoint::add_similarity ( core::Size  k,
core::Real  s_ik,
core::Size  max_sims 
)

Set similarity s(i,k), the suitability of point k to be an exemplar for this point.

If this point has more than max_sims similarities already stored, the lowest one (most negative) will be discarded.

There is currently no protection against adding s(i,k) twice, which will not be caught and will screw up the computation royally.

References candidates, curr_exemplar, i, protocols::cluster::Exemplar::min_heap(), and s_kk.

bool protocols::cluster::DataPoint::is_set_s_kk ( ) const
inline

References curr_exemplar.

Member Data Documentation

core::Real protocols::cluster::DataPoint::a_kk
core::Size protocols::cluster::DataPoint::best_exemplar
utility::vector1< Exemplar* > protocols::cluster::DataPoint::candidate_for
utility::vector1< Exemplar > protocols::cluster::DataPoint::candidates
core::Size protocols::cluster::DataPoint::curr_exemplar
core::Size protocols::cluster::DataPoint::i
core::Real protocols::cluster::DataPoint::r_kk
core::Real protocols::cluster::DataPoint::s_kk
core::Real protocols::cluster::DataPoint::sum

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