CBAlgoFake.h
Go to the documentation of this file.
1 /**
2  * \file CBAlgoFake.h
3  *
4  * \ingroup CMTool
5  *
6  * \brief Class def header for a class CBAlgoFake
7  *
8  * @author kazuhiro
9  */
10 
11 /** \addtogroup CMTool
12 
13  @{*/
14 #ifndef RECOTOOL_CBALGOFAKE_H
15 #define RECOTOOL_CBALGOFAKE_H
16 
19 
20 namespace cmtool {
21  /**
22  \class CBAlgoFake
23  An abstract fake class for merging algorithm. Having this fake class helps
24  to have a better overall design of various merging for iterative approach.
25  The algorithms are run through CMergeManager.
26  */
27  class CBAlgoFake : public CBoolAlgoBase {
28 
29  public:
30 
31  /// Default constructor
32  CBAlgoFake();
33 
34  /// Default destructor
35  virtual ~CBAlgoFake(){};
36 
37  /**
38  Core function: given the ClusterParamsAlg input, return whether a cluster should be
39  merged or not.
40  */
41  virtual bool Bool(const ::cluster::ClusterParamsAlg &cluster1,
42  const ::cluster::ClusterParamsAlg &cluster2);
43 
44  /// Function to reset the algorithm instance ... maybe implemented via child class
45  virtual void Reset(){}
46 
47  protected:
48 
49  bool _flip;
50  int _ctr;
51  };
52 }
53 
54 #endif
55 /** @} */ // end of doxygen group
Class def header for algorithm classes for CMergeManager.
CBAlgoFake()
Default constructor.
Definition: CBAlgoFake.cxx:6
virtual void Reset()
Function to reset the algorithm instance ... maybe implemented via child class.
Definition: CBAlgoFake.h:45
virtual ~CBAlgoFake()
Default destructor.
Definition: CBAlgoFake.h:35
virtual bool Bool(const ::cluster::ClusterParamsAlg &cluster1, const ::cluster::ClusterParamsAlg &cluster2)
Definition: CBAlgoFake.cxx:15