BioCMAMC-ST
MC::Distributions::TruncatedNormal< F > Struct Template Reference

Represents a TruncatedNormal (Gaussian) probability distribution. More...

#include <prng_extension.hpp>

Collaboration diagram for MC::Distributions::TruncatedNormal< F >:
[legend]

Public Member Functions

KOKKOS_INLINE_FUNCTION constexpr TruncatedNormal (F m, F s, F l, F u)
 
template<class DeviceType >
KOKKOS_INLINE_FUNCTION F draw (Kokkos::Random_XorShift1024< DeviceType > &gen) const
 
KOKKOS_INLINE_FUNCTION F mean () const
 
KOKKOS_INLINE_FUNCTION F var () const
 
KOKKOS_INLINE_FUNCTION F skewness () const
 

Static Public Member Functions

template<class DeviceType >
static KOKKOS_INLINE_FUNCTION F draw_from (Kokkos::Random_XorShift1024< DeviceType > &gen, F mu, F sigma, F lower, F upper)
 

Public Attributes

mu
 
sigma
 
lower
 
upper
 

Detailed Description

template<FloatingPointType F>
struct MC::Distributions::TruncatedNormal< F >

Represents a TruncatedNormal (Gaussian) probability distribution.

The normal distribution is parameterized by a mean, a standard deviation and lower and upper bound. It supports random sampling, computing statistical properties.

Template Parameters
FFloating-point type (must satisfy FloatingPointType).

Constructor & Destructor Documentation

◆ TruncatedNormal()

template<FloatingPointType F>
KOKKOS_INLINE_FUNCTION constexpr MC::Distributions::TruncatedNormal< F >::TruncatedNormal ( F m,
F s,
F l,
F u )
inlineconstexpr

Member Function Documentation

◆ draw()

template<FloatingPointType F>
template<class DeviceType >
KOKKOS_INLINE_FUNCTION F MC::Distributions::TruncatedNormal< F >::draw ( Kokkos::Random_XorShift1024< DeviceType > & gen) const
inline
Here is the call graph for this function:

◆ draw_from()

template<FloatingPointType F>
template<class DeviceType >
static KOKKOS_INLINE_FUNCTION F MC::Distributions::TruncatedNormal< F >::draw_from ( Kokkos::Random_XorShift1024< DeviceType > & gen,
F mu,
F sigma,
F lower,
F upper )
inlinestatic
Here is the call graph for this function:
Here is the caller graph for this function:

◆ mean()

template<FloatingPointType F>
KOKKOS_INLINE_FUNCTION F MC::Distributions::TruncatedNormal< F >::mean ( ) const
inline
Here is the call graph for this function:

◆ skewness()

template<FloatingPointType F>
KOKKOS_INLINE_FUNCTION F MC::Distributions::TruncatedNormal< F >::skewness ( ) const
inline

◆ var()

template<FloatingPointType F>
KOKKOS_INLINE_FUNCTION F MC::Distributions::TruncatedNormal< F >::var ( ) const
inline
Here is the call graph for this function:

Member Data Documentation

◆ lower

◆ mu

◆ sigma

◆ upper


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