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

#include <ROL_Cauchy.hpp>

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

Public Member Functions

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

Definition at line 53 of file ROL_Cauchy.hpp.

Constructor & Destructor Documentation

◆ Cauchy() [1/2]

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

Definition at line 59 of file ROL_Cauchy.hpp.

◆ Cauchy() [2/2]

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

Definition at line 62 of file ROL_Cauchy.hpp.

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

Member Function Documentation

◆ evaluatePDF()

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

◆ evaluateCDF()

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

◆ integrateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 76 of file ROL_Cauchy.hpp.

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

◆ invertCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 81 of file ROL_Cauchy.hpp.

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

◆ moment()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 85 of file ROL_Cauchy.hpp.

◆ lowerBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 90 of file ROL_Cauchy.hpp.

◆ upperBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 94 of file ROL_Cauchy.hpp.

◆ test()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 98 of file ROL_Cauchy.hpp.

References ROL::Distribution< Real >::test().

Member Data Documentation

◆ loc_

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

◆ scale_

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

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