KisSprayFunctionBasedDistribution Class Reference

Class that can generate randomly distributed values in the range [a..b] following an arbitrary pdf. More...

#include <KisSprayRandomDistributions.h>

Inheritance diagram for KisSprayFunctionBasedDistribution:

Classes
class	Private

Public Member Functions
bool	isValid () const
	Return if this object is correctly initialized and can be used to generate values.
	KisSprayFunctionBasedDistribution ()
	Construct an invalid KisSprayFunctionBasedDistribution.
	KisSprayFunctionBasedDistribution (const KisSprayFunctionBasedDistribution &other)
template<typename Function >
	KisSprayFunctionBasedDistribution (int numberOfSamples, double a, double b, Function f)
	Construct a new distribution.
double	max () const
	Return the maximum value that this distribution can produce.
double	min () const
	Return the minimum value that this distribution can produce.
double	operator() (KisRandomSourceSP rs) const
	Get a random value between min and max that follows the distribution.
KisSprayFunctionBasedDistribution &	operator= (const KisSprayFunctionBasedDistribution &rhs)
	~KisSprayFunctionBasedDistribution ()

Protected Member Functions
template<typename Function >
void	initialize (size_t numberOfSamples, double a, double b, Function f)
	Function used to setup the distribution and put it in a valid state. See the constructor for the explanation of the parameters.

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Class that can generate randomly distributed values in the range [a..b] following an arbitrary pdf.

Definition at line 19 of file KisSprayRandomDistributions.h.

Constructor & Destructor Documentation

KisSprayFunctionBasedDistribution() [1/3]

KisSprayFunctionBasedDistribution::KisSprayFunctionBasedDistribution

(

)

Construct an invalid KisSprayFunctionBasedDistribution.

Definition at line 162 of file KisSprayRandomDistributions.cpp.

    : m_d(new Private)
{}

KisSprayFunctionBasedDistribution() [2/3]

template<typename Function >

KisSprayFunctionBasedDistribution::KisSprayFunctionBasedDistribution	(	int	numberOfSamples,
		double	a,
		double	b,
		Function	f )

Construct a new distribution.

Template Parameters

Function

Type of the functor to sample from

Parameters

numberOfSamples	Number of points to sample from the function. They are sampled evenly through the range [a..b]. The first point will be sampled at a and the last one at b.
a	The lower bound of the domain of the function. The sampling will start here
b	The upper bound of the domain of the function. The sampling will start here
f	The functor that will be used to get the samples

Definition at line 167 of file KisSprayRandomDistributions.cpp.

    : m_d(new Private)
{
    m_d->initialize(numberOfSamples, a, b, f);
}

References m_d.

~KisSprayFunctionBasedDistribution()

KisSprayFunctionBasedDistribution::~KisSprayFunctionBasedDistribution

(

)

Definition at line 173 of file KisSprayRandomDistributions.cpp.

{}

KisSprayFunctionBasedDistribution() [3/3]

KisSprayFunctionBasedDistribution::KisSprayFunctionBasedDistribution

(

const KisSprayFunctionBasedDistribution &

other

)

Definition at line 176 of file KisSprayRandomDistributions.cpp.

    : m_d(new Private)
{
    m_d->samples = other.m_d->samples;
}

References m_d.

Member Function Documentation

initialize()

template<typename Function >

void KisSprayFunctionBasedDistribution::initialize ( size_t numberOfSamples, double a, double b, Function f )

protected

Function used to setup the distribution and put it in a valid state. See the constructor for the explanation of the parameters.

Definition at line 215 of file KisSprayRandomDistributions.cpp.

{
    m_d->initialize(numberOfSamples, a, b, f);
}

References m_d.

isValid()

bool KisSprayFunctionBasedDistribution::isValid

(

)

const

Return if this object is correctly initialized and can be used to generate values.

Definition at line 209 of file KisSprayRandomDistributions.cpp.

{
    return m_d->samples.size() > 1;
}

References m_d.

max()

double KisSprayFunctionBasedDistribution::max

(

)

const

Return the maximum value that this distribution can produce.

Definition at line 202 of file KisSprayRandomDistributions.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(isValid(), NAN);
 
    return m_d->samples.back().x;
}

References isValid(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and m_d.

min()

double KisSprayFunctionBasedDistribution::min

(

)

const

Return the minimum value that this distribution can produce.

Definition at line 195 of file KisSprayRandomDistributions.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(isValid(), NAN);
 
    return m_d->samples.front().x;
}

References isValid(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, and m_d.

operator()()

double KisSprayFunctionBasedDistribution::operator()

(

KisRandomSourceSP

rs

)

const

Get a random value between min and max that follows the distribution.

Parameters

rs	The random source object that will be used to get a uniform value

Returns

A random value between min and max that follows the distribution

Definition at line 190 of file KisSprayRandomDistributions.cpp.

{
    return m_d->generate(rs->generateNormalized());
}

References KisRandomSource::generateNormalized(), and m_d.

operator=()

KisSprayFunctionBasedDistribution & KisSprayFunctionBasedDistribution::operator=

(

const KisSprayFunctionBasedDistribution &

rhs

)

Member Data Documentation

m_d

QScopedPointer<Private> KisSprayFunctionBasedDistribution::m_d

private

Definition at line 81 of file KisSprayRandomDistributions.h.

---

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

• plugins/paintops/spray/KisSprayRandomDistributions.h
• plugins/paintops/spray/KisSprayRandomDistributions.cpp