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

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types
using	distribution_type = ExtremeValueDistribution< RealType >

Public Member Functions
	param_type ()
	Default constructor. Creates parameters for standard Gumbel (a=0, b=1).
	param_type (RealType a, RealType b=RealType(1))
	Constructs parameters.
RealType	a () const
	Gets the location parameter.
RealType	b () 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::ExtremeValueDistribution< RealType >::param_type

Parameter set for the distribution.

Stores the location and scale parameters of the extreme value distribution.

Member Typedef Documentation

distribution_type

template<typename RealType = double>

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

Constructor & Destructor Documentation

param_type() [1/2]

template<typename RealType = double>

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

inline

Default constructor. Creates parameters for standard Gumbel (a=0, b=1).

param_type() [2/2]

template<typename RealType = double>

Infinity::Engine::ExtremeValueDistribution< RealType >::param_type::param_type ( RealType  a, RealType  b = RealType(1)  )

inlineexplicit

Constructs parameters.

Parameters

a	Location parameter (mode of the distribution)
b	Scale parameter (must be > 0), defaults to 1

Member Function Documentation

a()

template<typename RealType = double>

RealType Infinity::Engine::ExtremeValueDistribution< RealType >::param_type::a ( ) const

inline

Gets the location parameter.

b()

template<typename RealType = double>

RealType Infinity::Engine::ExtremeValueDistribution< RealType >::param_type::b ( ) 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