DiscreteUniformSampler Class Reference

Represents a discrete uniform distribution X ~ U(min, max) p(x) = 1 / (max - min). More...

#include <DiscreteUniformSampler.h>

Inheritance diagram for DiscreteUniformSampler:

List of all members.

Public Member Functions
Constructors
	DiscreteUniformSampler (int min=0, int max=6)
	DiscreteUniformSampler (const int *data, const unsigned n)
	DiscreteUniformSampler (const DiscreteUniformSampler &copy)
virtual	~DiscreteUniformSampler ()
Main usage interface
virtual Event	sample ()
virtual real_t	getPdf (const Event &event) PURE_FUNCTION
Protected Attributes
Random::BoostDiscreteUniformSampler	m_sampler
const int *	m_data

---

Detailed Description

Represents a discrete uniform distribution X ~ U(min, max) p(x) = 1 / (max - min).

Author:

Travis Fischer (fisch0920@gmail.com)

Matthew Jacobs (jacobs.mh@gmail.com)

Date:

Fall 2008

Definition at line 18 of file DiscreteUniformSampler.h.

---

Constructor & Destructor Documentation

DiscreteUniformSampler::DiscreteUniformSampler	(	int	min = 0,
		int	max = 6
	)			[inline, explicit]

Definition at line 24 of file DiscreteUniformSampler.h.

DiscreteUniformSampler::DiscreteUniformSampler	(	const int *	data,
		const unsigned	n
	)			[inline, explicit]

Definition at line 31 of file DiscreteUniformSampler.h.

DiscreteUniformSampler::DiscreteUniformSampler

(

const DiscreteUniformSampler &

copy

)

[inline]

Definition at line 38 of file DiscreteUniformSampler.h.

virtual DiscreteUniformSampler::~DiscreteUniformSampler

(

)

[inline, virtual]

Definition at line 44 of file DiscreteUniformSampler.h.

---

Member Function Documentation

Event DiscreteUniformSampler::sample

(

)

[virtual]

Returns:

a randomly chosen event x, sampled from this random variable's sample space

Note:

consecutive calls to sample are expected to return independent, identically distributed (IID) samples

Implements Sampler.

Definition at line 15 of file DiscreteUniformSampler.cpp.

real_t DiscreteUniformSampler::getPdf

(

const Event &

event

)

[virtual]

Returns:

the probability density with which the given event would be sampled according to the underlying probability density function

Note:

the given event is assumed to lie within this random variable's sample space

Implements Sampler.

Definition at line 24 of file DiscreteUniformSampler.cpp.

---

Member Data Documentation

Random::BoostDiscreteUniformSampler DiscreteUniformSampler::m_sampler [protected]

Definition at line 72 of file DiscreteUniformSampler.h.

const int* DiscreteUniformSampler::m_data [protected]

Definition at line 74 of file DiscreteUniformSampler.h.

---

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

• DiscreteUniformSampler.h
• DiscreteUniformSampler.cpp