ATLAS Offline Software
Public Types | Public Member Functions | List of all members
Trk::IVertexAnnealingMaker Class Referenceabstract

#include <IVertexAnnealingMaker.h>

Inheritance diagram for Trk::IVertexAnnealingMaker:
Collaboration diagram for Trk::IVertexAnnealingMaker:

Public Types

typedef unsigned int AnnealingState
 

Public Member Functions

 DeclareInterfaceID (IVertexAnnealingMaker, 1, 0)
 
virtual ~IVertexAnnealingMaker ()=default
 Virtual destructor. More...
 
virtual void reset (AnnealingState &state) const =0
 Starts the annealing from scratch. More...
 
virtual void anneal (AnnealingState &state) const =0
 Goes one step further in the annealing. More...
 
virtual double getWeight (const AnnealingState &state, double chisq, const std::vector< double > &allchisq) const =0
 Calculates the weight according to the given chi2. More...
 
virtual double getWeight (const AnnealingState &state, double chisq) const =0
 Calculates the weight according to the given chi2. More...
 
virtual bool isEquilibrium (const AnnealingState &state) const =0
 Checks whether the equilibrium is reached. More...
 
virtual double actualTemp (const AnnealingState &state) const =0
 Gets the actual temperature. More...
 

Detailed Description

Interface class responsible for an annealing process. You define a chi squared as function of the weight (due to the compatibility of the track with the vertex), but also as function of the temperature, which will go down step by step according to the concrete implementation of the annealing.

Author
Giaci.nosp@m.nto..nosp@m.Piacq.nosp@m.uadi.nosp@m.o@phy.nosp@m.sik..nosp@m.uni-f.nosp@m.reib.nosp@m.urg.d.nosp@m.e

Definition at line 30 of file IVertexAnnealingMaker.h.

Member Typedef Documentation

◆ AnnealingState

Definition at line 35 of file IVertexAnnealingMaker.h.

Constructor & Destructor Documentation

◆ ~IVertexAnnealingMaker()

virtual Trk::IVertexAnnealingMaker::~IVertexAnnealingMaker ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ actualTemp()

virtual double Trk::IVertexAnnealingMaker::actualTemp ( const AnnealingState state) const
pure virtual

Gets the actual temperature.

◆ anneal()

virtual void Trk::IVertexAnnealingMaker::anneal ( AnnealingState state) const
pure virtual

Goes one step further in the annealing.

◆ DeclareInterfaceID()

Trk::IVertexAnnealingMaker::DeclareInterfaceID ( IVertexAnnealingMaker  ,
,
 
)

◆ getWeight() [1/2]

virtual double Trk::IVertexAnnealingMaker::getWeight ( const AnnealingState state,
double  chisq 
) const
pure virtual

Calculates the weight according to the given chi2.

◆ getWeight() [2/2]

virtual double Trk::IVertexAnnealingMaker::getWeight ( const AnnealingState state,
double  chisq,
const std::vector< double > &  allchisq 
) const
pure virtual

Calculates the weight according to the given chi2.

◆ isEquilibrium()

virtual bool Trk::IVertexAnnealingMaker::isEquilibrium ( const AnnealingState state) const
pure virtual

Checks whether the equilibrium is reached.

◆ reset()

virtual void Trk::IVertexAnnealingMaker::reset ( AnnealingState state) const
pure virtual

Starts the annealing from scratch.


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