KisRandomSource Class Reference

#include <kis_random_source.h>

Inheritance diagram for KisRandomSource:

Classes
struct	Private

Public Member Functions
qint64	generate () const
int	generate (int min, int max) const
qreal	generateGaussian (qreal mean, qreal sigma) const
qreal	generateNormalized () const
	KisRandomSource ()
	KisRandomSource (const KisRandomSource &rhs)
	KisRandomSource (int seed)
KisRandomSource &	operator= (const KisRandomSource &rhs)
	~KisRandomSource ()
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

KisRandomSource is a special object that wraps around random number generation routines.

It has the following properties:

1) Two KisRandomSource objects will generate exactly the same sequences of numbers if created with the same seed.

2) After copy-construction or assignment the two objects will continue to generate exactly the same numbers. Imagine like the history got forked.

3) Copying of a KisRandomSource object is fast. It uses Tauss88 algorithm to achieve this.

Definition at line 32 of file kis_random_source.h.

Constructor & Destructor Documentation

KisRandomSource() [1/3]

KisRandomSource::KisRandomSource

(

)

Definition at line 33 of file kis_random_source.cpp.

    : m_d(new Private)
{
}

KisRandomSource() [2/3]

KisRandomSource::KisRandomSource

(

int

seed

)

Definition at line 38 of file kis_random_source.cpp.

    : m_d(new Private(seed))
{
}

KisRandomSource() [3/3]

KisRandomSource::KisRandomSource

(

const KisRandomSource &

rhs

)

Definition at line 43 of file kis_random_source.cpp.

    : KisShared(),
      m_d(new Private(*rhs.m_d))
{
}

~KisRandomSource()

KisRandomSource::~KisRandomSource

(

)

Definition at line 58 of file kis_random_source.cpp.

{
}

Member Function Documentation

generate() [1/2]

qint64 KisRandomSource::generate

(

)

const

Generates a random number in a range from min() to max()

Definition at line 62 of file kis_random_source.cpp.

{
    return m_d->uniformSource();
}

References m_d.

generate() [2/2]

int KisRandomSource::generate	(	int	min,
		int	max ) const

Generates a random number in a range from min to max

Definition at line 67 of file kis_random_source.cpp.

{
    boost::uniform_smallint<int> smallint(min, max);
    return smallint(m_d->uniformSource);
}

References m_d.

generateGaussian()

qreal KisRandomSource::generateGaussian	(	qreal	mean,
		qreal	sigma ) const

Generates a number from the Gaussian distribution

Definition at line 82 of file kis_random_source.cpp.

{
    boost::normal_distribution<qreal> normal(mean, sigma);
    return normal(m_d->uniformSource);
}

References m_d.

generateNormalized()

qreal KisRandomSource::generateNormalized

(

)

const

Generates a random number in a closed range [0; 1.0]

Definition at line 73 of file kis_random_source.cpp.

{
    const qint64 v = m_d->uniformSource();
    const qint64 max = m_d->uniformSource.max();
    // we don't have min, because taus88 is always positive
 
    return qreal(v) / max;
}

References m_d, and v.

operator=()

KisRandomSource & KisRandomSource::operator=

(

const KisRandomSource &

rhs

)

Definition at line 49 of file kis_random_source.cpp.

{
    if (this != &rhs) {
        *m_d = *rhs.m_d;
    }
 
    return *this;
}

References m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisRandomSource::m_d

private

Definition at line 64 of file kis_random_source.h.

---

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

• libs/global/kis_random_source.h
• libs/global/kis_random_source.cpp