Infinity Engine v0.6.20
C++ API Documentation
Loading...
Searching...
No Matches
Infinity::Engine::WeibullDistribution< RealType >::param_type Struct Reference

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types

using distribution_type = WeibullDistribution< RealType >
 

Public Member Functions

 param_type ()
 Default constructor. Creates parameters for Weibull(1, 1) (exponential).
 
 param_type (RealType a, RealType b=RealType(1))
 Constructs parameters.
 
RealType a () const
 Gets the shape 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::WeibullDistribution< RealType >::param_type

Parameter set for the distribution.

Stores the shape and scale parameters of the Weibull distribution.

Member Typedef Documentation

◆ distribution_type

template<typename RealType = double>
using Infinity::Engine::WeibullDistribution< RealType >::param_type::distribution_type = WeibullDistribution<RealType>

Constructor & Destructor Documentation

◆ param_type() [1/2]

template<typename RealType = double>
Infinity::Engine::WeibullDistribution< RealType >::param_type::param_type ( )
inline

Default constructor. Creates parameters for Weibull(1, 1) (exponential).

◆ param_type() [2/2]

template<typename RealType = double>
Infinity::Engine::WeibullDistribution< RealType >::param_type::param_type ( RealType  a,
RealType  b = RealType(1) 
)
inlineexplicit

Constructs parameters.

Parameters
aShape parameter (must be > 0)
bScale parameter (must be > 0), defaults to 1

Member Function Documentation

◆ a()

template<typename RealType = double>
RealType Infinity::Engine::WeibullDistribution< RealType >::param_type::a ( ) const
inline

Gets the shape parameter.

◆ b()

template<typename RealType = double>
RealType Infinity::Engine::WeibullDistribution< 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