www.mooseframework.org
Distribution.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "MooseObject.h"
13 #include "PerfGraphInterface.h"
14 
19 {
20 public:
22 
27  virtual Real pdf(const Real & x) const = 0;
28 
32  virtual Real cdf(const Real & x) const = 0;
33 
37  virtual Real quantile(const Real & y) const = 0;
38 
42  virtual Real median() const;
43 };
virtual Real pdf(const Real &x) const =0
Compute the probability with given probability distribution function (PDF) at x.
virtual Real median() const
Compute the median of the distribution.
Definition: Distribution.C:29
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
All Distributions should inherit from this class.
Definition: Distribution.h:18
Distribution(const InputParameters &parameters)
Definition: Distribution.C:23
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:33
virtual Real cdf(const Real &x) const =0
Compute the cumulative probability with given cumulative probability distribution (CDF) at x...
Interface for objects interacting with the PerfGraph.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static InputParameters validParams()
Definition: Distribution.C:14
const InputParameters & parameters() const
Get the parameters of the object.
virtual Real quantile(const Real &y) const =0
Compute the inverse CDF (quantile function) value for given variable value y.