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)
 
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 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

◆ TruncatedGaussian() [2/2]

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

Member Function Documentation

◆ evaluatePDF()

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

◆ evaluateCDF()

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

◆ 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

◆ moment()

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

◆ 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

Member Data Documentation

◆ a_

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

◆ b_

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

◆ mean_

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

◆ sdev_

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

◆ gauss_

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

◆ alpha_

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

◆ beta_

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

◆ phi_

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

◆ Z_

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

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