Apply random permutations to a set of inputs. More...

Detailed Description

Apply random permutations to a set of inputs.

Apply a random permutation on the input particles. Which permutation to apply is determined by the value of a phase-space point \(x\) generated by Cuba. For instance, if the input is \((p1,p2)\), the output will be \((p_1,p_2)\) if \(x \in [\,0, 0.5\,[\) and \((p_2,p_1)\) if \(x \in [\,0.5, 1\,]\).

This allows to efficiently compute a weight taking into account all permutations over identical objects in the final state. A dimension is added to the integration, and this extra dimension controls which permutation is considered for the rest of the computation. That way, the integrator automatically spends more time on those permutations giving the largest contribution to the final result.

Integration dimension

This module requires 1 phase-space point.

Inputs

Name Type Description
ps_point double Phase-space point generated by CUBA.
inputs vector(LorentzVector) Set of input particles to be permutated

Outputs

Name Type Description
output double Permutated set of input particles

Definition at line 60 of file Permutator.cc.

Inheritance diagram for Permutator:

Public Member Functions

 Permutator (PoolPtr pool, const ParameterSet &parameters)
 
virtual Status work () override
 Main function. More...
 
- Public Member Functions inherited from Module
 Module (PoolPtr pool, const std::string &name)
 Constructor. More...
 
virtual void configure ()
 Called once at the beginning of the job.
 
virtual void beginIntegration ()
 Called once at the beginning of the integration.
 
virtual void beginPoint ()
 Called once when a new PS point is started. More...
 
virtual void beginLoop ()
 Called once at the beginning of a loop. More...
 
virtual void endLoop ()
 Called once at the end of a loop. More...
 
virtual void endPoint ()
 Called once when a PS point is finished. More...
 
virtual void endIntegration ()
 Called once at the end of the integration.
 
virtual void finish ()
 Called once at the end of the job.
 
virtual std::string name () const final
 

Additional Inherited Members

- Public Types inherited from Module
enum  Status : std::int8_t { OK, NEXT, ABORT }
 
- Static Public Member Functions inherited from Module
static std::string statusToString (const Status &status)
 
static bool is_virtual_module (const std::string &name)
 Test if a given name correspond to a virtual module. More...
 
- Protected Member Functions inherited from Module
template<typename T , typename... Args>
std::shared_ptr< T > produce (const std::string &name, Args... args)
 Add a new output to the module. More...
 
template<typename T >
Value< T > get (const std::string &module, const std::string &name)
 
template<typename T >
Value< T > get (const InputTag &tag)
 
- Protected Attributes inherited from Module
PoolPtr m_pool
 

Member Function Documentation

◆ work()

virtual Status Permutator::work ( )
inlineoverridevirtual

Main function.

This method is called for each integration step. The module's logic and work happen here.

You'll usually want to override this function if you want your module to perform some task.

Reimplemented from Module.

Definition at line 81 of file Permutator.cc.


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