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

#include <ROL_KLDivergence.hpp>

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

Public Member Functions

 KLDivergence (const Real eps=1.e-2)
 
 KLDivergence (Teuchos::ParameterList &parlist)
 
void reset (Teuchos::RCP< Vector< Real > > &x0, const Vector< Real > &x)
 
void reset (Teuchos::RCP< Vector< Real > > &x0, const Vector< Real > &x, Teuchos::RCP< Vector< Real > > &v0, const Vector< Real > &v)
 
void update (const Real val, const Real weight)
 
void update (const Real val, const Vector< Real > &g, const Real weight)
 
void update (const Real val, const Vector< Real > &g, const Real gv, const Vector< Real > &hv, const Real weight)
 
Real getValue (SampleGenerator< Real > &sampler)
 
void getGradient (Vector< Real > &g, SampleGenerator< Real > &sampler)
 
void getHessVec (Vector< Real > &hv, SampleGenerator< Real > &sampler)
 
- Public Member Functions inherited from ROL::RiskMeasure< Real >
virtual ~RiskMeasure ()
 
 RiskMeasure (void)
 

Private Attributes

Real eps_
 
Real gval_
 
Real gvval_
 
Real hval_
 
Teuchos::RCP< Vector< Real > > scaledGradient_
 
Teuchos::RCP< Vector< Real > > scaledHessVec_
 
Teuchos::RCP< Vector< Real > > dualVector1_
 
Teuchos::RCP< Vector< Real > > dualVector2_
 
Real xstat_
 
Real vstat_
 
bool firstReset_
 

Additional Inherited Members

- Protected Attributes inherited from ROL::RiskMeasure< Real >
Real val_
 
Real gv_
 
Teuchos::RCP< Vector< Real > > g_
 
Teuchos::RCP< Vector< Real > > hv_
 
Teuchos::RCP< Vector< Real > > dualVector_
 
bool firstReset_
 

Detailed Description

template<class Real>
class ROL::KLDivergence< Real >

Definition at line 52 of file ROL_KLDivergence.hpp.

Constructor & Destructor Documentation

template<class Real >
ROL::KLDivergence< Real >::KLDivergence ( const Real  eps = 1.e-2)
inline

Definition at line 70 of file ROL_KLDivergence.hpp.

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

Definition at line 73 of file ROL_KLDivergence.hpp.

Member Function Documentation

template<class Real >
void ROL::KLDivergence< Real >::reset ( Teuchos::RCP< Vector< Real > > &  x0,
const Vector< Real > &  x 
)
inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 81 of file ROL_KLDivergence.hpp.

References ROL::RiskMeasure< Real >::reset().

Referenced by ROL::KLDivergence< Real >::reset().

template<class Real >
void ROL::KLDivergence< Real >::reset ( Teuchos::RCP< Vector< Real > > &  x0,
const Vector< Real > &  x,
Teuchos::RCP< Vector< Real > > &  v0,
const Vector< Real > &  v 
)
inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 96 of file ROL_KLDivergence.hpp.

References ROL::KLDivergence< Real >::reset().

template<class Real >
void ROL::KLDivergence< Real >::update ( const Real  val,
const Real  weight 
)
inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 103 of file ROL_KLDivergence.hpp.

template<class Real >
void ROL::KLDivergence< Real >::update ( const Real  val,
const Vector< Real > &  g,
const Real  weight 
)
inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 107 of file ROL_KLDivergence.hpp.

template<class Real >
void ROL::KLDivergence< Real >::update ( const Real  val,
const Vector< Real > &  g,
const Real  gv,
const Vector< Real > &  hv,
const Real  weight 
)
inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 114 of file ROL_KLDivergence.hpp.

template<class Real >
Real ROL::KLDivergence< Real >::getValue ( SampleGenerator< Real > &  sampler)
inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 128 of file ROL_KLDivergence.hpp.

References ROL::SampleGenerator< Real >::sumAll().

template<class Real >
void ROL::KLDivergence< Real >::getGradient ( Vector< Real > &  g,
SampleGenerator< Real > &  sampler 
)
inlinevirtual
template<class Real >
void ROL::KLDivergence< Real >::getHessVec ( Vector< Real > &  hv,
SampleGenerator< Real > &  sampler 
)
inlinevirtual

Member Data Documentation

template<class Real >
Real ROL::KLDivergence< Real >::eps_
private

Definition at line 54 of file ROL_KLDivergence.hpp.

template<class Real >
Real ROL::KLDivergence< Real >::gval_
private
template<class Real >
Real ROL::KLDivergence< Real >::gvval_
private

Definition at line 57 of file ROL_KLDivergence.hpp.

Referenced by ROL::KLDivergence< Real >::getHessVec().

template<class Real >
Real ROL::KLDivergence< Real >::hval_
private

Definition at line 58 of file ROL_KLDivergence.hpp.

Referenced by ROL::KLDivergence< Real >::getHessVec().

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::KLDivergence< Real >::scaledGradient_
private

Definition at line 59 of file ROL_KLDivergence.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::KLDivergence< Real >::scaledHessVec_
private

Definition at line 60 of file ROL_KLDivergence.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::KLDivergence< Real >::dualVector1_
private

Definition at line 61 of file ROL_KLDivergence.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::KLDivergence< Real >::dualVector2_
private

Definition at line 62 of file ROL_KLDivergence.hpp.

template<class Real >
Real ROL::KLDivergence< Real >::xstat_
private

Definition at line 64 of file ROL_KLDivergence.hpp.

Referenced by ROL::KLDivergence< Real >::getGradient().

template<class Real >
Real ROL::KLDivergence< Real >::vstat_
private

Definition at line 65 of file ROL_KLDivergence.hpp.

template<class Real >
bool ROL::KLDivergence< Real >::firstReset_
private

Definition at line 67 of file ROL_KLDivergence.hpp.


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