BoostLognormalDistribution Class Reference

A class used to generate Lognormal distribution via Boost. More...

#include <BoostLognormalDistribution.h>

Inheritance diagram for BoostLognormalDistribution:

Public Member Functions
	BoostLognormalDistribution (const InputParameters &parameters)
virtual Real	pdf (const Real &x) const override
virtual Real	cdf (const Real &x) const override
virtual Real	quantile (const Real &y) const override
virtual Real	median () const override

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
std::unique_ptr< boost::math::lognormal_distribution< Real > >	_distribution_unique_ptr
	This must be defined by the child class in the constructor. More...

Detailed Description

A class used to generate Lognormal distribution via Boost.

Definition at line 22 of file BoostLognormalDistribution.h.

Constructor & Destructor Documentation

BoostLognormalDistribution()

BoostLognormalDistribution::BoostLognormalDistribution

(

const InputParameters &

parameters

)

Definition at line 28 of file BoostLognormalDistribution.C.

  : BoostDistribution<boost::math::lognormal_distribution<Real>>(parameters)
{
  _distribution_unique_ptr = libmesh_make_unique<boost::math::lognormal_distribution<Real>>(
      getParam<Real>("location"), getParam<Real>("scale"));
}

Member Function Documentation

cdf()

Real BoostDistribution< boost::math::lognormal_distribution< Real > >::cdf ( const Real &  x ) const

overridevirtualinherited

Definition at line 92 of file BoostDistribution.h.

{
#ifdef LIBMESH_HAVE_EXTERNAL_BOOST
  mooseAssert(_distribution_unique_ptr, "Boost distribution pointer not defined.");
  TIME_SECTION(_perf_cdf);
  return boost::math::cdf(*_distribution_unique_ptr, x);
#else
  return x; // unreachable
#endif
}

median()

Real BoostDistribution< boost::math::lognormal_distribution< Real > >::median ( ) const

overridevirtualinherited

Definition at line 118 of file BoostDistribution.h.

{
#ifdef LIBMESH_HAVE_EXTERNAL_BOOST
  mooseAssert(_distribution_unique_ptr, "Boost distribution pointer not defined.");
  TIME_SECTION(_perf_median);
  return boost::math::median(*_distribution_unique_ptr);
#else
  return 0; // unreachable
#endif
}

pdf()

Real BoostDistribution< boost::math::lognormal_distribution< Real > >::pdf ( const Real &  x ) const

overridevirtualinherited

Definition at line 79 of file BoostDistribution.h.

{
#ifdef LIBMESH_HAVE_EXTERNAL_BOOST
  mooseAssert(_distribution_unique_ptr, "Boost distribution pointer not defined.");
  TIME_SECTION(_perf_pdf);
  return boost::math::pdf(*_distribution_unique_ptr, x);
#else
  return x; // unreachable
#endif
}

quantile()

Real BoostDistribution< boost::math::lognormal_distribution< Real > >::quantile ( const Real &  y ) const

overridevirtualinherited

Definition at line 105 of file BoostDistribution.h.

{
#ifdef LIBMESH_HAVE_EXTERNAL_BOOST
  mooseAssert(_distribution_unique_ptr, "Boost distribution pointer not defined.");
  TIME_SECTION(_perf_quantile);
  return boost::math::quantile(*_distribution_unique_ptr, y);
#else
  return y; // unreachable
#endif
}

validParams()

InputParameters BoostLognormalDistribution::validParams ( )

static

Definition at line 19 of file BoostLognormalDistribution.C.

{
  InputParameters params = Distribution::validParams();
  params.addClassDescription("Boost Lognormal distribution.");
  params.addRequiredParam<Real>("location", "The Lognormal location parameter.");
  params.addRequiredParam<Real>("scale", "The Lognormal scale parameter.");
  return params;
}

Member Data Documentation

_distribution_unique_ptr

std::unique_ptr<boost::math::lognormal_distribution< Real > > BoostDistribution< boost::math::lognormal_distribution< Real > >::_distribution_unique_ptr

protectedinherited

This must be defined by the child class in the constructor.

Definition at line 60 of file BoostDistribution.h.

---

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

• stochastic_tools/include/distributions/BoostLognormalDistribution.h
• stochastic_tools/src/distributions/BoostLognormalDistribution.C