ROL
ROL::PlusFunction< Real > Class Template Reference

#include <ROL_PlusFunction.hpp>

Inheritance diagram for ROL::PlusFunction< Real >:

Public Member Functions

 PlusFunction (ROL::Ptr< Distribution< Real > > &dist, Real param=1.)
 PlusFunction (ROL::ParameterList &parlist)
Real evaluate (Real input, int deriv)
void test (Real x)
Public Member Functions inherited from ROL::PositiveFunction< Real >
virtual ~PositiveFunction ()

Private Attributes

ROL::Ptr< Distribution< Real > > dist_
Real param_

Detailed Description

template<class Real>
class ROL::PlusFunction< Real >

Definition at line 21 of file ROL_PlusFunction.hpp.

Constructor & Destructor Documentation

◆ PlusFunction() [1/2]

template<class Real>
ROL::PlusFunction< Real >::PlusFunction ( ROL::Ptr< Distribution< Real > > & dist,
Real param = 1. )
inline

Definition at line 27 of file ROL_PlusFunction.hpp.

References dist_, and param_.

◆ PlusFunction() [2/2]

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

Definition at line 31 of file ROL_PlusFunction.hpp.

References dist_, ROL::DistributionFactory(), param_, and zero.

Member Function Documentation

◆ evaluate()

template<class Real>
Real ROL::PlusFunction< Real >::evaluate ( Real input,
int deriv )
inlinevirtual

Implements ROL::PositiveFunction< Real >.

Definition at line 46 of file ROL_PlusFunction.hpp.

References dist_, and param_.

Referenced by test().

◆ test()

template<class Real>
void ROL::PlusFunction< Real >::test ( Real x)
inline

Definition at line 56 of file ROL_PlusFunction.hpp.

References evaluate().

Member Data Documentation

◆ dist_

template<class Real>
ROL::Ptr<Distribution<Real> > ROL::PlusFunction< Real >::dist_
private

Definition at line 23 of file ROL_PlusFunction.hpp.

Referenced by evaluate(), PlusFunction(), and PlusFunction().

◆ param_

template<class Real>
Real ROL::PlusFunction< Real >::param_
private

Definition at line 24 of file ROL_PlusFunction.hpp.

Referenced by evaluate(), PlusFunction(), and PlusFunction().


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