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

#include <ROL_Exponential.hpp>

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

Public Member Functions

 Exponential (const Real loc=0., const Real scale=1.)
 
 Exponential (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

size_t compute_coeff (const size_t m, const size_t k) const
 

Private Attributes

Real loc_
 
Real scale_
 

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::Exponential< Real >

Definition at line 53 of file ROL_Exponential.hpp.

Constructor & Destructor Documentation

◆ Exponential() [1/2]

template<class Real >
ROL::Exponential< Real >::Exponential ( const Real  loc = 0.,
const Real  scale = 1. 
)
inline

Definition at line 70 of file ROL_Exponential.hpp.

◆ Exponential() [2/2]

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

Member Function Documentation

◆ compute_coeff()

template<class Real >
size_t ROL::Exponential< Real >::compute_coeff ( const size_t  m,
const size_t  k 
) const
inlineprivate

Definition at line 58 of file ROL_Exponential.hpp.

Referenced by ROL::Exponential< Real >::moment().

◆ evaluatePDF()

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

◆ evaluateCDF()

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

◆ integrateCDF()

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

◆ invertCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 92 of file ROL_Exponential.hpp.

References ROL::Exponential< Real >::scale_.

◆ moment()

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

◆ lowerBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 105 of file ROL_Exponential.hpp.

◆ upperBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 109 of file ROL_Exponential.hpp.

◆ test()

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

Member Data Documentation

◆ loc_

template<class Real >
Real ROL::Exponential< Real >::loc_
private

◆ scale_

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

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