WeibullDistribution Class Reference

A class used to generate a three-parameter Weibull distribution. More...

#include <WeibullDistribution.h>

Inheritance diagram for WeibullDistribution:

Public Member Functions
	WeibullDistribution (const InputParameters &parameters)
virtual Real	pdf (const Real &x) const override
virtual Real	cdf (const Real &x) const override
virtual Real	quantile (const Real &p) const override

Static Public Member Functions
static InputParameters	validParams ()
static Real	pdf (const Real &x, const Real &location, const Real &scale, const Real &shape)
static Real	cdf (const Real &x, const Real &location, const Real &scale, const Real &shape)
static Real	quantile (const Real &p, const Real &location, const Real &scale, const Real &shape)

Protected Attributes
const Real &	_a
	The location parameter (a or low) More...
const Real &	_b
	The scale parameter (b or lambda) More...
const Real &	_c
	The shape parameter (c or k) More...

Detailed Description

A class used to generate a three-parameter Weibull distribution.

Definition at line 22 of file WeibullDistribution.h.

Constructor & Destructor Documentation

WeibullDistribution()

WeibullDistribution::WeibullDistribution

(

const InputParameters &

parameters

)

Definition at line 29 of file WeibullDistribution.C.

  : Distribution(parameters),
    _a(getParam<Real>("location")),
    _b(getParam<Real>("scale")),
    _c(getParam<Real>("shape"))
{
}

Member Function Documentation

cdf() [1/2]

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

overridevirtual

Definition at line 84 of file WeibullDistribution.C.

{
  TIME_SECTION(_perf_cdf);
  return cdf(x, _a, _b, _c);
}

cdf() [2/2]

Real WeibullDistribution::cdf ( const Real &  x, const Real &  location, const Real &  scale, const Real &  shape  )

static

Definition at line 53 of file WeibullDistribution.C.

{
  if (x <= location)
    return 0.0;
  else
  {
    const Real y = (x - location) / scale;
    return 1.0 - std::exp(-std::pow(y, shape));
  }
}

pdf() [1/2]

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

overridevirtual

Definition at line 77 of file WeibullDistribution.C.

{
  TIME_SECTION(_perf_pdf);
  return pdf(x, _a, _b, _c);
}

pdf() [2/2]

Real WeibullDistribution::pdf ( const Real &  x, const Real &  location, const Real &  scale, const Real &  shape  )

static

Definition at line 38 of file WeibullDistribution.C.

{
  if (x <= location)
    return 0.0;
  else
  {
    const Real y = (x - location) / scale;
    return shape / scale * std::pow(y, shape - 1.0) * std::exp(-std::pow(y, shape));
  }
}

quantile() [1/2]

Real WeibullDistribution::quantile ( const Real &  p ) const

overridevirtual

Definition at line 91 of file WeibullDistribution.C.

{
  TIME_SECTION(_perf_quantile);
  return quantile(p, _a, _b, _c);
}

quantile() [2/2]

Real WeibullDistribution::quantile ( const Real &  p, const Real &  location, const Real &  scale, const Real &  shape  )

static

Definition at line 68 of file WeibullDistribution.C.

{
  return location + scale * std::pow(-std::log(1 - p), 1.0 / shape);
}

validParams()

InputParameters WeibullDistribution::validParams ( )

static

Definition at line 19 of file WeibullDistribution.C.

{
  InputParameters params = Distribution::validParams();
  params.addClassDescription("Three-parameter Weibull distribution.");
  params.addRequiredParam<Real>("location", "Location parameter (a or low)");
  params.addRequiredRangeCheckedParam<Real>("scale", "scale > 0", "Scale parameter (b or lambda)");
  params.addRequiredRangeCheckedParam<Real>("shape", "shape > 0", "Shape parameter (c or k)");
  return params;
}

Member Data Documentation

_a

const Real& WeibullDistribution::_a

protected

The location parameter (a or low)

Definition at line 40 of file WeibullDistribution.h.

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

_b

const Real& WeibullDistribution::_b

protected

The scale parameter (b or lambda)

Definition at line 43 of file WeibullDistribution.h.

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

_c

const Real& WeibullDistribution::_c

protected

The shape parameter (c or k)

Definition at line 46 of file WeibullDistribution.h.

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

---

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

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