Infinity::Engine::GammaDistribution< RealType >::param_type Struct Reference

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types
using	distribution_type = GammaDistribution< RealType >

Public Member Functions
	param_type ()
	Default constructor. Creates parameters for Gamma(1, 1).
	param_type (RealType alpha, RealType beta=RealType(1))
	Constructs parameters.
RealType	alpha () const
	Gets the shape parameter.
RealType	beta () const
	Gets the scale parameter.

Friends
bool	operator== (const param_type &lhs, const param_type &rhs)
bool	operator!= (const param_type &lhs, const param_type &rhs)

Detailed Description

template<typename RealType = double>
struct Infinity::Engine::GammaDistribution< RealType >::param_type

Parameter set for the distribution.

Stores the shape (alpha) and scale (beta) parameters of the gamma distribution.

Member Typedef Documentation

distribution_type

template<typename RealType = double>

using Infinity::Engine::GammaDistribution< RealType >::param_type::distribution_type = GammaDistribution<RealType>

Constructor & Destructor Documentation

param_type() [1/2]

template<typename RealType = double>

Infinity::Engine::GammaDistribution< RealType >::param_type::param_type ( )

inline

Default constructor. Creates parameters for Gamma(1, 1).

param_type() [2/2]

template<typename RealType = double>

Infinity::Engine::GammaDistribution< RealType >::param_type::param_type ( RealType  alpha, RealType  beta = RealType(1)  )

inlineexplicit

Constructs parameters.

Parameters

alpha	Shape parameter (must be > 0)
beta	Scale parameter (must be > 0), defaults to 1

Member Function Documentation

alpha()

template<typename RealType = double>

RealType Infinity::Engine::GammaDistribution< RealType >::param_type::alpha ( ) const

inline

Gets the shape parameter.

beta()

template<typename RealType = double>

RealType Infinity::Engine::GammaDistribution< RealType >::param_type::beta ( ) const

inline

Gets the scale parameter.

Friends And Related Symbol Documentation

operator!=

template<typename RealType = double>

bool operator!= ( const param_type &  lhs, const param_type &  rhs  )

friend

operator==

template<typename RealType = double>

bool operator== ( const param_type &  lhs, const param_type &  rhs  )

friend