LogisticDistribution Class Reference

A class used to generate a logistic distribution. More...

#include <LogisticDistribution.h>

Inheritance diagram for LogisticDistribution:

Public Member Functions
	LogisticDistribution (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 &shape)
static Real	cdf (const Real &x, const Real &location, const Real &shape)
static Real	quantile (const Real &p, const Real &location, const Real &shape)

Protected Attributes
const Real &	_location
	The location or mean of the distribution (alpha or mu) More...
const Real &	_shape
	The shape of the distribution (beta or s) More...

Detailed Description

A class used to generate a logistic distribution.

Definition at line 22 of file LogisticDistribution.h.

Constructor & Destructor Documentation

LogisticDistribution()

LogisticDistribution::LogisticDistribution

(

const InputParameters &

parameters

)

Definition at line 28 of file LogisticDistribution.C.

  : Distribution(parameters), _location(getParam<Real>("location")), _shape(getParam<Real>("shape"))
{
}

Member Function Documentation

cdf() [1/2]

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

overridevirtual

Definition at line 61 of file LogisticDistribution.C.

{
  TIME_SECTION(_perf_cdf);
  return cdf(x, _location, _shape);
}

cdf() [2/2]

Real LogisticDistribution::cdf ( const Real &  x, const Real &  location, const Real &  shape  )

static

Definition at line 41 of file LogisticDistribution.C.

{
  Real z = std::exp(-(x - location) / shape);
  return 1.0 / (1.0 + z);
}

pdf() [1/2]

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

overridevirtual

Definition at line 54 of file LogisticDistribution.C.

{
  TIME_SECTION(_perf_pdf);
  return pdf(x, _location, _shape);
}

pdf() [2/2]

Real LogisticDistribution::pdf ( const Real &  x, const Real &  location, const Real &  shape  )

static

Definition at line 34 of file LogisticDistribution.C.

{
  Real z = std::exp(-(x - location) / shape);
  return z / (shape * Utility::pow<2>(1.0 + z));
}

quantile() [1/2]

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

overridevirtual

Definition at line 68 of file LogisticDistribution.C.

{
  TIME_SECTION(_perf_quantile);
  return quantile(p, _location, _shape);
}

quantile() [2/2]

Real LogisticDistribution::quantile ( const Real &  p, const Real &  location, const Real &  shape  )

static

Definition at line 48 of file LogisticDistribution.C.

{
  return location - shape * std::log(1.0 / p - 1.0);
}

validParams()

InputParameters LogisticDistribution::validParams ( )

static

Definition at line 19 of file LogisticDistribution.C.

{
  InputParameters params = Distribution::validParams();
  params.addClassDescription("Logistic distribution.");
  params.addRequiredParam<Real>("location", "Location or mean of the distribution (alpha or mu)");
  params.addRequiredParam<Real>("shape", "Shape of the distribution (beta or s)");
  return params;
}

Member Data Documentation

_location

const Real& LogisticDistribution::_location

protected

The location or mean of the distribution (alpha or mu)

Definition at line 39 of file LogisticDistribution.h.

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

_shape

const Real& LogisticDistribution::_shape

protected

The shape of the distribution (beta or s)

Definition at line 42 of file LogisticDistribution.h.

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

---

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

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