The Gaudi Framework  master (37c0b60a)
Rndm::Chi2 Class Reference

Parameters for the Chi2 distributed random number generation. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/RndmGenerators.h>

Inheritance diagram for Rndm::Chi2:
Collaboration diagram for Rndm::Chi2:

Public Member Functions

 Chi2 (long n_dof)
 Standard Constructor. More...
 
long nDOF () const
 Access mean value of the distribution. More...
 
Chi2clone () const override
 Clone parameters. More...
 
- Public Member Functions inherited from IRndmGen::Param
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor. More...
 
virtual ~Param ()=default
 Standard Destructor. More...
 
virtual const InterfaceIDtype () const
 Parameter's type. More...
 

Static Public Member Functions

static const InterfaceIDtypeID ()
 Identifier for factory. More...
 

Protected Attributes

long m_nDOF
 Number of degrees of freedom. More...
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator. More...
 

Friends

class Generator< Chi2 >
 

Detailed Description

Parameters for the Chi2 distributed random number generation.

Definition at line 74 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Chi2()

Rndm::Chi2::Chi2 ( long  n_dof)
inline

Standard Constructor.

Definition at line 83 of file RndmGenerators.h.

83 : IRndmGen::Param( IID_IRndmChi2 ), m_nDOF( n_dof ) {}

Member Function Documentation

◆ clone()

Chi2* Rndm::Chi2::clone ( ) const
inlineoverridevirtual

Clone parameters.

Implements IRndmGen::Param.

Definition at line 89 of file RndmGenerators.h.

89 { return new Chi2( m_nDOF ); }

◆ nDOF()

long Rndm::Chi2::nDOF ( ) const
inline

Access mean value of the distribution.

Definition at line 85 of file RndmGenerators.h.

85 { return m_nDOF; }

◆ typeID()

static const InterfaceID& Rndm::Chi2::typeID ( )
inlinestatic

Identifier for factory.

Definition at line 87 of file RndmGenerators.h.

87 { return IID_IRndmChi2; }

Friends And Related Function Documentation

◆ Generator< Chi2 >

friend class Generator< Chi2 >
friend

Definition at line 69 of file RndmGenerators.h.

Member Data Documentation

◆ m_nDOF

long Rndm::Chi2::m_nDOF
protected

Number of degrees of freedom.

Definition at line 79 of file RndmGenerators.h.


The documentation for this class was generated from the following file:
Rndm::Chi2::m_nDOF
long m_nDOF
Number of degrees of freedom.
Definition: RndmGenerators.h:79
IRndmGen::Param
Definition: IRndmGen.h:49
Rndm::Chi2::Chi2
Chi2(long n_dof)
Standard Constructor.
Definition: RndmGenerators.h:83