A class for sampling w.r.t. More...

#include <agrum/core/math/Dirichlet.h>

Public Member Functions
template<class URNG >
INLINE Dirichlet::result_type	operator() (URNG &generator, const Dirichlet::param_type &parm)

Constructors / Destructors
	Dirichlet (const param_type &params, unsigned int seed=GUM_RANDOMSEED)
	Default constructor. More...

	Dirichlet (const Dirichlet &from)
	Copy constructor. More...

	Dirichlet (Dirichlet &&from)
	Move constructor. More...

	~Dirichlet ()
	Class destructor. More...

Operators
Dirichlet &	operator= (const Dirichlet &from)
	Copy operator. More...

Dirichlet &	operator= (Dirichlet &&from)
	Move operator. More...

result_type	operator() ()
	Returns a sample from the Dirichlet distribution. More...

result_type	operator() (const param_type &p)
	Returns a sample from the Dirichlet distribution. More...

template<class URNG >
result_type	operator() (URNG &generator, const param_type &p)
	Returns a sample from the Dirichlet distribution. More...

Accessors / Modifiers
const param_type &	param () const noexcept
	Returns the parameters of the distribution. More...

void	param (const param_type &p)
	Sets the parameters of the distribution. More...

float	min () const noexcept
	Returns the greatest lower bound of the range of values returned by gum::Dirichlet::operator()(). More...

float	max () const noexcept
	Returns the lowest higher bound of the range of values returned by gum::Dirichlet::operator()(). More...

Public Types
using	param_type = std::vector< float >
	The parameter type. More...

using	result_type = std::vector< float >
	The type for the samples generated. More...

Detailed Description

A class for sampling w.r.t.

Dirichlet distributions.

Definition at line 50 of file Dirichlet.h.

Member Typedef Documentation

◆ param_type

using gum::Dirichlet::param_type = std::vector< float >

The parameter type.

Definition at line 53 of file Dirichlet.h.

◆ result_type

using gum::Dirichlet::result_type = std::vector< float >

The type for the samples generated.

Definition at line 56 of file Dirichlet.h.

Constructor & Destructor Documentation

◆ Dirichlet() [1/3]

INLINE gum::Dirichlet::Dirichlet	(	const param_type &	params,
		unsigned int	seed = `GUM_RANDOMSEED`
	)

Default constructor.

Parameters

params	The distribution parameters.
seed	The distribution seed.

Definition at line 32 of file Dirichlet_inl.h.

                                                                          :
       __generator(gum::getRandomGenerator(seed)), __params(params) {
     GUM_CONSTRUCTOR(Dirichlet);
   }

◆ Dirichlet() [2/3]

INLINE gum::Dirichlet::Dirichlet ( const Dirichlet & from )

Copy constructor.

Parameters

from	The distribution to copy.

Definition at line 38 of file Dirichlet_inl.h.

                                                    :
       __generator(from.__generator), __gamma(from.__gamma),
       __params(from.__params) {
     GUM_CONS_CPY(Dirichlet);
   }

◆ Dirichlet() [3/3]

INLINE gum::Dirichlet::Dirichlet ( Dirichlet && from )

Move constructor.

Parameters

from	The distribution to move.

Definition at line 45 of file Dirichlet_inl.h.

                                               :
       __generator(std::move(from.__generator)), __gamma(std::move(from.__gamma)),
       __params(std::move(from.__params)) {
     GUM_CONS_MOV(Dirichlet);
   }

◆ ~Dirichlet()

INLINE gum::Dirichlet::~Dirichlet ( )

Class destructor.

Definition at line 52 of file Dirichlet_inl.h.

52 { GUM_DESTRUCTOR(Dirichlet); }

gum::Dirichlet::Dirichlet

Dirichlet(const param_type &params, unsigned int seed=GUM_RANDOMSEED)

Default constructor.

Definition: Dirichlet_inl.h:32

Member Function Documentation

◆ max()

INLINE float gum::Dirichlet::max ( ) const

noexcept

Returns the lowest higher bound of the range of values returned by gum::Dirichlet::operator()().

Returns: Returns the lowest higher bound of the range of values returned by gum::Dirichlet::operator()().

Definition at line 126 of file Dirichlet_inl.h.

126 { return 1.0f; }

◆ min()

INLINE float gum::Dirichlet::min ( ) const

noexcept

Returns the greatest lower bound of the range of values returned by gum::Dirichlet::operator()().

Returns: Returns the greatest lower bound of the range of values returned by gum::Dirichlet::operator()().

Definition at line 123 of file Dirichlet_inl.h.

123 { return 0.0f; }

◆ operator()() [1/4]

template<class URNG >

INLINE Dirichlet::result_type gum::Dirichlet::operator()	(	URNG &	generator,
		const Dirichlet::param_type &	parm
	)

Definition at line 35 of file Dirichlet_tpl.h.

References __gamma.

                                                                                              {
     Size        size = Size(parm.size());
     result_type res(size);
     float       sum = 0.0f;
     while (sum == 0.0f) {
       for (Idx i = 0; i < size; ++i) {
         __gamma.param(std::gamma_distribution< float >::param_type(parm[i], 1));
         res[i] = __gamma(generator);
         sum += res[i];
       }
     }
     for (Idx i = 0; i < size; ++i) {
       res[i] /= sum;
     }
     return res;
   }

