Public Member Functions | List of all members
cmtool::CFAlgo_Class_Name Class Reference

#include <cfalgo.hh>

Inheritance diagram for cmtool::CFAlgo_Class_Name:
cmtool::CFloatAlgoBase cmtool::CMAlgoBase

Public Member Functions

 CFAlgo_Class_Name ()
 Default constructor. More...
 
virtual ~CFAlgo_Class_Name ()
 Default destructor. More...
 
virtual float Float (const std::vector< const cluster::ClusterParamsAlg * > &clusters)
 
virtual void Report ()
 
virtual void Reset ()
 Function to reset the algorithm instance, called together with manager's Reset() More...
 
- Public Member Functions inherited from cmtool::CFloatAlgoBase
 CFloatAlgoBase ()
 Default constructor. More...
 
virtual ~CFloatAlgoBase ()
 Default destructor. More...
 
- Public Member Functions inherited from cmtool::CMAlgoBase
 CMAlgoBase ()
 Default constructor. More...
 
virtual ~CMAlgoBase ()
 Default destructor. More...
 
virtual void EventBegin (const std::vector< cluster::ClusterParamsAlg > &clusters)
 
virtual void EventEnd ()
 
virtual void IterationBegin (const std::vector< cluster::ClusterParamsAlg > &clusters)
 
virtual void IterationEnd ()
 
void SetAnaFile (TFile *fout)
 Setter function for an output plot TFile pointer. More...
 
virtual void SetVerbose (bool doit=true)
 Setter function for verbosity. More...
 

Additional Inherited Members

- Protected Attributes inherited from cmtool::CMAlgoBase
TFile * _fout
 TFile pointer to an output file. More...
 
bool _verbose
 Boolean to choose verbose mode. Turned on if CMergeManager/CMatchManager's verbosity level is >= kPerMerging. More...
 

Detailed Description

User implementation for CFloatAlgoBase class doxygen documentation!

Definition at line 25 of file cfalgo.hh.

Constructor & Destructor Documentation

cmtool::CFAlgo_Class_Name::CFAlgo_Class_Name ( )

Default constructor.

Definition at line 6 of file cfalgo.cc.

7  //-------------------------------------------------------
8  {
9 
10  }
CFloatAlgoBase()
Default constructor.
virtual cmtool::CFAlgo_Class_Name::~CFAlgo_Class_Name ( )
inlinevirtual

Default destructor.

Definition at line 33 of file cfalgo.hh.

33 {};

Member Function Documentation

float cmtool::CFAlgo_Class_Name::Float ( const std::vector< const cluster::ClusterParamsAlg * > &  clusters)
virtual

Core function: given a set of CPANs, return a float which indicates the compatibility the cluster combination.

Reimplemented from cmtool::CFloatAlgoBase.

Definition at line 20 of file cfalgo.cc.

22  {
23  if(clusters.size()) return 1.;
24  else return -1.;
25  }
void cmtool::CFAlgo_Class_Name::Report ( )
virtual

Optional function: called after each iterative approach if a manager class is run with verbosity level <= kPerIteration. Maybe useful for debugging.

Reimplemented from cmtool::CMAlgoBase.

Definition at line 28 of file cfalgo.cc.

30  {
31 
32  }
void cmtool::CFAlgo_Class_Name::Reset ( void  )
virtual

Function to reset the algorithm instance, called together with manager's Reset()

Reimplemented from cmtool::CMAlgoBase.

Definition at line 13 of file cfalgo.cc.

15  {
16 
17  }

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