IMP logo
IMP Reference Guide  develop.97bab1d8fd,2021/09/17
The Integrative Modeling Platform
IMP::statistics::Embedding Class Referenceabstract

Store data to be clustered for embedding based algorithms. More...

#include <IMP/statistics/Embedding.h>

+ Inheritance diagram for IMP::statistics::Embedding:

Detailed Description

Store data to be clustered for embedding based algorithms.

Point-based clustering needs a way of embedding the data being clustered in space. Classes which implement Embedding provide a mapping between each item being clustered (named by an integer index) and a point in space, as a fixed-length array of floating point numbers.

Definition at line 25 of file statistics/embedding.h.

Public Member Functions

virtual unsigned int get_number_of_items () const =0
 
virtual algebra::VectorKD get_point (unsigned int i) const =0
 
virtual algebra::VectorKDs get_points () const
 
double get_weight (unsigned int i) const
 Return a weight for the point. More...
 
- 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
 

Protected Member Functions

 Embedding (std::string name)
 
virtual double do_get_weight (unsigned int i) const
 By default return 1.0. More...
 
- 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 double IMP::statistics::Embedding::do_get_weight ( unsigned int  i) const
protectedvirtual

By default return 1.0.

Definition at line 29 of file statistics/embedding.h.

double IMP::statistics::Embedding::get_weight ( unsigned int  i) const

Return a weight for the point.

Definition at line 38 of file statistics/embedding.h.


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