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)

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

References loc_, and scale_.

Exponential() [2/2]

template<class Real>

ROL::Exponential< Real >::Exponential ( ROL::ParameterList & parlist )

inline

Definition at line 39 of file ROL_Exponential.hpp.

References loc_, and scale_.

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 24 of file ROL_Exponential.hpp.

Referenced by moment().

evaluatePDF()

template<class Real>

Real ROL::Exponential< Real >::evaluatePDF ( const Real input ) const

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 45 of file ROL_Exponential.hpp.

References loc_, and scale_.

evaluateCDF()

template<class Real>

Real ROL::Exponential< Real >::evaluateCDF ( const Real input ) const

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 49 of file ROL_Exponential.hpp.

References loc_, and scale_.

integrateCDF()

template<class Real>

Real ROL::Exponential< Real >::integrateCDF ( const Real input ) const

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 53 of file ROL_Exponential.hpp.

References loc_, and scale_.

invertCDF()

template<class Real>

Real ROL::Exponential< Real >::invertCDF ( const Real input ) const

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 58 of file ROL_Exponential.hpp.

References scale_.

moment()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 62 of file ROL_Exponential.hpp.

References compute_coeff(), loc_, and scale_.

lowerBound()

template<class Real>

Real ROL::Exponential< Real >::lowerBound ( void ) const

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 71 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 75 of file ROL_Exponential.hpp.

References ROL::ROL_INF().

test()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 79 of file ROL_Exponential.hpp.

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

Member Data Documentation

loc_

template<class Real>

Real ROL::Exponential< Real >::loc_

private

Definition at line 21 of file ROL_Exponential.hpp.

Referenced by evaluateCDF(), evaluatePDF(), Exponential(), Exponential(), integrateCDF(), moment(), and test().

scale_

template<class Real>

Real ROL::Exponential< Real >::scale_

private

Definition at line 22 of file ROL_Exponential.hpp.

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

---

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

• ROL_Exponential.hpp