noise::GammaGenerator Class Reference

Generates Gamma-distributed noise. More...

#include "noise_generators.h"

Inheritance diagram for noise::GammaGenerator:

Collaboration diagram for noise::GammaGenerator:

Public Member Functions
	GammaGenerator (std::mt19937 &rngEngine, const RealType k) noexcept
	Constructor to initialize the Gamma generator with a shape parameter.
RealType	getSample () noexcept override
	Generates a sample of Gamma noise.

Detailed Description

Generates Gamma-distributed noise.

Definition at line 87 of file noise_generators.h.

Constructor & Destructor Documentation

GammaGenerator()

noise::GammaGenerator::GammaGenerator ( std::mt19937 &  rngEngine, const RealType  k  )

explicitnoexcept

Constructor to initialize the Gamma generator with a shape parameter.

Parameters

rngEngine	The random number engine to use for generation.
k	The shape parameter of the Gamma distribution.

Definition at line 96 of file noise_generators.h.

                                                                                  :
            _rng_engine(rngEngine), _dist(k, 1.0)
        {
        }

Member Function Documentation

getSample()

RealType noise::GammaGenerator::getSample ( )

overridevirtualnoexcept

Generates a sample of Gamma noise.

Returns

A noise sample of type RealType.

Implements noise::NoiseGenerator.

Definition at line 106 of file noise_generators.h.

{ return _dist(_rng_engine.get()); }

---

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

• packages/libfers/src/noise/noise_generators.h