A class used to generate a Student's t distribution. More...

#include <StudentT.h>

Inheritance diagram for StudentT:

Public Types
typedef DataFileName	DataFileParameterType

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

virtual Real	median () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static Real	pdf (const Real &x, const unsigned int &dof)

static Real	cdf (const Real &x, const unsigned int &dof)

static Real	quantile (const Real &p, const unsigned int &dof)

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Protected Attributes
const unsigned int &	_dof
	Degrees of freedom.

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

A class used to generate a Student's t distribution.

Definition at line 17 of file StudentT.h.

Constructor & Destructor Documentation

◆ StudentT()

StudentT::StudentT ( const InputParameters & parameters )

Definition at line 24 of file StudentT.C.

  : Distribution(parameters), _dof(getParam<unsigned int>("dof"))
{
}

Member Function Documentation

◆ cdf() [1/2]

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

overridevirtual

Implements Distribution.

Definition at line 60 of file StudentT.C.

{
  return cdf(x, _dof);
}

Referenced by cdf().

◆ cdf() [2/2]

Real StudentT::cdf	(	const Real &	x,
		const unsigned int &	dof
	)

static

Definition at line 38 of file StudentT.C.

{
  Real v = dof;
  Real z = Beta::incompleteBeta(v / 2.0, 0.5, v / (v + x * x)) / 2.0;
  return x > 0 ? 1.0 - z : z;
}

◆ pdf() [1/2]

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

overridevirtual

Implements Distribution.

Definition at line 54 of file StudentT.C.

{
  return pdf(x, _dof);
}

Referenced by pdf().

◆ pdf() [2/2]

Real StudentT::pdf	(	const Real &	x,
		const unsigned int &	dof
	)

static

Definition at line 30 of file StudentT.C.

{
  Real v = dof;
  return std::pow((v / (v + x * x)), (1.0 + v) / 2.0) /
         (std::sqrt(v) * Beta::betaFunction(v / 2.0, 0.5));
}

◆ quantile() [1/2]

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

overridevirtual

Implements Distribution.

Definition at line 66 of file StudentT.C.

{
  return quantile(p, _dof);
}

Referenced by quantile().

◆ quantile() [2/2]

Real StudentT::quantile	(	const Real &	p,
		const unsigned int &	dof
	)

static

Definition at line 46 of file StudentT.C.

{
  Real v = dof;
  Real x = Beta::incompleteBetaInv(v / 2.0, 0.5, 2.0 * (p <= 0.5 ? p : 1.0 - p));
  return (p <= 0.5 ? -1.0 : 1.0) * std::sqrt(v * (1 - x) / x);
}

◆ validParams()

InputParameters StudentT::validParams ( )

static

Definition at line 16 of file StudentT.C.

{
  InputParameters params = Distribution::validParams();
  params.addClassDescription("Student t-distribution");
  params.addRequiredRangeCheckedParam<unsigned int>("dof", "dof > 0", "Degrees of freedom.");
  return params;
}

Member Data Documentation

◆ _dof

const unsigned int& StudentT::_dof

protected

Degrees of freedom.

Definition at line 34 of file StudentT.h.

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

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

stochastic_tools/include/distributions/StudentT.h
stochastic_tools/src/distributions/StudentT.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StudentT()

Member Function Documentation

◆ cdf() [1/2]

◆ cdf() [2/2]

◆ pdf() [1/2]

◆ pdf() [2/2]

◆ quantile() [1/2]

◆ quantile() [2/2]

◆ validParams()

Member Data Documentation

◆ _dof