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

#include <ROL_TruncatedGaussian.hpp>

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

Public Member Functions

 TruncatedGaussian (const Real lo=-1., const Real up=1., const Real mean=0., const Real sdev=1.)
 
 TruncatedGaussian (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 a_
 
Real b_
 
Real mean_
 
Real sdev_
 
ROL::Ptr< Gaussian< Real > > gauss_
 
Real alpha_
 
Real beta_
 
Real phi_
 
Real Z_
 

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::TruncatedGaussian< Real >

Definition at line 55 of file ROL_TruncatedGaussian.hpp.

Constructor & Destructor Documentation

◆ TruncatedGaussian() [1/2]

template<class Real >
ROL::TruncatedGaussian< Real >::TruncatedGaussian ( const Real lo = -1.,
const Real up = 1.,
const Real mean = 0.,
const Real sdev = 1. )
inline

Definition at line 71 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::a_, ROL::TruncatedGaussian< Real >::alpha_, ROL::TruncatedGaussian< Real >::b_, ROL::TruncatedGaussian< Real >::beta_, ROL::TruncatedGaussian< Real >::gauss_, ROL::TruncatedGaussian< Real >::mean_, ROL::TruncatedGaussian< Real >::phi_, ROL::TruncatedGaussian< Real >::sdev_, and ROL::TruncatedGaussian< Real >::Z_.

◆ TruncatedGaussian() [2/2]

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

Definition at line 83 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::a_, ROL::TruncatedGaussian< Real >::alpha_, ROL::TruncatedGaussian< Real >::b_, ROL::TruncatedGaussian< Real >::beta_, ROL::TruncatedGaussian< Real >::gauss_, ROL::TruncatedGaussian< Real >::mean_, ROL::TruncatedGaussian< Real >::phi_, ROL::TruncatedGaussian< Real >::sdev_, ROL::TruncatedGaussian< Real >::Z_, and zero.

Member Function Documentation

◆ evaluatePDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 105 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::a_, ROL::TruncatedGaussian< Real >::b_, ROL::TruncatedGaussian< Real >::gauss_, ROL::TruncatedGaussian< Real >::mean_, ROL::TruncatedGaussian< Real >::sdev_, ROL::TruncatedGaussian< Real >::Z_, and zero.

◆ evaluateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 111 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::a_, ROL::TruncatedGaussian< Real >::b_, ROL::TruncatedGaussian< Real >::gauss_, ROL::TruncatedGaussian< Real >::mean_, ROL::TruncatedGaussian< Real >::phi_, ROL::TruncatedGaussian< Real >::sdev_, ROL::TruncatedGaussian< Real >::Z_, and zero.

◆ integrateCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 117 of file ROL_TruncatedGaussian.hpp.

◆ invertCDF()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 123 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::gauss_, ROL::TruncatedGaussian< Real >::mean_, ROL::TruncatedGaussian< Real >::phi_, ROL::TruncatedGaussian< Real >::sdev_, and ROL::TruncatedGaussian< Real >::Z_.

◆ moment()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 128 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::alpha_, ROL::TruncatedGaussian< Real >::beta_, ROL::TruncatedGaussian< Real >::gauss_, ROL::TruncatedGaussian< Real >::mean_, ROL::TruncatedGaussian< Real >::sdev_, and ROL::TruncatedGaussian< Real >::Z_.

◆ lowerBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 145 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::a_.

◆ upperBound()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 149 of file ROL_TruncatedGaussian.hpp.

References ROL::TruncatedGaussian< Real >::b_.

◆ test()

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

Reimplemented from ROL::Distribution< Real >.

Definition at line 153 of file ROL_TruncatedGaussian.hpp.

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

Member Data Documentation

◆ a_

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

Definition at line 57 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::evaluatePDF(), ROL::TruncatedGaussian< Real >::lowerBound(), ROL::TruncatedGaussian< Real >::test(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ b_

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

Definition at line 58 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::evaluatePDF(), ROL::TruncatedGaussian< Real >::test(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::upperBound().

◆ mean_

template<class Real >
Real ROL::TruncatedGaussian< Real >::mean_
private

Definition at line 59 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::evaluatePDF(), ROL::TruncatedGaussian< Real >::invertCDF(), ROL::TruncatedGaussian< Real >::moment(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ sdev_

template<class Real >
Real ROL::TruncatedGaussian< Real >::sdev_
private

Definition at line 60 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::evaluatePDF(), ROL::TruncatedGaussian< Real >::invertCDF(), ROL::TruncatedGaussian< Real >::moment(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ gauss_

template<class Real >
ROL::Ptr<Gaussian<Real> > ROL::TruncatedGaussian< Real >::gauss_
private

Definition at line 62 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::evaluatePDF(), ROL::TruncatedGaussian< Real >::invertCDF(), ROL::TruncatedGaussian< Real >::moment(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ alpha_

template<class Real >
Real ROL::TruncatedGaussian< Real >::alpha_
private

Definition at line 64 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::moment(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ beta_

template<class Real >
Real ROL::TruncatedGaussian< Real >::beta_
private

Definition at line 65 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::moment(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ phi_

template<class Real >
Real ROL::TruncatedGaussian< Real >::phi_
private

Definition at line 66 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::invertCDF(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

◆ Z_

template<class Real >
Real ROL::TruncatedGaussian< Real >::Z_
private

Definition at line 67 of file ROL_TruncatedGaussian.hpp.

Referenced by ROL::TruncatedGaussian< Real >::evaluateCDF(), ROL::TruncatedGaussian< Real >::evaluatePDF(), ROL::TruncatedGaussian< Real >::invertCDF(), ROL::TruncatedGaussian< Real >::moment(), ROL::TruncatedGaussian< Real >::TruncatedGaussian(), and ROL::TruncatedGaussian< Real >::TruncatedGaussian().

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