◆ operator()() [2/4]

INLINE Dirichlet::result_type gum::Dirichlet::operator() ( )

Returns a sample from the Dirichlet distribution.

Returns: Returns a sample from the Dirichlet distribution.

Definition at line 75 of file Dirichlet_inl.h.

References __gamma, __generator, and __params.

                                                     {
     Size        size = Size(__params.size());
     result_type res(size);
     float       sum = 0.0f;
     while (sum == 0.0f) {
       for (Idx i = 0; i < size; ++i) {
         __gamma.param(
            std::gamma_distribution< float >::param_type(__params[i], 1));
         res[i] = __gamma(__generator);
         sum += res[i];
       }
     }
     for (Idx i = 0; i < size; ++i) {
       res[i] /= sum;
     }
     return res;
   }

◆ operator()() [3/4]

INLINE Dirichlet::result_type gum::Dirichlet::operator() ( const param_type & p )

Returns a sample from the Dirichlet distribution.

Parameters

p	An object representing the distribution's parameters, obtained by a call to gum::Dirichlet::param(const param_type&).

Definition at line 95 of file Dirichlet_inl.h.

References __gamma, and __generator.

                                                                             {
     Size        size = Size(parm.size());
     result_type res(size);
     float       sum = 0.0f;
     while (sum == 0.0f) {
       for (Idx i = 0; i < size; ++i) {
         __gamma.param(std::gamma_distribution< float >::param_type(parm[i], 1));
         res[i] = __gamma(__generator);
         sum += res[i];
       }
     }
     for (Idx i = 0; i < size; ++i) {
       res[i] /= sum;
     }
     return res;
   }

◆ operator()() [4/4]

template<class URNG >

result_type gum::Dirichlet::operator()	(	URNG &	generator,
		const param_type &	p
	)

Returns a sample from the Dirichlet distribution.

Parameters

generator	A uniform random number generator object, used as the source of randomness. URNG shall be a uniform random number generator type, such as one of the standard generator classes.
p	An object representing the distribution's parameters, obtained by a call to gum::Dirichlet::param(const param_type&).

◆ operator=() [1/2]

INLINE Dirichlet & gum::Dirichlet::operator= ( const Dirichlet & from )

Copy operator.

Parameters

from	The distribution to copy.

Returns: Returns this gum::Dirichlet distribution.

Definition at line 55 of file Dirichlet_inl.h.

References __gamma, __generator, and __params.

                                                               {
     if (&from != this) {
       __generator = from.__generator;
       __gamma = from.__gamma;
       __params = from.__params;
     }
     return *this;
   }

◆ operator=() [2/2]

INLINE Dirichlet & gum::Dirichlet::operator= ( Dirichlet && from )

Move operator.

Parameters

from	The distribution to move.

Returns: Returns this gum::Dirichlet distribution.

Definition at line 65 of file Dirichlet_inl.h.

References __gamma, __generator, and __params.

                                                          {
     if (&from != this) {
       __generator = std::move(from.__generator);
       __gamma = std::move(from.__gamma);
       __params = std::move(from.__params);
     }
     return *this;
   }

◆ param() [1/2]

INLINE const Dirichlet::param_type & gum::Dirichlet::param ( ) const

noexcept

Returns the parameters of the distribution.

Returns: Returns the parameters of the distribution.

Definition at line 113 of file Dirichlet_inl.h.

References __params.

                                                                     {
     return __params;
   }

◆ param() [2/2]

INLINE void gum::Dirichlet::param ( const param_type & p )

Sets the parameters of the distribution.

Parameters

p	An object representing the distribution's parameters, obtained by a call to member function param.

Definition at line 118 of file Dirichlet_inl.h.

References __params.

                                                               {
     __params = parm;
   }

Member Data Documentation

◆ __gamma

std::gamma_distribution< float > gum::Dirichlet::__gamma

private

The gamma distribution used to compute the Dirichlet unnormalized samples.

Definition at line 175 of file Dirichlet.h.

Referenced by operator()(), and operator=().

◆ __generator

std::default_random_engine gum::Dirichlet::__generator

private

The random engine used by the unform random distribution.

Definition at line 171 of file Dirichlet.h.

Referenced by operator()(), and operator=().

◆ __params

param_type gum::Dirichlet::__params

private

The parameters of the distribution.

Definition at line 178 of file Dirichlet.h.

Referenced by operator()(), operator=(), and param().

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

agrum/core/math/Dirichlet.h
agrum/core/math/Dirichlet_inl.h
agrum/core/math/Dirichlet_tpl.h

Public Member Functions

Public Types

Detailed Description

Member Typedef Documentation

◆ param_type

◆ result_type

Constructor & Destructor Documentation

◆ Dirichlet() [1/3]

◆ Dirichlet() [2/3]

◆ Dirichlet() [3/3]

◆ ~Dirichlet()

Member Function Documentation

◆ max()

◆ min()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ param() [1/2]

◆ param() [2/2]

Member Data Documentation

◆ __gamma

◆ __generator

◆ __params