IMP: statistics_macros.h Source File

00001 /**
00002  *  \file statistics_macros.h    \brief Various important macros
00003  *                           for implementing decorators.
00004  *
00005  *  Copyright 2007-2010 IMP Inventors. All rights reserved.
00006  *
00007  */
00008 
00009 #ifndef IMPSTATISTICS_MACROS_H
00010 #define IMPSTATISTICS_MACROS_H
00011 
00012 #include <IMP/macros.h>
00013 
00014 
00015 //! Define things needed for a Embedding
00016 /** In addition to what is done by IMP_OBJECT() it declares
00017     - IMP::statistics::Distance::get_embedding()
00018 */
00019 #define IMP_EMBEDDING(Name)                                        \
00020   Floats get_point(unsigned int i) const;                          \
00021   unsigned int get_number_of_points() const;                       \
00022   IMP_OBJECT(Name)
00023 
00024 
00025 //! Define the methods needed by Clustering
00026 /** In addition to what is defined/declared by IMP_OBJECT() it declares
00027     - IMP::statistics::Clustering::get_number_of_clusters()
00028     - IMP::statistics::Clustering::get_cluster()
00029     - IMP::statistics::Clustering::get_cluster_representative()
00030 */
00031 #define IMP_CLUSTERING(Name)                                    \
00032   unsigned int get_number_of_clusters() const;                  \
00033   const Ints& get_cluster(unsigned int i) const;                \
00034   int get_cluster_representative(unsigned int i) const;         \
00035   IMP_OBJECT(Name)
00036 
00037 #endif  /* IMPSTATISTICS_MACROS_H */