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

Standard uniform distribution on (0, 1]. More...

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

Classes

class  param_type
 

Public Types

using distribution_type = U01OCDistribution< RealType >
 
using result_type = RealType
 

Public Member Functions

 U01OCDistribution ()=default
 
 U01OCDistribution (const param_type &)
 
 U01OCDistribution (param_type &&)
 
result_type max () const
 
result_type min () const
 
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)
 
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_typeparam () const
 
void param (const param_type &param)
 
void param (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::U01OCDistribution< RealType >

Standard uniform distribution on (0, 1].

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

Member Typedef Documentation

◆ distribution_type

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

Definition at line 201 of file u01_distribution.hpp.

◆ result_type

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

Definition at line 201 of file u01_distribution.hpp.

Constructor & Destructor Documentation

◆ U01OCDistribution() [1/3]

template<typename RealType>
mckl::U01OCDistribution< RealType >::U01OCDistribution ( )
default

◆ U01OCDistribution() [2/3]

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

Definition at line 201 of file u01_distribution.hpp.

◆ U01OCDistribution() [3/3]

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

Definition at line 201 of file u01_distribution.hpp.

Member Function Documentation

◆ max()

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

Definition at line 201 of file u01_distribution.hpp.

◆ min()

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

Definition at line 201 of file u01_distribution.hpp.

◆ operator()() [1/4]

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

Definition at line 201 of file u01_distribution.hpp.

◆ operator()() [2/4]

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

Definition at line 201 of file u01_distribution.hpp.

◆ operator()() [3/4]

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

Definition at line 201 of file u01_distribution.hpp.

◆ operator()() [4/4]

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

Definition at line 201 of file u01_distribution.hpp.

◆ param() [1/3]

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

Definition at line 201 of file u01_distribution.hpp.

◆ param() [2/3]

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

Definition at line 201 of file u01_distribution.hpp.

◆ param() [3/3]

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

Definition at line 201 of file u01_distribution.hpp.

◆ reset()

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

Definition at line 201 of file u01_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 201 of file u01_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 201 of file u01_distribution.hpp.

◆ operator==

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

Definition at line 201 of file u01_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 201 of file u01_distribution.hpp.