UniformDistribution Class Reference

A class used to generate uniform distribution. More...

#include <UniformDistribution.h>

Inheritance diagram for UniformDistribution:

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

Static Public Member Functions
static InputParameters	validParams ()
static Real	pdf (const Real &x, const Real &lower_bound, const Real &upper_bound)
static Real	cdf (const Real &x, const Real &lower_bound, const Real &upper_bound)
static Real	quantile (const Real &y, const Real &lower_bound, const Real &upper_bound)

Protected Attributes
const Real &	_lower_bound
	The lower bound for the uniform distribution. More...
const Real &	_upper_bound
	The upper bound for the uniform distribution. More...

Detailed Description

A class used to generate uniform distribution.

Definition at line 21 of file UniformDistribution.h.

Constructor & Destructor Documentation

UniformDistribution()

UniformDistribution::UniformDistribution

(

const InputParameters &

parameters

)

Definition at line 26 of file UniformDistribution.C.

  : Distribution(parameters),
    _lower_bound(getParam<Real>("lower_bound")),
    _upper_bound(getParam<Real>("upper_bound"))
{
  if (_lower_bound >= _upper_bound)
    mooseError("The lower bound is larger than the upper bound!");
}

Member Function Documentation

cdf() [1/2]

Real UniformDistribution::cdf ( const Real &  x ) const

overridevirtual

Definition at line 72 of file UniformDistribution.C.

{
  TIME_SECTION(_perf_cdf);
  return cdf(x, _lower_bound, _upper_bound);
}

cdf() [2/2]

Real UniformDistribution::cdf ( const Real &  x, const Real &  lower_bound, const Real &  upper_bound  )

static

Definition at line 45 of file UniformDistribution.C.

{
  if (x < lower_bound)
    return 0.0;
  else if (x > upper_bound)
    return 1.0;
  else
    return (x - lower_bound) / (upper_bound - lower_bound);
}

Referenced by cdf().

pdf() [1/2]

Real UniformDistribution::pdf ( const Real &  x ) const

overridevirtual

Definition at line 65 of file UniformDistribution.C.

{
  TIME_SECTION(_perf_pdf);
  return pdf(x, _lower_bound, _upper_bound);
}

pdf() [2/2]

Real UniformDistribution::pdf ( const Real &  x, const Real &  lower_bound, const Real &  upper_bound  )

static

Definition at line 36 of file UniformDistribution.C.

{
  if (x < lower_bound || x > upper_bound)
    return 0.0;
  else
    return 1.0 / (upper_bound - lower_bound);
}

Referenced by pdf().

quantile() [1/2]

Real UniformDistribution::quantile ( const Real &  y ) const

overridevirtual

Definition at line 79 of file UniformDistribution.C.

{
  TIME_SECTION(_perf_quantile);
  return quantile(y, _lower_bound, _upper_bound);
}

quantile() [2/2]

Real UniformDistribution::quantile ( const Real &  y, const Real &  lower_bound, const Real &  upper_bound  )

static

Definition at line 56 of file UniformDistribution.C.

{
  if (y < 0 || y > 1)
    ::mooseError("The cdf_value provided is out of range 0 to 1.");
  else
    return y * (upper_bound - lower_bound) + lower_bound;
}

Referenced by quantile().

validParams()

InputParameters UniformDistribution::validParams ( )

static

Definition at line 17 of file UniformDistribution.C.

{
  InputParameters params = Distribution::validParams();
  params.addClassDescription("Continuous uniform distribution.");
  params.addParam<Real>("lower_bound", 0.0, "Distribution lower bound");
  params.addParam<Real>("upper_bound", 1.0, "Distribution upper bound");
  return params;
}

Member Data Documentation

_lower_bound

const Real& UniformDistribution::_lower_bound

protected

The lower bound for the uniform distribution.

Definition at line 38 of file UniformDistribution.h.

Referenced by cdf(), pdf(), quantile(), and UniformDistribution().

_upper_bound

const Real& UniformDistribution::_upper_bound

protected

The upper bound for the uniform distribution.

Definition at line 41 of file UniformDistribution.h.

Referenced by cdf(), pdf(), quantile(), and UniformDistribution().

---

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

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