A templated (base) class for handling scalar functions. More...

#include <ScalarFunction.h>

Inheritance diagram for QUESO::BaseScalarFunction< V, M >:

Collaboration diagram for QUESO::BaseScalarFunction< V, M >:

Public Member Functions
Constructor/Destructor methods.
	BaseScalarFunction (const char *prefix, const VectorSet< V, M > &domainSet)
	Default constructor. More...

virtual	~BaseScalarFunction ()
	Destructor. More...

Mathematical methods.
const VectorSet< V, M > &	domainSet () const
	Access to the protected attribute `m_domainSet:` domain set of the scalar function. More...

virtual double	actualValue (const V &domainVector, const V domainDirection, V gradVector, M hessianMatrix, V hessianEffect) const =0
	Actual value of the scalar function. More...

virtual double	lnValue (const V &domainVector, const V domainDirection, V gradVector, M hessianMatrix, V hessianEffect) const =0
	Logarithm of the value of the scalar function. More...

Protected Attributes
const BaseEnvironment &	m_env

std::string	m_prefix

const VectorSet< V, M > &	m_domainSet
	Domain set of the scalar function. More...

Detailed Description

template<class V = GslVector, class M = GslMatrix>
class QUESO::BaseScalarFunction< V, M >

A templated (base) class for handling scalar functions.

This class allows the mathematical definition of a scalar function such as: $f: B \subset R \rightarrow R$ . A function of one or more variables has always one-dimensional range. PDFs (marginal, joint) and CDFs are examples of scalar functions.

Definition at line 51 of file ScalarFunction.h.

Constructor & Destructor Documentation

template<class V, class M>

QUESO::BaseScalarFunction< V, M >::BaseScalarFunction	(	const char *	prefix,
		const VectorSet< V, M > &	domainSet
	)

Default constructor.

Instantiates an object of the class, i.e. a scalar function, given a prefix and its domain.

Definition at line 34 of file ScalarFunction.C.

   : m_env(domainSet.env()),
     m_prefix((std::string)(prefix) + "func_"),
     m_domainSet(domainSet)
 {
 }

template<class V , class M >

QUESO::BaseScalarFunction< V, M >::~BaseScalarFunction ( )

virtual

Destructor.

Definition at line 44 of file ScalarFunction.C.

45 {

46 }

Member Function Documentation

template<class V = GslVector, class M = GslMatrix>

virtual double QUESO::BaseScalarFunction< V, M >::actualValue	(	const V &	domainVector,
		const V *	domainDirection,
		V *	gradVector,
		M *	hessianMatrix,
		V *	hessianEffect
	)		const

pure virtual

Actual value of the scalar function.

template<class V , class M >

const VectorSet< V, M > & QUESO::BaseScalarFunction< V, M >::domainSet ( ) const

Access to the protected attribute m_domainSet: domain set of the scalar function.

Definition at line 50 of file ScalarFunction.C.

Referenced by QUESO::StatisticalInverseProblem< P_V, P_M >::StatisticalInverseProblem().

 {
   return m_domainSet;
 }

template<class V = GslVector, class M = GslMatrix>

virtual double QUESO::BaseScalarFunction< V, M >::lnValue	(	const V &	domainVector,
		const V *	domainDirection,
		V *	gradVector,
		M *	hessianMatrix,
		V *	hessianEffect
	)		const

pure virtual

Logarithm of the value of the scalar function.

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>

const VectorSet<V, M>& QUESO::BaseScalarFunction< V, M >::m_domainSet

protected

Domain set of the scalar function.

Definition at line 84 of file ScalarFunction.h.

template<class V = GslVector, class M = GslMatrix>

const BaseEnvironment& QUESO::BaseScalarFunction< V, M >::m_env

protected

Definition at line 80 of file ScalarFunction.h.

Referenced by QUESO::BaseJointPdf< V, M >::BaseJointPdf(), QUESO::BetaJointPdf< V, M >::BetaJointPdf(), QUESO::GammaJointPdf< V, M >::GammaJointPdf(), QUESO::GaussianJointPdf< V, M >::GaussianJointPdf(), QUESO::InverseGammaJointPdf< V, M >::InverseGammaJointPdf(), QUESO::JeffreysJointPdf< V, M >::JeffreysJointPdf(), QUESO::LogNormalJointPdf< V, M >::LogNormalJointPdf(), QUESO::PoweredJointPdf< V, M >::PoweredJointPdf(), QUESO::UniformJointPdf< V, M >::UniformJointPdf(), and QUESO::WignerJointPdf< V, M >::WignerJointPdf().

template<class V = GslVector, class M = GslMatrix>

std::string QUESO::BaseScalarFunction< V, M >::m_prefix

protected

Definition at line 81 of file ScalarFunction.h.

Referenced by QUESO::BaseJointPdf< V, M >::BaseJointPdf(), QUESO::BetaJointPdf< V, M >::BetaJointPdf(), QUESO::GammaJointPdf< V, M >::GammaJointPdf(), QUESO::GaussianJointPdf< V, M >::GaussianJointPdf(), QUESO::InverseGammaJointPdf< V, M >::InverseGammaJointPdf(), QUESO::JeffreysJointPdf< V, M >::JeffreysJointPdf(), QUESO::LogNormalJointPdf< V, M >::LogNormalJointPdf(), QUESO::PoweredJointPdf< V, M >::PoweredJointPdf(), QUESO::UniformJointPdf< V, M >::UniformJointPdf(), and QUESO::WignerJointPdf< V, M >::WignerJointPdf().

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

src/basic/inc/ScalarFunction.h
src/basic/src/ScalarFunction.C

Public Member Functions

Protected Attributes

Detailed Description

template<class V = GslVector, class M = GslMatrix> class QUESO::BaseScalarFunction< V, M >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class V = GslVector, class M = GslMatrix>
class QUESO::BaseScalarFunction< V, M >