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

#include <ROL_Gumbel.hpp>

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

Public Member Functions

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

void checkInputs (const Real loc, const Real scale) 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::Gumbel< Real >

Definition at line 53 of file ROL_Gumbel.hpp.

Constructor & Destructor Documentation

◆ Gumbel() [1/2]

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

◆ Gumbel() [2/2]

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

Member Function Documentation

◆ checkInputs()

template<class Real >
void ROL::Gumbel< Real >::checkInputs ( const Real  loc,
const Real  scale 
) const
inlineprivate

Definition at line 58 of file ROL_Gumbel.hpp.

Referenced by ROL::Gumbel< Real >::Gumbel().

◆ evaluatePDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 76 of file ROL_Gumbel.hpp.

References ROL::Gumbel< Real >::loc_, and ROL::Gumbel< Real >::scale_.

◆ evaluateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 81 of file ROL_Gumbel.hpp.

References ROL::Gumbel< Real >::loc_, and ROL::Gumbel< Real >::scale_.

◆ integrateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 86 of file ROL_Gumbel.hpp.

◆ invertCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 91 of file ROL_Gumbel.hpp.

References ROL::Gumbel< Real >::loc_, and ROL::Gumbel< Real >::scale_.

◆ moment()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 95 of file ROL_Gumbel.hpp.

References ROL::Gumbel< Real >::loc_, and ROL::Gumbel< Real >::scale_.

◆ lowerBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 110 of file ROL_Gumbel.hpp.

◆ upperBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 114 of file ROL_Gumbel.hpp.

◆ test()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 118 of file ROL_Gumbel.hpp.

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

Member Data Documentation

◆ loc_

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

◆ scale_

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

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