gmx::GammaDistribution< RealType >::param_type Class Reference

#include <gromacs/random/gammadistribution.h>

Description

template<class RealType = real>
class gmx::GammaDistribution< RealType >::param_type

Gamma distribution parameters.

Public Types
typedef GammaDistribution	distribution_type
	Reference back to the distribution class.

Public Member Functions
	param_type (result_type alpha=1.0, result_type theta=1.0)
	Construct parameter block. More...
result_type	alpha () const
	Return shape parameter.
result_type	theta () const
	Return scale parameter.
bool	operator== (const param_type &x) const
	True if two parameter sets will return the same distribution. More...
bool	operator!= (const param_type &x) const
	True if two parameter sets will return different distributions. More...

Constructor & Destructor Documentation

template<class RealType = real>

gmx::GammaDistribution< RealType >::param_type::param_type ( result_type  alpha = 1.0, result_type  theta = 1.0  )

inlineexplicit

Construct parameter block.

Parameters

alpha	Shape parameter of gamma distribution
theta	Scale parameter of gamma distribution

Exceptions

InvalidInputError

if either parameter is negative or zero.

Member Function Documentation

template<class RealType = real>

bool gmx::GammaDistribution< RealType >::param_type::operator!= ( const param_type &  x ) const

inline

True if two parameter sets will return different distributions.

Parameters

x	Instance to compare with.

template<class RealType = real>

bool gmx::GammaDistribution< RealType >::param_type::operator== ( const param_type &  x ) const

inline

True if two parameter sets will return the same distribution.

Parameters

x	Instance to compare with.

---

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

• src/gromacs/random/gammadistribution.h