ROL: ROL::Cauchy< Real > Class Template Reference

ROL

#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 19 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 25 of file ROL_Cauchy.hpp.

References loc_, and scale_.

◆ Cauchy() [2/2]

template<class Real>

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

inline

Definition at line 28 of file ROL_Cauchy.hpp.

References loc_, and scale_.

Member Function Documentation

◆ evaluatePDF()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 34 of file ROL_Cauchy.hpp.

References loc_, ROL::ROL::ScalarTraits< Real >::pi(), and scale_.

◆ evaluateCDF()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 38 of file ROL_Cauchy.hpp.

References loc_, ROL::ROL::ScalarTraits< Real >::pi(), and scale_.

◆ integrateCDF()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 42 of file ROL_Cauchy.hpp.

References loc_, ROL::ROL::ScalarTraits< Real >::pi(), and scale_.

◆ invertCDF()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 47 of file ROL_Cauchy.hpp.

References loc_, ROL::ROL::ScalarTraits< Real >::pi(), and scale_.

◆ moment()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 51 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 56 of file ROL_Cauchy.hpp.

References ROL::ROL_NINF().

◆ upperBound()

template<class Real>

Real ROL::Cauchy< Real >::upperBound ( void ) const

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 60 of file ROL_Cauchy.hpp.

References ROL::ROL_INF().

◆ test()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Distribution< Real >.

Definition at line 64 of file ROL_Cauchy.hpp.

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

Member Data Documentation

◆ loc_

template<class Real>

Real ROL::Cauchy< Real >::loc_

private

Definition at line 21 of file ROL_Cauchy.hpp.

Referenced by Cauchy(), Cauchy(), evaluateCDF(), evaluatePDF(), integrateCDF(), and invertCDF().

◆ scale_

template<class Real>

Real ROL::Cauchy< Real >::scale_

private

Definition at line 22 of file ROL_Cauchy.hpp.

Referenced by Cauchy(), Cauchy(), evaluateCDF(), evaluatePDF(), integrateCDF(), and invertCDF().

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

ROL_Cauchy.hpp