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

#include <ROL_TruncatedExponential.hpp>

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

Public Member Functions

 TruncatedExponential (const Real a=0., const Real b=1., const Real scale=1.)
 
 TruncatedExponential (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 a_
 
Real b_
 
Real scale_
 
Real expa_
 
Real expb_
 
Real diff_
 
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::TruncatedExponential< Real >

Definition at line 53 of file ROL_TruncatedExponential.hpp.

Constructor & Destructor Documentation

◆ TruncatedExponential() [1/2]

template<class Real >
ROL::TruncatedExponential< Real >::TruncatedExponential ( const Real  a = 0.,
const Real  b = 1.,
const Real  scale = 1. 
)
inline

◆ TruncatedExponential() [2/2]

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

Member Function Documentation

◆ compute_coeff()

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

◆ evaluatePDF()

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

◆ evaluateCDF()

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

◆ integrateCDF()

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

◆ invertCDF()

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

◆ moment()

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

◆ lowerBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 126 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_.

◆ upperBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 130 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::b_.

◆ test()

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

Member Data Documentation

◆ a_

template<class Real >
Real ROL::TruncatedExponential< Real >::a_
private

◆ b_

template<class Real >
Real ROL::TruncatedExponential< Real >::b_
private

◆ scale_

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

◆ expa_

template<class Real >
Real ROL::TruncatedExponential< Real >::expa_
private

◆ expb_

template<class Real >
Real ROL::TruncatedExponential< Real >::expb_
private

◆ diff_

template<class Real >
Real ROL::TruncatedExponential< Real >::diff_
private

◆ coeff_

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

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