ippl::random::NormalDistribution< T, Dim > Class Template Reference

#include <NormalDistribution.h>

Inheritance diagram for ippl::random::NormalDistribution< T, Dim >:

Collaboration diagram for ippl::random::NormalDistribution< T, Dim >:

Public Member Functions
KOKKOS_INLINE_FUNCTION	NormalDistribution (const T *par_p)
	Constructor for the Normal Distribution class. The constructor takes an array of parameters of normal distribution, i.e. mean and standard deviation.
KOKKOS_INLINE_FUNCTION T	getPdf (T x, unsigned int d) const
	A wrapper to change the signature arguments of pdf in each dimension d from (x, d, par) to (x, d).
KOKKOS_INLINE_FUNCTION T	getCdf (T x, unsigned int d) const
	A wrapper to change the signature arguments of cdf in each dimension d from (x, d, par) to (x, d).
KOKKOS_INLINE_FUNCTION T	getEstimate (T x, unsigned int d) const
	A wrapper to change the signature arguments of estimate in each dimension d from (x, d, par) to (x, d).
KOKKOS_INLINE_FUNCTION T	getObjFunc (T x, unsigned int d, T u) const
KOKKOS_INLINE_FUNCTION T	getDerObjFunc (T x, unsigned int d) const
KOKKOS_INLINE_FUNCTION T	getFullPdf (ippl::Vector< T, Dim > x) const

Public Attributes
T	par_m [DimP]
NormalDistributionFunctions< T >::PDF	pdf_m
NormalDistributionFunctions< T >::CDF	cdf_m
NormalDistributionFunctions< T >::Estimate	estimate_m

Detailed Description

template<typename T, unsigned Dim>
class ippl::random::NormalDistribution< T, Dim >

Definition at line 149 of file NormalDistribution.h.

Constructor & Destructor Documentation

NormalDistribution()

template<typename T, unsigned Dim>

KOKKOS_INLINE_FUNCTION ippl::random::NormalDistribution< T, Dim >::NormalDistribution ( const T * par_p )

inline

Constructor for the Normal Distribution class. The constructor takes an array of parameters of normal distribution, i.e. mean and standard deviation.

Definition at line 157 of file NormalDistribution.h.

References Dim, and ippl::random::Distribution< T, Dim, 2 *Dim, NormalDistributionFunctions< T > >::Distribution().

Here is the call graph for this function:

Member Function Documentation

getCdf()

KOKKOS_INLINE_FUNCTION T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::getCdf ( T x, unsigned int d ) const

inlineinherited

A wrapper to change the signature arguments of cdf in each dimension d from (x, d, par) to (x, d).

Definition at line 75 of file Distribution.h.

getDerObjFunc()

KOKKOS_INLINE_FUNCTION T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::getDerObjFunc ( T x, unsigned int d ) const

inlineinherited

Returns

Derivative of the objective function that is used in inverse transform sampling, i.e. d(obj)/dx = pdf(x)

Definition at line 100 of file Distribution.h.

getEstimate()

KOKKOS_INLINE_FUNCTION T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::getEstimate ( T x, unsigned int d ) const

inlineinherited

A wrapper to change the signature arguments of estimate in each dimension d from (x, d, par) to (x, d).

Definition at line 83 of file Distribution.h.

getFullPdf()

KOKKOS_INLINE_FUNCTION T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::getFullPdf ( ippl::Vector< T, Dim > x ) const

inlineinherited

Returns

Total pdf given uncorrelated pdf in each dimension. i.e. total_pdf = pdf(x_1) * pdf(x_2) * ... pdf(x_N).

Definition at line 108 of file Distribution.h.

getObjFunc()

KOKKOS_INLINE_FUNCTION T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::getObjFunc ( T x, unsigned int d, T u ) const

inlineinherited

Returns

Objective function that is used in inverse transform sampling, i.e. obj = cdf(x)-u. Here u is uniformly distributed on [0, 1] and x is the sample of target distribution.

Definition at line 92 of file Distribution.h.

getPdf()

KOKKOS_INLINE_FUNCTION T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::getPdf ( T x, unsigned int d ) const

inlineinherited

A wrapper to change the signature arguments of pdf in each dimension d from (x, d, par) to (x, d).

Definition at line 67 of file Distribution.h.

Member Data Documentation

cdf_m

NormalDistributionFunctions< T >::CDF ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::cdf_m

inherited

Definition at line 44 of file Distribution.h.

estimate_m

NormalDistributionFunctions< T >::Estimate ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::estimate_m

inherited

Definition at line 45 of file Distribution.h.

par_m

T ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::par_m[DimP]

inherited

Parameters

par_m	An array of distribution parameters.
pdf_m	PDF of the distribution class as a member functor.
cdf_m	CDF of the distribution class as a member functor.
estimate_m	Estimate of the initial guess for the sampling method as a member functor.

Definition at line 42 of file Distribution.h.

pdf_m

NormalDistributionFunctions< T >::PDF ippl::random::Distribution< T, Dim, DimP, NormalDistributionFunctions< T > >::pdf_m

inherited

Definition at line 43 of file Distribution.h.

---

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

• NormalDistribution.h