#include <Random.h>

Inheritance diagram for WireCell::Gen::Random:

Public Member Functions
	Random (const std::string &generator="default", const std::vector< unsigned int > seeds={0, 0, 0, 0, 0})

virtual	~Random ()

virtual void	configure (const WireCell::Configuration &config)
	Accept a configuration. More...

virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...

virtual int	binomial (int max, double prob)
	Sample a binomial distribution. More...

virtual int	poisson (double mean)
	Sample a Poisson distribution. More...

virtual double	normal (double mean, double sigma)
	Sample a normal distribution. More...

virtual double	uniform (double begin, double end)
	Sample a uniform distribution. More...

virtual double	exponential (double mean)
	Sample an exponential distribution. More...

virtual int	range (int first, int last)
	Sample a uniform integer range. More...

Public Member Functions inherited from WireCell::IRandom
virtual	~IRandom ()

Public Member Functions inherited from WireCell::IComponent< IRandom >
virtual	~IComponent ()

Public Member Functions inherited from WireCell::Interface
virtual	~Interface ()

Public Member Functions inherited from WireCell::IConfigurable
virtual	~IConfigurable ()

Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual	~IComponent ()

Private Attributes
std::string	m_generator

std::vector< unsigned int >	m_seeds

IRandom *	m_pimpl

Additional Inherited Members
Public Types inherited from WireCell::IComponent< IRandom >
typedef std::shared_ptr< IRandom >	pointer
	Access subclass facet by pointer. More...

typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer

Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...

typedef std::vector< pointer >	vector
	Vector of shared pointers. More...

Detailed Description

Definition at line 14 of file Random.h.

Constructor & Destructor Documentation

Gen::Random::Random	(	const std::string &	generator = `"default"`,
		const std::vector< unsigned int >	seeds = `{0,0,0,0,0}`
	)

Definition at line 25 of file Random.cxx.

     : m_generator(generator)
     , m_seeds(seeds.begin(), seeds.end())
     , m_pimpl(nullptr)
 {
 }

virtual WireCell::Gen::Random::~Random ( )

inlinevirtual

Definition at line 18 of file Random.h.

18 {}

Member Function Documentation

int Gen::Random::binomial	(	int	max,
		double	prob
	)

virtual

Sample a binomial distribution.

Implements WireCell::IRandom.

Definition at line 109 of file Random.cxx.

 {
     return m_pimpl->binomial(max, prob);
 }

void Gen::Random::configure ( const WireCell::Configuration & config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 71 of file Random.cxx.

 {
     auto jseeds = cfg["seeds"];
     if (not jseeds.isNull()) {
         std::vector<unsigned int> seeds;
         for (auto jseed : jseeds) {
             seeds.push_back(jseed.asInt());
         }
         m_seeds = seeds;
     }
     auto gen = get(cfg,"generator",m_generator);
     if (m_pimpl) {
         delete m_pimpl;
     }
     if (gen == "default") {
         m_pimpl = new RandomT<std::default_random_engine>(m_seeds);
     }
     else if (gen == "twister") {
         m_pimpl = new RandomT<std::mt19937>(m_seeds);
     }
     else {
         warn("Gen::Random::configure: warning: unknown random engine: \"{}\" using default", gen);
         m_pimpl = new RandomT<std::default_random_engine>(m_seeds);
     }
 }

WireCell::Configuration Gen::Random::default_configuration ( ) const

virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 97 of file Random.cxx.

 {
     Configuration cfg;
     cfg["generator"] = m_generator;
     Json::Value jseeds(Json::arrayValue);
     for (auto seed : m_seeds) {
         jseeds.append(seed);
     }
     cfg["seeds"] = jseeds;
     return cfg;
 }

double Gen::Random::exponential ( double mean )

virtual

Sample an exponential distribution.

Implements WireCell::IRandom.

Definition at line 128 of file Random.cxx.

 {
     return m_pimpl->exponential(mean);
 }

double Gen::Random::normal	(	double	mean,
		double	sigma
	)

virtual

Sample a normal distribution.

Implements WireCell::IRandom.

Definition at line 118 of file Random.cxx.

 {
     return m_pimpl->normal(mean, sigma);
 }

int Gen::Random::poisson ( double mean )

virtual

Sample a Poisson distribution.

Implements WireCell::IRandom.

Definition at line 113 of file Random.cxx.

 {
     return m_pimpl->poisson(mean);
 }

int Gen::Random::range	(	int	first,
		int	last
	)

virtual

Sample a uniform integer range.

Implements WireCell::IRandom.

Definition at line 133 of file Random.cxx.

 {
     return m_pimpl->range(first, last);
 }

double Gen::Random::uniform	(	double	begin,
		double	end
	)

virtual

Sample a uniform distribution.

Implements WireCell::IRandom.

Definition at line 123 of file Random.cxx.

 {
     return m_pimpl->uniform(begin, end);
 }

Member Data Documentation

std::string WireCell::Gen::Random::m_generator

private

Definition at line 43 of file Random.h.

IRandom* WireCell::Gen::Random::m_pimpl

private

Definition at line 45 of file Random.h.

std::vector<unsigned int> WireCell::Gen::Random::m_seeds

private

Definition at line 44 of file Random.h.

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

wire-cell-build/gen/inc/WireCellGen/Random.h
wire-cell-build/gen/src/Random.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation