BoostDistribution< T > Class Template Reference

A class used to as a base for distributions defined by Boost. More...

#include <BoostDistribution.h>

Inheritance diagram for BoostDistribution< T >:

Public Member Functions
	BoostDistribution (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

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

Detailed Description

template<typename T = Real>
class BoostDistribution< T >

A class used to as a base for distributions defined by Boost.

The default type is set to Real to allow for derived classes to compile without Boost and trigger the mooseError in the constructor.

Definition at line 48 of file BoostDistribution.h.

Constructor & Destructor Documentation

BoostDistribution()

template<typename T >

BoostDistribution< T >::BoostDistribution

(

const InputParameters &

parameters

)

Definition at line 64 of file BoostDistribution.h.

  : Distribution(parameters)
{
#ifndef LIBMESH_HAVE_EXTERNAL_BOOST
  mooseError("The ",
             getParam<std::string>("type"),
             " distribution named '",
             name(),
             "' requires that libMesh be compiled with an external Boost library, this may be done "
             "using the --with-boost configure option.");
#endif
}

Member Function Documentation

cdf()

template<typename T >

Real BoostDistribution< T >::cdf ( const Real &  x ) const

overridevirtual

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()

template<typename T >

Real BoostDistribution< T >::median ( ) const

overridevirtual

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()

template<typename T >

Real BoostDistribution< T >::pdf ( const Real &  x ) const

overridevirtual

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()

template<typename T >

Real BoostDistribution< T >::quantile ( const Real &  y ) const

overridevirtual

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
}

Member Data Documentation

_distribution_unique_ptr

template<typename T = Real>

std::unique_ptr<T> BoostDistribution< T >::_distribution_unique_ptr

protected

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 file:

• stochastic_tools/include/distributions/BoostDistribution.h