QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M > Class Template Reference

A class for generic covariance matrices. More...

#include <GenericMatrixCovarianceFunction.h>

Inheritance diagram for QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >:

Public Member Functions
Constructor/Destructor methods
	GenericMatrixCovarianceFunction (const char *prefix, const VectorSet< P_V, P_M > &basicDomainSet, const VectorSet< Q_V, Q_M > &imageSet, void(*covRoutinePtr)(const P_V &positionVector1, const P_V &positionVector2, const void *routineDataPtr, Q_M &imageMatrix), const void *routinesDataPtr)
	Default constructor. More...
virtual	~GenericMatrixCovarianceFunction ()
	Virtual destructor. More...
Public Member Functions inherited from QUESO::BaseMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >
	BaseMatrixCovarianceFunction (const char *prefix, const VectorSet< P_V, P_M > &basicDomainSet, const VectorSet< Q_V, Q_M > &imageSet)
	Default constructor. More...
virtual	~BaseMatrixCovarianceFunction ()
	Virtual destructor. More...
const VectorSet< P_V, P_M > &	basicDomainSet () const
	Domain set; access to private attribute m_basicDomainSet. More...

Math methods
void(*	m_covRoutinePtr )(const P_V &positionVector1, const P_V &positionVector2, const void *routineDataPtr, Q_M &imageMatrix)
const void *	m_routineDataPtr
void	covMatrix (const P_V &positionVector1, const P_V &positionVector2, Q_M &imageMatrix) const
	Calculates the value of the generic covariance matrix. More...

Additional Inherited Members
Protected Attributes inherited from QUESO::BaseMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >
const BaseEnvironment &	m_env
std::string	m_prefix
const VectorSet< P_V, P_M > &	m_basicDomainSet
const VectorSet< Q_V, Q_M > &	m_imageSet

Detailed Description

template<class P_V = GslVector, class P_M = GslMatrix, class Q_V = GslVector, class Q_M = GslMatrix>
class QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >

A class for generic covariance matrices.

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

Definition at line 48 of file GenericMatrixCovarianceFunction.h.

Constructor & Destructor Documentation

template<class P_V , class P_M , class Q_V , class Q_M >

QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::GenericMatrixCovarianceFunction	(	const char *	prefix,
		const VectorSet< P_V, P_M > &	basicDomainSet,
		const VectorSet< Q_V, Q_M > &	imageSet,
		void(*)(const P_V &positionVector1, const P_V &positionVector2, const void *routineDataPtr, Q_M &imageMatrix)	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 32 of file GenericMatrixCovarianceFunction.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::m_env, QUESO::BaseMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::m_prefix, and QUESO::BaseEnvironment::subDisplayFile().

  :
  BaseMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>(prefix,basicDomainSet,imageSet),
  m_covRoutinePtr                                     (covRoutinePtr),
  m_routineDataPtr                                    (routinesDataPtr)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Entering GenericMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Leaving GenericMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }
}

template<class P_V , class P_M , class Q_V , class Q_M >

QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::~GenericMatrixCovarianceFunction ( )

virtual

Virtual destructor.

Definition at line 57 of file GenericMatrixCovarianceFunction.C.

{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Entering GenericMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>::destructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Leaving GenericMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>::destructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }
}

Member Function Documentation

template<class P_V , class P_M , class Q_V , class Q_M >

void QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::covMatrix ( const P_V &  positionVector1, const P_V &  positionVector2, Q_M &  imageMatrix  ) const

virtual

Calculates the value of the generic covariance matrix.

This function accesses the routine that calculates the covariance function.

Implements QUESO::BaseMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >.

Definition at line 74 of file GenericMatrixCovarianceFunction.C.

References QUESO::queso_require_equal_to_msg.

{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Entering GenericMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>::covMatrix()"
                            << std::endl;
  }

  unsigned int matrixOrder = m_imageSet.vectorSpace().dimLocal();

  queso_require_equal_to_msg(imageMatrix.numRowsLocal(), matrixOrder, "imageMatrix has invalid number of rows");

  queso_require_equal_to_msg(imageMatrix.numCols(), matrixOrder, "imageMatrix has invalid number of columns");

  queso_require_msg(m_covRoutinePtr, "m_covRoutinePtr = NULL");

  m_covRoutinePtr(positionVector1, positionVector2, m_routineDataPtr, imageMatrix);

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
    *m_env.subDisplayFile() << "Leaving GenericMatrixCovarianceFunction<P_V,P_M,Q_V,Q_M>::covMatrix()"
                            << std::endl;
  }

  return;
}

Member Data Documentation

template<class P_V = GslVector, class P_M = GslMatrix, class Q_V = GslVector, class Q_M = GslMatrix>

void(* QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::m_covRoutinePtr)(const P_V &positionVector1, const P_V &positionVector2, const void *routineDataPtr, Q_M &imageMatrix)

protected

Definition at line 75 of file GenericMatrixCovarianceFunction.h.

template<class P_V = GslVector, class P_M = GslMatrix, class Q_V = GslVector, class Q_M = GslMatrix>

const void* QUESO::GenericMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::m_routineDataPtr

protected

Definition at line 76 of file GenericMatrixCovarianceFunction.h.

---

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

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