The Gaudi Framework  master (ff829712)
Loading...
Searching...
No Matches
Rndm::Flat Class Reference

Parameters for the flat random number generation within boundaries [minimum, maximum]. More...

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

Inheritance diagram for Rndm::Flat:
Collaboration diagram for Rndm::Flat:

Public Member Functions

 Flat (double mi, double ma)
 Standard Constructor.
 
double minimum () const
 Access lower edge.
 
double maximum () const
 Access upper edge.
 
Flatclone () const override
 Clone parameters.
 
- Public Member Functions inherited from IRndmGen::Param
 Param (const InterfaceID &type=IID_IRndmFlat)
 Standard constructor.
 
virtual ~Param ()=default
 Standard Destructor.
 
virtual const InterfaceIDtype () const
 Parameter's type.
 

Static Public Member Functions

static const InterfaceIDtypeID ()
 Identifier for factory.
 

Protected Attributes

double m_minimum
 Lower boundary for random numbers.
 
double m_maximum
 Upper boundary for random numbers.
 
- Protected Attributes inherited from IRndmGen::Param
const InterfaceID m_type
 Type of the generator.
 

Detailed Description

Parameters for the flat random number generation within boundaries [minimum, maximum].

Definition at line 248 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Flat()

Rndm::Flat::Flat ( double mi,
double ma )
inline

Standard Constructor.

Definition at line 257 of file RndmGenerators.h.

257: IRndmGen::Param( IID_IRndmFlat ), m_minimum( mi ), m_maximum( ma ) {}
double m_maximum
Upper boundary for random numbers.
double m_minimum
Lower boundary for random numbers.

Member Function Documentation

◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 265 of file RndmGenerators.h.

265{ return new Flat( m_minimum, m_maximum ); }
Flat(double mi, double ma)
Standard Constructor.

◆ maximum()

double Rndm::Flat::maximum ( ) const
inline

Access upper edge.

Definition at line 261 of file RndmGenerators.h.

261{ return m_maximum; }

◆ minimum()

double Rndm::Flat::minimum ( ) const
inline

Access lower edge.

Definition at line 259 of file RndmGenerators.h.

259{ return m_minimum; }

◆ typeID()

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

Identifier for factory.

Definition at line 263 of file RndmGenerators.h.

263{ return IID_IRndmFlat; }

Member Data Documentation

◆ m_maximum

double Rndm::Flat::m_maximum
protected

Upper boundary for random numbers.

Definition at line 253 of file RndmGenerators.h.

◆ m_minimum

double Rndm::Flat::m_minimum
protected

Lower boundary for random numbers.

Definition at line 251 of file RndmGenerators.h.


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