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

#include <ROL_Gamma.hpp>

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

Public Member Functions

 Gamma (const Real shape=1., const Real scale=1.)
 
 Gamma (ROL::ParameterList &parlist)
 
Real evaluatePDF (const Real input) const
 
Real evaluateCDF (const Real input) const
 
Real integrateCDF (const Real input) const
 
Real invertCDF (const Real input) const
 
Real moment (const size_t m) const
 
Real lowerBound (void) const
 
Real upperBound (void) const
 
void test (std::ostream &outStream=std::cout) const
 
- Public Member Functions inherited from ROL::Distribution< Real >
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
 

Private Member Functions

Real igamma (const Real s, const Real x) const
 

Private Attributes

Real shape_
 
Real scale_
 
Real gamma_shape_
 
Real coeff_
 

Additional Inherited Members

- Protected Member Functions inherited from ROL::Distribution< Real >
void test (const std::vector< Real > &X, const std::vector< int > &T, std::ostream &outStream=std::cout) const
 

Detailed Description

template<class Real>
class ROL::Gamma< Real >

Definition at line 55 of file ROL_Gamma.hpp.

Constructor & Destructor Documentation

◆ Gamma() [1/2]

template<class Real >
ROL::Gamma< Real >::Gamma ( const Real  shape = 1.,
const Real  scale = 1. 
)
inline

◆ Gamma() [2/2]

template<class Real >
ROL::Gamma< Real >::Gamma ( ROL::ParameterList &  parlist)
inline

Member Function Documentation

◆ igamma()

template<class Real >
Real ROL::Gamma< Real >::igamma ( const Real  s,
const Real  x 
) const
inlineprivate

◆ evaluatePDF()

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

◆ evaluateCDF()

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

◆ integrateCDF()

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

◆ invertCDF()

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

◆ moment()

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

◆ lowerBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 136 of file ROL_Gamma.hpp.

◆ upperBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 140 of file ROL_Gamma.hpp.

◆ test()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 144 of file ROL_Gamma.hpp.

References ROL::Distribution< Real >::test().

Member Data Documentation

◆ shape_

template<class Real >
Real ROL::Gamma< Real >::shape_
private

◆ scale_

template<class Real >
Real ROL::Gamma< Real >::scale_
private

◆ gamma_shape_

template<class Real >
Real ROL::Gamma< Real >::gamma_shape_
private

◆ coeff_

template<class Real >
Real ROL::Gamma< Real >::coeff_
private

Definition at line 60 of file ROL_Gamma.hpp.

Referenced by ROL::Gamma< Real >::evaluatePDF(), and ROL::Gamma< Real >::Gamma().


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