The Gaudi Framework  v38r1 (3af3a718)
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. More...
 
double minimum () const
 Access lower edge. More...
 
double maximum () const
 Access upper edge. More...
 
Flat * clone () 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 InterfaceID & type () const
 Parameter's type. More...
 

Static Public Member Functions

static const InterfaceID & typeID ()
 Identifier for factory. More...
 

Protected Attributes

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

Detailed Description

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

Definition at line 253 of file RndmGenerators.h.

Constructor & Destructor Documentation

◆ Flat()

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

Standard Constructor.

Definition at line 262 of file RndmGenerators.h.

262 : IRndmGen::Param( IID_IRndmFlat ), m_minimum( mi ), m_maximum( ma ) {}

Member Function Documentation

◆ clone()

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

Clone parameters.

Implements IRndmGen::Param.

Definition at line 270 of file RndmGenerators.h.

270 { return new Flat( m_minimum, m_maximum ); }

◆ maximum()

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

Access upper edge.

Definition at line 266 of file RndmGenerators.h.

266 { return m_maximum; }

◆ minimum()

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

Access lower edge.

Definition at line 264 of file RndmGenerators.h.

264 { return m_minimum; }

◆ typeID()

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

Identifier for factory.

Definition at line 268 of file RndmGenerators.h.

268 { return IID_IRndmFlat; }

Member Data Documentation

◆ m_maximum

double Rndm::Flat::m_maximum
protected

Upper boundary for random numbers.

Definition at line 258 of file RndmGenerators.h.

◆ m_minimum

double Rndm::Flat::m_minimum
protected

Lower boundary for random numbers.

Definition at line 256 of file RndmGenerators.h.


The documentation for this class was generated from the following file:
Rndm::Flat::m_maximum
double m_maximum
Upper boundary for random numbers.
Definition: RndmGenerators.h:258
IRndmGen::Param
Definition: IRndmGen.h:49
Rndm::Flat::Flat
Flat(double mi, double ma)
Standard Constructor.
Definition: RndmGenerators.h:262
Rndm::Flat::m_minimum
double m_minimum
Lower boundary for random numbers.
Definition: RndmGenerators.h:256