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)
 

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 19 of file ROL_TruncatedExponential.hpp.

Constructor & Destructor Documentation

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

Definition at line 41 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::coeff_, ROL::TruncatedExponential< Real >::diff_, ROL::TruncatedExponential< Real >::expa_, ROL::TruncatedExponential< Real >::expb_, and ROL::TruncatedExponential< Real >::scale_.

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

Definition at line 49 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::coeff_, ROL::TruncatedExponential< Real >::diff_, ROL::TruncatedExponential< Real >::expa_, ROL::TruncatedExponential< Real >::expb_, and ROL::TruncatedExponential< Real >::scale_.

Member Function Documentation

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

Definition at line 29 of file ROL_TruncatedExponential.hpp.

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

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 65 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::coeff_, and ROL::TruncatedExponential< Real >::scale_.

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 69 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::diff_, ROL::TruncatedExponential< Real >::expa_, and ROL::TruncatedExponential< Real >::scale_.

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 73 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::diff_, ROL::TruncatedExponential< Real >::expa_, ROL::TruncatedExponential< Real >::expb_, and ROL::TruncatedExponential< Real >::scale_.

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 79 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::diff_, ROL::TruncatedExponential< Real >::expa_, and ROL::TruncatedExponential< Real >::scale_.

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 83 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, ROL::TruncatedExponential< Real >::coeff_, ROL::TruncatedExponential< Real >::compute_coeff(), ROL::TruncatedExponential< Real >::expa_, ROL::TruncatedExponential< Real >::expb_, and ROL::TruncatedExponential< Real >::scale_.

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 92 of file ROL_TruncatedExponential.hpp.

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

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 96 of file ROL_TruncatedExponential.hpp.

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

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 100 of file ROL_TruncatedExponential.hpp.

References ROL::TruncatedExponential< Real >::a_, ROL::TruncatedExponential< Real >::b_, and ROL::Distribution< Real >::test().

Member Data Documentation

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

Definition at line 21 of file ROL_TruncatedExponential.hpp.

Referenced by ROL::TruncatedExponential< Real >::evaluateCDF(), ROL::TruncatedExponential< Real >::evaluatePDF(), ROL::TruncatedExponential< Real >::integrateCDF(), ROL::TruncatedExponential< Real >::invertCDF(), ROL::TruncatedExponential< Real >::lowerBound(), ROL::TruncatedExponential< Real >::moment(), ROL::TruncatedExponential< Real >::test(), and ROL::TruncatedExponential< Real >::TruncatedExponential().

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

Definition at line 22 of file ROL_TruncatedExponential.hpp.

Referenced by ROL::TruncatedExponential< Real >::evaluateCDF(), ROL::TruncatedExponential< Real >::evaluatePDF(), ROL::TruncatedExponential< Real >::integrateCDF(), ROL::TruncatedExponential< Real >::invertCDF(), ROL::TruncatedExponential< Real >::moment(), ROL::TruncatedExponential< Real >::test(), ROL::TruncatedExponential< Real >::TruncatedExponential(), and ROL::TruncatedExponential< Real >::upperBound().

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

Definition at line 23 of file ROL_TruncatedExponential.hpp.

Referenced by ROL::TruncatedExponential< Real >::evaluateCDF(), ROL::TruncatedExponential< Real >::evaluatePDF(), ROL::TruncatedExponential< Real >::integrateCDF(), ROL::TruncatedExponential< Real >::invertCDF(), ROL::TruncatedExponential< Real >::moment(), and ROL::TruncatedExponential< Real >::TruncatedExponential().

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

Definition at line 24 of file ROL_TruncatedExponential.hpp.

Referenced by ROL::TruncatedExponential< Real >::evaluateCDF(), ROL::TruncatedExponential< Real >::integrateCDF(), ROL::TruncatedExponential< Real >::invertCDF(), ROL::TruncatedExponential< Real >::moment(), and ROL::TruncatedExponential< Real >::TruncatedExponential().

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

Definition at line 25 of file ROL_TruncatedExponential.hpp.

Referenced by ROL::TruncatedExponential< Real >::integrateCDF(), ROL::TruncatedExponential< Real >::moment(), and ROL::TruncatedExponential< Real >::TruncatedExponential().

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

Definition at line 26 of file ROL_TruncatedExponential.hpp.

Referenced by ROL::TruncatedExponential< Real >::evaluateCDF(), ROL::TruncatedExponential< Real >::integrateCDF(), ROL::TruncatedExponential< Real >::invertCDF(), and ROL::TruncatedExponential< Real >::TruncatedExponential().

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

Definition at line 27 of file ROL_TruncatedExponential.hpp.

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

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