ROL
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
ROL::Distribution< Real > Class Template Reference

#include <ROL_Distribution.hpp>

+ Inheritance diagram for ROL::Distribution< Real >:

Public Member Functions

virtual ~Distribution (void)
 
virtual Real evaluatePDF (const Real input) const
 
virtual Real evaluateCDF (const Real input) const
 
virtual Real integrateCDF (const Real input) const
 
virtual Real invertCDF (const Real input) const
 
virtual Real moment (const size_t m) const
 
virtual Real lowerBound (void) const
 
virtual Real upperBound (void) const
 
virtual void test (std::ostream &outStream=std::cout) const
 

Protected Member Functions

void test (const std::vector< Real > &X, const std::vector< int > &T, std::ostream &outStream=std::cout) const
 

Private Member Functions

void test_onesided (const Real x, std::ostream &outStream=std::cout) const
 
void test_centered (const Real x, std::ostream &outStream=std::cout) const
 
void test_moment (const size_t order, std::ostream &outStream=std::cout) const
 

Detailed Description

template<class Real>
class ROL::Distribution< Real >

Definition at line 55 of file ROL_Distribution.hpp.

Constructor & Destructor Documentation

◆ ~Distribution()

template<class Real>
virtual ROL::Distribution< Real >::~Distribution ( void )
inlinevirtual

Definition at line 57 of file ROL_Distribution.hpp.

Member Function Documentation

◆ evaluatePDF()

template<class Real>
virtual Real ROL::Distribution< Real >::evaluatePDF ( const Real input) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 59 of file ROL_Distribution.hpp.

Referenced by test_centered(), and test_onesided().

◆ evaluateCDF()

template<class Real>
virtual Real ROL::Distribution< Real >::evaluateCDF ( const Real input) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 64 of file ROL_Distribution.hpp.

Referenced by test_centered(), and test_onesided().

◆ integrateCDF()

template<class Real>
virtual Real ROL::Distribution< Real >::integrateCDF ( const Real input) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 69 of file ROL_Distribution.hpp.

Referenced by test_centered(), and test_onesided().

◆ invertCDF()

template<class Real>
virtual Real ROL::Distribution< Real >::invertCDF ( const Real input) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 74 of file ROL_Distribution.hpp.

Referenced by test_centered(), test_moment(), and test_onesided().

◆ moment()

template<class Real>
virtual Real ROL::Distribution< Real >::moment ( const size_t m) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 79 of file ROL_Distribution.hpp.

Referenced by test_moment().

◆ lowerBound()

template<class Real>
virtual Real ROL::Distribution< Real >::lowerBound ( void ) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 84 of file ROL_Distribution.hpp.

◆ upperBound()

template<class Real>
virtual Real ROL::Distribution< Real >::upperBound ( void ) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 89 of file ROL_Distribution.hpp.

◆ test() [1/2]

template<class Real>
virtual void ROL::Distribution< Real >::test ( std::ostream & outStream = std::cout) const
inlinevirtual

Reimplemented in ROL::Arcsine< Real >, ROL::Beta< Real >, ROL::Cauchy< Real >, ROL::Dirac< Real >, ROL::Exponential< Real >, ROL::Gamma< Real >, ROL::Gaussian< Real >, ROL::Gumbel< Real >, ROL::Kumaraswamy< Real >, ROL::Laplace< Real >, ROL::Logistic< Real >, ROL::Parabolic< Real >, ROL::RaisedCosine< Real >, ROL::Smale< Real >, ROL::Triangle< Real >, ROL::TruncatedExponential< Real >, ROL::TruncatedGaussian< Real >, and ROL::Uniform< Real >.

Definition at line 94 of file ROL_Distribution.hpp.

Referenced by ROL::Arcsine< Real >::test(), ROL::Beta< Real >::test(), ROL::Cauchy< Real >::test(), ROL::Dirac< Real >::test(), ROL::Exponential< Real >::test(), ROL::Gamma< Real >::test(), ROL::Gaussian< Real >::test(), ROL::Gumbel< Real >::test(), ROL::Kumaraswamy< Real >::test(), ROL::Laplace< Real >::test(), ROL::Logistic< Real >::test(), ROL::Parabolic< Real >::test(), ROL::RaisedCosine< Real >::test(), ROL::Smale< Real >::test(), ROL::Triangle< Real >::test(), ROL::TruncatedExponential< Real >::test(), ROL::TruncatedGaussian< Real >::test(), and ROL::Uniform< Real >::test().

◆ test() [2/2]

template<class Real>
void ROL::Distribution< Real >::test ( const std::vector< Real > & X,
const std::vector< int > & T,
std::ostream & outStream = std::cout ) const
inlineprotected

Definition at line 100 of file ROL_Distribution.hpp.

References test_centered(), test_moment(), and test_onesided().

◆ test_onesided()

template<class Real>
void ROL::Distribution< Real >::test_onesided ( const Real x,
std::ostream & outStream = std::cout ) const
inlineprivate

Definition at line 116 of file ROL_Distribution.hpp.

References evaluateCDF(), evaluatePDF(), integrateCDF(), and invertCDF().

Referenced by test().

◆ test_centered()

template<class Real>
void ROL::Distribution< Real >::test_centered ( const Real x,
std::ostream & outStream = std::cout ) const
inlineprivate

Definition at line 209 of file ROL_Distribution.hpp.

References evaluateCDF(), evaluatePDF(), integrateCDF(), and invertCDF().

Referenced by test().

◆ test_moment()

template<class Real>
void ROL::Distribution< Real >::test_moment ( const size_t order,
std::ostream & outStream = std::cout ) const
inlineprivate

Definition at line 304 of file ROL_Distribution.hpp.

References invertCDF(), and moment().

Referenced by test().

The documentation for this class was generated from the following file:
Generated by doxygen 1.13.2