MCKL
Monte Carlo Kernel Library
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
mckl::RDRANDEngine< ResultType, NTrialMax > Class Template Reference

RDRAND generator. More...

#include <mckl/random/rdrand.hpp>

Public Types

using result_type = ResultType
 

Public Member Functions

 RDRANDEngine ()=default
 
template<typename Seed >
 RDRANDEngine (const Seed &)
 
void discard (std::size_t)
 
result_type operator() ()
 
template<typename Seed >
void seed (const Seed &)
 

Static Public Member Functions

static constexpr result_type max ()
 
static constexpr result_type min ()
 

Friends

bool operator!= (const RDRANDEngine< ResultType, NTrialMax > &, const RDRANDEngine< ResultType, NTrialMax > &)
 
template<typename CharT , typename CharTraits >
std::basic_ostream< CharT, CharTraits > & operator<< (std::basic_ostream< CharT, CharTraits > &os, const RDRANDEngine< ResultType, NTrialMax > &)
 
bool operator== (const RDRANDEngine< ResultType, NTrialMax > &, const RDRANDEngine< ResultType, NTrialMax > &)
 
template<typename CharT , typename CharTraits >
std::basic_istream< CharT, CharTraits > & operator>> (std::basic_istream< CharT, CharTraits > &is, RDRANDEngine< ResultType, NTrialMax > &)
 

Detailed Description

template<typename ResultType, std::size_t NTrialMax = 0>
class mckl::RDRANDEngine< ResultType, NTrialMax >

RDRAND generator.

Definition at line 91 of file rdrand.hpp.

Member Typedef Documentation

◆ result_type

template<typename ResultType , std::size_t NTrialMax = 0>
using mckl::RDRANDEngine< ResultType, NTrialMax >::result_type = ResultType

Definition at line 104 of file rdrand.hpp.

Constructor & Destructor Documentation

◆ RDRANDEngine() [1/2]

template<typename ResultType , std::size_t NTrialMax = 0>
mckl::RDRANDEngine< ResultType, NTrialMax >::RDRANDEngine ( )
default

◆ RDRANDEngine() [2/2]

template<typename ResultType , std::size_t NTrialMax = 0>
template<typename Seed >
mckl::RDRANDEngine< ResultType, NTrialMax >::RDRANDEngine ( const Seed )
inlineexplicit

Definition at line 109 of file rdrand.hpp.

Member Function Documentation

◆ discard()

template<typename ResultType , std::size_t NTrialMax = 0>
void mckl::RDRANDEngine< ResultType, NTrialMax >::discard ( std::size_t  )
inline

Definition at line 123 of file rdrand.hpp.

◆ max()

template<typename ResultType , std::size_t NTrialMax = 0>
static constexpr result_type mckl::RDRANDEngine< ResultType, NTrialMax >::max ( )
inlinestatic

Definition at line 130 of file rdrand.hpp.

◆ min()

template<typename ResultType , std::size_t NTrialMax = 0>
static constexpr result_type mckl::RDRANDEngine< ResultType, NTrialMax >::min ( )
inlinestatic

Definition at line 125 of file rdrand.hpp.

◆ operator()()

template<typename ResultType , std::size_t NTrialMax = 0>
result_type mckl::RDRANDEngine< ResultType, NTrialMax >::operator() ( )
inline

Definition at line 118 of file rdrand.hpp.

◆ seed()

template<typename ResultType , std::size_t NTrialMax = 0>
template<typename Seed >
void mckl::RDRANDEngine< ResultType, NTrialMax >::seed ( const Seed )
inline

Definition at line 114 of file rdrand.hpp.

Friends And Related Function Documentation

◆ operator!=

template<typename ResultType , std::size_t NTrialMax = 0>
bool operator!= ( const RDRANDEngine< ResultType, NTrialMax > &  ,
const RDRANDEngine< ResultType, NTrialMax > &   
)
friend

Definition at line 141 of file rdrand.hpp.

◆ operator<<

template<typename ResultType , std::size_t NTrialMax = 0>
template<typename CharT , typename CharTraits >
std::basic_ostream<CharT, CharTraits>& operator<< ( std::basic_ostream< CharT, CharTraits > &  os,
const RDRANDEngine< ResultType, NTrialMax > &   
)
friend

Definition at line 148 of file rdrand.hpp.

◆ operator==

template<typename ResultType , std::size_t NTrialMax = 0>
bool operator== ( const RDRANDEngine< ResultType, NTrialMax > &  ,
const RDRANDEngine< ResultType, NTrialMax > &   
)
friend

Definition at line 135 of file rdrand.hpp.

◆ operator>>

template<typename ResultType , std::size_t NTrialMax = 0>
template<typename CharT , typename CharTraits >
std::basic_istream<CharT, CharTraits>& operator>> ( std::basic_istream< CharT, CharTraits > &  is,
RDRANDEngine< ResultType, NTrialMax > &   
)
friend

Definition at line 156 of file rdrand.hpp.