CBAlgoMergeAll.h
Go to the documentation of this file.
1 /**
2  * \file CBAlgoMergeAll.h
3  *
4  * \ingroup CMTool
5  *
6  * \brief Class def header for a class CBAlgoMergeAll
7  *
8  * @author david caratelli
9  */
10 
11 /** \addtogroup CMTool
12 
13  @{*/
14 #ifndef RECOTOOL_CBALGOMERGEALL_H
15 #define RECOTOOL_CBALGOMERGEALL_H
16 
19 
20 namespace cmtool {
21  /**
22  \class CBAlgoMergeAll
23  Merges all clusters: maybe useful to test how well a cluster-separating
24  algorithm has performed
25  */
26  class CBAlgoMergeAll: public CBoolAlgoBase {
27 
28  public:
29 
30  /// Default constructor
32 
33  /// Default destructor
34  virtual ~CBAlgoMergeAll(){};
35 
36  /**
37  Core function: given the ClusterParamsAlg input, return whether a cluster should be
38  merged or not.
39  */
40  virtual bool Bool(const ::cluster::ClusterParamsAlg &cluster1,
41  const ::cluster::ClusterParamsAlg &cluster2);
42 
43  /// Function to reset the algorithm instance ... maybe implemented via child class
44  virtual void Reset(){}
45 
46  protected:
47 
48  };
49 }
50 
51 #endif
52 /** @} */ // end of doxygen group
Class def header for algorithm classes for CMergeManager.
virtual void Reset()
Function to reset the algorithm instance ... maybe implemented via child class.
virtual bool Bool(const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
virtual ~CBAlgoMergeAll()
Default destructor.
CBAlgoMergeAll()
Default constructor.