Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members
fastjet::JetDefinition::Recombiner

fastjet::JetDefinition::Recombiner Class Reference

An abstract base class that will provide the recombination scheme facilities and/or allow a user to extend these facilities. More...

#include <JetDefinition.hh>

Inheritance diagram for fastjet::JetDefinition::Recombiner:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual std::string description () const =0
 return a textual description of the recombination scheme implemented here
virtual void recombine (const PseudoJet &pa, const PseudoJet &pb, PseudoJet &pab) const =0
 recombine pa and pb and put result into pab
virtual void preprocess (PseudoJet &p) const
 routine called to preprocess each input jet (to make all input jets compatible with the scheme requirements (e.g.
virtual ~Recombiner ()
 a destructor to be replaced if necessary in derived classes...
void plus_equal (PseudoJet &pa, const PseudoJet &pb) const
 pa += pb in the given recombination scheme.

Detailed Description

An abstract base class that will provide the recombination scheme facilities and/or allow a user to extend these facilities.

Definition at line 260 of file JetDefinition.hh.

Constructor & Destructor Documentation

virtual fastjet::JetDefinition::Recombiner::~Recombiner (   )  [inline, virtual]
 

a destructor to be replaced if necessary in derived classes...

Definition at line 275 of file JetDefinition.hh.

00275 {};

Member Function Documentation

virtual std::string fastjet::JetDefinition::Recombiner::description (   )  const [pure virtual]
 

return a textual description of the recombination scheme implemented here

Implemented in fastjet::JetDefinition::DefaultRecombiner.

void fastjet::JetDefinition::Recombiner::plus_equal (  PseudoJet &  pa,
const PseudoJet &  pb
)  const [inline]
 

pa += pb in the given recombination scheme.

Not virtual -- the user should have no reason to want to redefine this!

Definition at line 279 of file JetDefinition.hh.

00279                                                                        {
00280       // put result in a temporary location in case the recombiner
00281       // does something funny (ours doesn't, but who knows about the
00282       // user's)
00283       PseudoJet pres; 
00284       recombine(pa,pb,pres);
00285       pa = pres;
00286     }

virtual void fastjet::JetDefinition::Recombiner::preprocess (  PseudoJet &  p  )  const [inline, virtual]
 

routine called to preprocess each input jet (to make all input jets compatible with the scheme requirements (e.g.

massless).

Reimplemented in fastjet::JetDefinition::DefaultRecombiner.

Definition at line 272 of file JetDefinition.hh.

00272 {};

virtual void fastjet::JetDefinition::Recombiner::recombine (  const PseudoJet &  pa,
const PseudoJet &  pb,
PseudoJet &  pab
)  const [pure virtual]
 

recombine pa and pb and put result into pab

Implemented in fastjet::JetDefinition::DefaultRecombiner.

The documentation for this class was generated from the following file:
Generated on Fri Aug 15 13:45:46 2008 for fastjet by  doxygen 1.4.2