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

#include <ROL_RaisedCosine.hpp>

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

Public Member Functions

 RaisedCosine (const Real mean=0.5, const Real var=0.5)
 
 RaisedCosine (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

size_t factorial (const size_t m) const
 

Private Attributes

Real mean_
 
Real var_
 

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

Definition at line 53 of file ROL_RaisedCosine.hpp.

Constructor & Destructor Documentation

◆ RaisedCosine() [1/2]

template<class Real >
ROL::RaisedCosine< Real >::RaisedCosine ( const Real  mean = 0.5,
const Real  var = 0.5 
)
inline

Definition at line 63 of file ROL_RaisedCosine.hpp.

◆ RaisedCosine() [2/2]

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

Member Function Documentation

◆ factorial()

template<class Real >
size_t ROL::RaisedCosine< Real >::factorial ( const size_t  m) const
inlineprivate

◆ evaluatePDF()

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

◆ evaluateCDF()

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

◆ integrateCDF()

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

◆ invertCDF()

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

◆ moment()

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

◆ lowerBound()

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

◆ upperBound()

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

◆ test()

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

Member Data Documentation

◆ mean_

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

◆ var_

template<class Real >
Real ROL::RaisedCosine< Real >::var_
private

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