MCKL
Monte Carlo Kernel Library
Classes | Public Types | Public Member Functions | Friends | List of all members
mckl::WeibullDistribution< RealType > Class Template Reference

Weibull distribution. More...

#include <mckl/random/internal/common.hpp>

Classes

class  param_type
 

Public Types

using distribution_type = WeibullDistribution< RealType >
 
using result_type = RealType
 

Public Member Functions

 WeibullDistribution (result_type a=1, result_type b=1)
 
 WeibullDistribution (const param_type &param)
 
 WeibullDistribution (param_type &&param)
 
result_type a () const
 
result_type b () const
 
result_type max () const
 
result_type min () const
 
template<typename RNGType >
result_type operator() (RNGType &rng)
 
template<typename RNGType >
void operator() (RNGType &rng, std::size_t n, result_type *r, const param_type &param)
 
template<typename RNGType >
result_type operator() (RNGType &rng, const param_type &param)
 
template<typename RNGType >
void operator() (RNGType &rng, std::size_t n, result_type *r)
 
void param (param_type &&param)
 
const param_typeparam () const
 
void param (const param_type &param)
 
void reset ()
 

Friends

bool operator!= (const distribution_type &dist1, const distribution_type &dist2)
 
template<typename CharT , typename Traits >
std::basic_ostream< CharT, Traits > & operator<< (std::basic_ostream< CharT, Traits > &os, const distribution_type &dist)
 
bool operator== (const distribution_type &dist1, const distribution_type &dist2)
 
template<typename CharT , typename Traits >
std::basic_istream< CharT, Traits > & operator>> (std::basic_istream< CharT, Traits > &is, distribution_type &dist)
 

Detailed Description

template<typename RealType>
class mckl::WeibullDistribution< RealType >

Weibull distribution.

Definition at line 1093 of file random/internal/common.hpp.

Member Typedef Documentation

◆ distribution_type

template<typename RealType >
using mckl::WeibullDistribution< RealType >::distribution_type = WeibullDistribution< RealType >

Definition at line 80 of file weibull_distribution.hpp.

◆ result_type

template<typename RealType >
using mckl::WeibullDistribution< RealType >::result_type = RealType

Definition at line 80 of file weibull_distribution.hpp.

Constructor & Destructor Documentation

◆ WeibullDistribution() [1/3]

template<typename RealType >
mckl::WeibullDistribution< RealType >::WeibullDistribution ( result_type  a = 1,
result_type  b = 1 
)
inlineexplicit

Definition at line 80 of file weibull_distribution.hpp.

◆ WeibullDistribution() [2/3]

template<typename RealType >
mckl::WeibullDistribution< RealType >::WeibullDistribution ( const param_type param)
inlineexplicit

Definition at line 80 of file weibull_distribution.hpp.

◆ WeibullDistribution() [3/3]

template<typename RealType >
mckl::WeibullDistribution< RealType >::WeibullDistribution ( param_type &&  param)
inlineexplicit

Definition at line 80 of file weibull_distribution.hpp.

Member Function Documentation

◆ a()

template<typename RealType >
result_type mckl::WeibullDistribution< RealType >::a ( ) const
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ b()

template<typename RealType >
result_type mckl::WeibullDistribution< RealType >::b ( ) const
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ max()

template<typename RealType >
result_type mckl::WeibullDistribution< RealType >::max ( ) const
inline

Definition at line 86 of file weibull_distribution.hpp.

◆ min()

template<typename RealType >
result_type mckl::WeibullDistribution< RealType >::min ( ) const
inline

Definition at line 84 of file weibull_distribution.hpp.

◆ operator()() [1/4]

template<typename RealType >
template<typename RNGType >
void mckl::WeibullDistribution< RealType >::operator() ( RNGType &  rng,
std::size_t  n,
result_type r 
)
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ operator()() [2/4]

template<typename RealType >
template<typename RNGType >
void mckl::WeibullDistribution< RealType >::operator() ( RNGType &  rng,
std::size_t  n,
result_type r,
const param_type param 
)
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ operator()() [3/4]

template<typename RealType >
template<typename RNGType >
result_type mckl::WeibullDistribution< RealType >::operator() ( RNGType &  rng,
const param_type param 
)
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ operator()() [4/4]

template<typename RealType >
template<typename RNGType >
result_type mckl::WeibullDistribution< RealType >::operator() ( RNGType &  rng)
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ param() [1/3]

template<typename RealType >
void mckl::WeibullDistribution< RealType >::param ( param_type &&  param)
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ param() [2/3]

template<typename RealType >
void mckl::WeibullDistribution< RealType >::param ( const param_type param)
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ param() [3/3]

template<typename RealType >
const param_type& mckl::WeibullDistribution< RealType >::param ( ) const
inline

Definition at line 80 of file weibull_distribution.hpp.

◆ reset()

template<typename RealType >
void mckl::WeibullDistribution< RealType >::reset ( )
inline

Definition at line 88 of file weibull_distribution.hpp.

Friends And Related Function Documentation

◆ operator!=

template<typename RealType >
bool operator!= ( const distribution_type dist1,
const distribution_type dist2 
)
friend

Definition at line 80 of file weibull_distribution.hpp.

◆ operator<<

template<typename RealType >
template<typename CharT , typename Traits >
std::basic_ostream<CharT, Traits>& operator<< ( std::basic_ostream< CharT, Traits > &  os,
const distribution_type dist 
)
friend

Definition at line 80 of file weibull_distribution.hpp.

◆ operator==

template<typename RealType >
bool operator== ( const distribution_type dist1,
const distribution_type dist2 
)
friend

Definition at line 80 of file weibull_distribution.hpp.

◆ operator>>

template<typename RealType >
template<typename CharT , typename Traits >
std::basic_istream<CharT, Traits>& operator>> ( std::basic_istream< CharT, Traits > &  is,
distribution_type dist 
)
friend

Definition at line 80 of file weibull_distribution.hpp.