QUESO::GenericScalarCovarianceFunction< V, M > Class Template Reference

A class for generic covariances. More...

#include <GenericScalarCovarianceFunction.h>

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

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

Public Member Functions
Constructor/Destructor methods
	GenericScalarCovarianceFunction (const char *prefix, const VectorSet< V, M > &domainSet, double(*covRoutinePtr)(const V &positionVector1, const V &positionVector2, const void *routineDataPtr), const void *routinesDataPtr)
	Default constructor. More...
virtual	~GenericScalarCovarianceFunction ()
	Virtual destructor. More...
Public Member Functions inherited from QUESO::BaseScalarCovarianceFunction< V, M >
	BaseScalarCovarianceFunction (const char *prefix, const VectorSet< V, M > &basicDomainSet)
	Default constructor. More...
virtual	~BaseScalarCovarianceFunction ()
	Virtual destructor. More...
const VectorSet< V, M > &	basicDomainSet () const
	Domain set; access to private attribute m_basicDomainSet. More...

Math methods
double(*	m_covRoutinePtr )(const V &positionVector1, const V &positionVector2, const void *routineDataPtr)
const void *	m_routineDataPtr
double	value (const V &positionVector1, const V &positionVector2) const
	Calculates the value of the generic covariance function. More...

Additional Inherited Members
Protected Attributes inherited from QUESO::BaseScalarCovarianceFunction< V, M >
const BaseEnvironment &	m_env
std::string	m_prefix
const VectorSet< V, M > &	m_basicDomainSet

Detailed Description

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

A class for generic covariances.

This class implements a generic covariance functions, by calling a routine (via pointer).

Definition at line 48 of file GenericScalarCovarianceFunction.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::GenericScalarCovarianceFunction< V, M >::GenericScalarCovarianceFunction	(	const char *	prefix,
		const VectorSet< V, M > &	domainSet,
		double(*)(const V &positionVector1, const V &positionVector2, const void *routineDataPtr)	covRoutinePtr,
		const void *	routinesDataPtr
	)

Default constructor.

Instantiates an object of the class given a prefix, the domain set, the pointer to the routine.

Definition at line 31 of file GenericScalarCovarianceFunction.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseScalarCovarianceFunction< V, M >::m_env, QUESO::BaseScalarCovarianceFunction< V, M >::m_prefix, and QUESO::BaseEnvironment::subDisplayFile().

  :
  BaseScalarCovarianceFunction<V,M>(prefix,domainSet),
  m_covRoutinePtr                         (covRoutinePtr),
  m_routineDataPtr                        (routinesDataPtr)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Entering GenericScalarCovarianceFunction<V,M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Leaving GenericScalarCovarianceFunction<V,M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }
}

template<class V , class M >

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

virtual

Virtual destructor.

Definition at line 55 of file GenericScalarCovarianceFunction.C.

{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Entering GenericScalarCovarianceFunction<V,M>::destructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Leaving GenericScalarCovarianceFunction<V,M>::destructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }
}

Member Function Documentation

template<class V , class M >

double QUESO::GenericScalarCovarianceFunction< V, M >::value ( const V &  positionVector1, const V &  positionVector2  ) const

virtual

Calculates the value of the generic covariance function.

This function accesses the routine that calculates the covariance function.

Implements QUESO::BaseScalarCovarianceFunction< V, M >.

Definition at line 72 of file GenericScalarCovarianceFunction.C.

References queso_require_msg.

{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Entering GenericScalarCovarianceFunction<V,M>::value()"
                            << std::endl;
  }

  queso_require_msg(m_covRoutinePtr, "m_covRoutinePtr = NULL");

  double result = m_covRoutinePtr(positionVector1, positionVector2, m_routineDataPtr);

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Leaving GenericScalarCovarianceFunction<V,M>::value()"
                            << std::endl;
  }

  return result;
}

Member Data Documentation

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

double(* QUESO::GenericScalarCovarianceFunction< V, M >::m_covRoutinePtr)(const V &positionVector1, const V &positionVector2, const void *routineDataPtr)

protected

Definition at line 73 of file GenericScalarCovarianceFunction.h.

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

const void* QUESO::GenericScalarCovarianceFunction< V, M >::m_routineDataPtr

protected

Definition at line 74 of file GenericScalarCovarianceFunction.h.

---

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

• src/stats/inc/GenericScalarCovarianceFunction.h
• src/stats/src/GenericScalarCovarianceFunction.C