ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
viennashe::math::normal_distribution< RealT, ResultT > Class Template Reference

#include <random.hpp>

Public Member Functions

 normal_distribution (RealT const &mean, RealT const &sigma)
 
RealT mean () const
 
RealT sigma () const
 
template<typename RandGeneratorType >
ResultT operator() (RandGeneratorType &gen)
 Returns a Gaussian distributed random number; Algorithm: Box-Muller. More...
 

Detailed Description

template<typename RealT = double, typename ResultT = double>
class viennashe::math::normal_distribution< RealT, ResultT >

Definition at line 223 of file random.hpp.

Constructor & Destructor Documentation

◆ normal_distribution()

template<typename RealT = double, typename ResultT = double>
viennashe::math::normal_distribution< RealT, ResultT >::normal_distribution ( RealT const &  mean,
RealT const &  sigma 
)
inline

Definition at line 231 of file random.hpp.

Member Function Documentation

◆ mean()

template<typename RealT = double, typename ResultT = double>
RealT viennashe::math::normal_distribution< RealT, ResultT >::mean ( ) const
inline

Definition at line 235 of file random.hpp.

◆ operator()()

template<typename RealT = double, typename ResultT = double>
template<typename RandGeneratorType >
ResultT viennashe::math::normal_distribution< RealT, ResultT >::operator() ( RandGeneratorType &  gen)
inline

Returns a Gaussian distributed random number; Algorithm: Box-Muller.

Parameters
genA random number generator implementing the concept of rand_generator_base
Returns
A Gaussian distributed random number

Definition at line 244 of file random.hpp.

◆ sigma()

template<typename RealT = double, typename ResultT = double>
RealT viennashe::math::normal_distribution< RealT, ResultT >::sigma ( ) const
inline

Definition at line 236 of file random.hpp.


The documentation for this class was generated from the following file: