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 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

Definition at line 75 of file ROL_TruncatedExponential.hpp.

References a_, b_, coeff_, diff_, expa_, expb_, and scale_.

◆ TruncatedExponential() [2/2]

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

Definition at line 83 of file ROL_TruncatedExponential.hpp.

References a_, b_, coeff_, diff_, expa_, expb_, and scale_.

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

Definition at line 63 of file ROL_TruncatedExponential.hpp.

Referenced by moment().

◆ evaluatePDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 99 of file ROL_TruncatedExponential.hpp.

References a_, b_, coeff_, and scale_.

◆ evaluateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 103 of file ROL_TruncatedExponential.hpp.

References a_, b_, diff_, expa_, and scale_.

◆ integrateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 107 of file ROL_TruncatedExponential.hpp.

References a_, b_, diff_, expa_, expb_, and scale_.

◆ invertCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 113 of file ROL_TruncatedExponential.hpp.

References a_, b_, diff_, expa_, and scale_.

◆ moment()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 117 of file ROL_TruncatedExponential.hpp.

References a_, b_, coeff_, compute_coeff(), expa_, expb_, and scale_.

◆ 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 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 b_.

◆ test()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 134 of file ROL_TruncatedExponential.hpp.

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

Member Data Documentation

◆ a_

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

Definition at line 55 of file ROL_TruncatedExponential.hpp.

Referenced by evaluateCDF(), evaluatePDF(), integrateCDF(), invertCDF(), lowerBound(), moment(), test(), TruncatedExponential(), and TruncatedExponential().

◆ b_

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

Definition at line 56 of file ROL_TruncatedExponential.hpp.

Referenced by evaluateCDF(), evaluatePDF(), integrateCDF(), invertCDF(), moment(), test(), TruncatedExponential(), TruncatedExponential(), and upperBound().

◆ scale_

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

Definition at line 57 of file ROL_TruncatedExponential.hpp.

Referenced by evaluateCDF(), evaluatePDF(), integrateCDF(), invertCDF(), moment(), TruncatedExponential(), and TruncatedExponential().

◆ expa_

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

Definition at line 58 of file ROL_TruncatedExponential.hpp.

Referenced by evaluateCDF(), integrateCDF(), invertCDF(), moment(), TruncatedExponential(), and TruncatedExponential().

◆ expb_

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

Definition at line 59 of file ROL_TruncatedExponential.hpp.

Referenced by integrateCDF(), moment(), TruncatedExponential(), and TruncatedExponential().

◆ diff_

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

Definition at line 60 of file ROL_TruncatedExponential.hpp.

Referenced by evaluateCDF(), integrateCDF(), invertCDF(), TruncatedExponential(), and TruncatedExponential().

◆ coeff_

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

Definition at line 61 of file ROL_TruncatedExponential.hpp.

Referenced by evaluatePDF(), moment(), TruncatedExponential(), and TruncatedExponential().

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