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

This class allows the representation of a transition kernel with a scaled covariance matrix. More...

#include <ScaledCovMatrixTKGroup.h>

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

Public Member Functions
Constructor/Destructor methods
	ScaledCovMatrixTKGroup (const char *prefix, const VectorSpace< V, M > &vectorSpace, const std::vector< double > &scales, const M &covMatrix)
	Default constructor. More...
	~ScaledCovMatrixTKGroup ()
	Destructor. More...
Statistical/Mathematical methods
bool	symmetric () const
	Whether or not the matrix is symmetric. Always 'true'. More...
const GaussianVectorRV< V, M > &	rv (unsigned int stageId) const
	Gaussian increment property to construct a transition kernel. More...
const GaussianVectorRV< V, M > &	rv (const std::vector< unsigned int > &stageIds)
	Gaussian increment property to construct a transition kernel. More...
virtual const GaussianVectorRV < V, M > &	rv (const V &position) const
	Constructs transition kernel pdf based on internal m_stageId variable. More...
void	updateLawCovMatrix (const M &covMatrix)
	Scales the covariance matrix. More...
Misc methods
bool	setPreComputingPosition (const V &position, unsigned int stageId)
	Sets the pre-computing positions m_preComputingPositions[stageId] with a new vector of size position. More...
void	clearPreComputingPositions ()
	Clears the pre-computing positions m_preComputingPositions[stageId]. More...
virtual unsigned int	set_dr_stage (unsigned int stageId)
	Sets the internal m_stageId varialbe to stageId. More...
virtual bool	covMatrixIsDirty ()
virtual void	cleanCovMatrix ()
I/O methods
void	print (std::ostream &os) const
	TODO: Prints the transition kernel. More...
Public Member Functions inherited from QUESO::BaseTKGroup< V, M >
	BaseTKGroup ()
	Default constructor. More...
	BaseTKGroup (const char *prefix, const VectorSpace< V, M > &vectorSpace, const std::vector< double > &scales)
	Constructor. More...
virtual	~BaseTKGroup ()
	Destructor. More...
const BaseEnvironment &	env () const
	QUESO's environment. More...
const V &	preComputingPosition (unsigned int stageId) const
	Pre-computing position; access to protected attribute *m_preComputingPositions[stageId]. More...
virtual void	updateTK ()

Private Member Functions
void	setRVsWithZeroMean ()
	Sets the mean of the RVs to zero. More...

Private Attributes
M	m_originalCovMatrix

Additional Inherited Members
Protected Attributes inherited from QUESO::BaseTKGroup< V, M >
const EmptyEnvironment *	m_emptyEnv
const BaseEnvironment &	m_env
std::string	m_prefix
const VectorSpace< V, M > *	m_vectorSpace
std::vector< double >	m_scales
std::vector< const V * >	m_preComputingPositions
std::vector< BaseVectorRV< V, M > * >	m_rvs
unsigned int	m_stageId

Detailed Description

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

This class allows the representation of a transition kernel with a scaled covariance matrix.

Definition at line 44 of file ScaledCovMatrixTKGroup.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::ScaledCovMatrixTKGroup< V, M >::ScaledCovMatrixTKGroup	(	const char *	prefix,
		const VectorSpace< V, M > &	vectorSpace,
		const std::vector< double > &	scales,
		const M &	covMatrix
	)

Default constructor.

Definition at line 34 of file ScaledCovMatrixTKGroup.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseTKGroup< V, M >::m_env, QUESO::ScaledCovMatrixTKGroup< V, M >::m_originalCovMatrix, QUESO::BaseTKGroup< V, M >::m_preComputingPositions, QUESO::BaseTKGroup< V, M >::m_rvs, QUESO::BaseTKGroup< V, M >::m_scales, QUESO::ScaledCovMatrixTKGroup< V, M >::setRVsWithZeroMean(), and QUESO::BaseEnvironment::subDisplayFile().

  :
  BaseTKGroup<V,M>(prefix,vectorSpace,scales),
  m_originalCovMatrix    (covMatrix)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering ScaledCovMatrixTKGroup<V,M>::constructor()"
                           << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "In ScaledCovMatrixTKGroup<V,M>::constructor()"
                           << ": m_scales.size() = "                << m_scales.size()
                           << ", m_preComputingPositions.size() = " << m_preComputingPositions.size()
                           << ", m_rvs.size() = "                   << m_rvs.size()
                           << ", m_originalCovMatrix = "            << m_originalCovMatrix
                           << std::endl;
  }

  setRVsWithZeroMean();

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

template<class V , class M >

QUESO::ScaledCovMatrixTKGroup< V, M >::~ScaledCovMatrixTKGroup

(

)

Destructor.

Definition at line 66 of file ScaledCovMatrixTKGroup.C.

{
}

Member Function Documentation

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

virtual void QUESO::ScaledCovMatrixTKGroup< V, M >::cleanCovMatrix ( )

inlinevirtual

Performs whatever cleanup is needed (usually just resetting an internal bool flag) after the covariance matrix was modified.

After this method is called, covMatrixIsDirty should return true.

Implements QUESO::BaseTKGroup< V, M >.

Definition at line 88 of file ScaledCovMatrixTKGroup.h.

{ }

template<class V , class M >

void QUESO::ScaledCovMatrixTKGroup< V, M >::clearPreComputingPositions ( )

virtual

Clears the pre-computing positions m_preComputingPositions[stageId].

Reimplemented from QUESO::BaseTKGroup< V, M >.

Definition at line 214 of file ScaledCovMatrixTKGroup.C.

References QUESO::BaseTKGroup< V, M >::clearPreComputingPositions().

{
  BaseTKGroup<V,M>::clearPreComputingPositions();
}

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

virtual bool QUESO::ScaledCovMatrixTKGroup< V, M >::covMatrixIsDirty ( )

inlinevirtual

This method determines whether or not the user has 'dirtied' the covariance matrix, thereby necessitating an AM reset.

Should return true if the cov matrix was modified in such a way to affect the Adaptive Metropolis sample covariance calculation.

Implements QUESO::BaseTKGroup< V, M >.

Definition at line 87 of file ScaledCovMatrixTKGroup.h.

{ return false; }

template<class V , class M >

void QUESO::ScaledCovMatrixTKGroup< V, M >::print ( std::ostream &  os ) const

virtual

TODO: Prints the transition kernel.

Todo:

: implement me!

Reimplemented from QUESO::BaseTKGroup< V, M >.

Definition at line 249 of file ScaledCovMatrixTKGroup.C.

References QUESO::BaseTKGroup< V, M >::print().

{
  BaseTKGroup<V,M>::print(os);
}

template<class V , class M >

const GaussianVectorRV< V, M > & QUESO::ScaledCovMatrixTKGroup< V, M >::rv ( unsigned int  stageId ) const

virtual

Gaussian increment property to construct a transition kernel.

Implements QUESO::BaseTKGroup< V, M >.

Definition at line 79 of file ScaledCovMatrixTKGroup.C.

References QUESO::queso_require_not_equal_to_msg, and QUESO::GaussianVectorRV< V, M >::updateLawExpVector().

{
  queso_require_not_equal_to_msg(m_rvs.size(), 0, "m_rvs.size() = 0");

  queso_require_msg(m_rvs[0], "m_rvs[0] == NULL");

  queso_require_greater_msg(m_preComputingPositions.size(), stageId, "m_preComputingPositions.size() <= stageId");

  queso_require_msg(m_preComputingPositions[stageId], "m_preComputingPositions[stageId] == NULL");

  if ((m_env.subDisplayFile()        ) &&
      (m_env.displayVerbosity() >= 10)) {
    *m_env.subDisplayFile() << "In ScaledCovMatrixTKGroup<V,M>::rv1()"
                            << ", stageId = " << stageId
                            << ": about to call m_rvs[0]->updateLawExpVector()"
                            << ", vector = " << *m_preComputingPositions[stageId] // FIX ME: might demand parallelism
                            << std::endl;
  }

  GaussianVectorRV<V, M> * gaussian_rv = dynamic_cast<GaussianVectorRV<V, M> * >(m_rvs[0]);

  gaussian_rv->updateLawExpVector(*m_preComputingPositions[stageId]);

  return (*gaussian_rv);
}

template<class V , class M >

const GaussianVectorRV< V, M > & QUESO::ScaledCovMatrixTKGroup< V, M >::rv ( const std::vector< unsigned int > &  stageIds )

virtual

Gaussian increment property to construct a transition kernel.

Implements QUESO::BaseTKGroup< V, M >.

Definition at line 107 of file ScaledCovMatrixTKGroup.C.

References QUESO::GaussianVectorRV< V, M >::updateLawExpVector().

{
  queso_require_greater_equal_msg(m_rvs.size(), stageIds.size(), "m_rvs.size() < stageIds.size()");

  queso_require_msg(m_rvs[stageIds.size()-1], "m_rvs[stageIds.size()-1] == NULL");

  queso_require_greater_msg(m_preComputingPositions.size(), stageIds[0], "m_preComputingPositions.size() <= stageIds[0]");

  queso_require_msg(m_preComputingPositions[stageIds[0]], "m_preComputingPositions[stageIds[0]] == NULL");

  if ((m_env.subDisplayFile()        ) &&
      (m_env.displayVerbosity() >= 10)) {
    *m_env.subDisplayFile() << "In ScaledCovMatrixTKGroup<V,M>::rv2()"
                            << ", stageIds.size() = " << stageIds.size()
                            << ", stageIds[0] = "     << stageIds[0]
                            << ": about to call m_rvs[stageIds.size()-1]->updateLawExpVector()"
                            << ", vector = " << *m_preComputingPositions[stageIds[0]] // FIX ME: might demand parallelism
                            << std::endl;
  }

  GaussianVectorRV<V, M> * gaussian_rv = dynamic_cast<GaussianVectorRV<V, M> * >(m_rvs[stageIds.size()-1]);

  gaussian_rv->updateLawExpVector(*m_preComputingPositions[stageIds[0]]);

  return (*gaussian_rv);
}

template<class V , class M >

const GaussianVectorRV< V, M > & QUESO::ScaledCovMatrixTKGroup< V, M >::rv ( const V &  position ) const

virtual

Constructs transition kernel pdf based on internal m_stageId variable.

Implements QUESO::BaseTKGroup< V, M >.

Definition at line 136 of file ScaledCovMatrixTKGroup.C.

References QUESO::queso_require_not_equal_to_msg, and QUESO::GaussianVectorRV< V, M >::updateLawExpVector().

{
  queso_require_not_equal_to_msg(m_rvs.size(), 0, "m_rvs.size() = 0");
  queso_require_msg(m_rvs[0], "m_rvs[0] == NULL");
  //queso_require_greater_msg(m_preComputingPositions.size(), this->m_stageId, "m_preComputingPositions.size() <= stageId");
  //queso_require_msg(m_preComputingPositions[this->m_stageId], "m_preComputingPositions[stageId] == NULL");

  GaussianVectorRV<V, M> * gaussian_rv = dynamic_cast<GaussianVectorRV<V, M> * >(m_rvs[this->m_stageId]);

  gaussian_rv->updateLawExpVector(position);

  return (*gaussian_rv);
}

template<class V , class M >

unsigned int QUESO::ScaledCovMatrixTKGroup< V, M >::set_dr_stage ( unsigned int  stageId )

virtual

Sets the internal m_stageId varialbe to stageId.

Reimplemented from QUESO::BaseTKGroup< V, M >.

Definition at line 221 of file ScaledCovMatrixTKGroup.C.

{
  unsigned int old_stageId = this->m_stageId;
  this->m_stageId = stageId;
  return old_stageId;
}

template<class V , class M >

bool QUESO::ScaledCovMatrixTKGroup< V, M >::setPreComputingPosition ( const V &  position, unsigned int  stageId  )

virtual

Sets the pre-computing positions m_preComputingPositions[stageId] with a new vector of size position.

Reimplemented from QUESO::BaseTKGroup< V, M >.

Definition at line 175 of file ScaledCovMatrixTKGroup.C.

References QUESO::GaussianJointPdf< V, M >::lawCovMatrix(), and QUESO::BaseTKGroup< V, M >::setPreComputingPosition().

{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering ScaledCovMatrixTKGroup<V,M>::setPreComputingPosition()"
                           << ": position = " << position
                           << ", stageId = "  << stageId
                           << std::endl;
  }

  BaseTKGroup<V,M>::setPreComputingPosition(position,stageId);
  //setRVsWithZeroMean();

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "In ScaledCovMatrixTKGroup<V,M>::setPreComputingPosition()"
                           << ", position = "        << position
                           << ", stageId = "         << stageId
                           << ": preComputingPos = " << *m_preComputingPositions[stageId];
    if (stageId < m_scales.size()) {
      *m_env.subDisplayFile() << ", factor = " << 1./m_scales[stageId]/m_scales[stageId];
    }
    if (stageId < m_rvs.size()) {
      const GaussianJointPdf<V,M>* pdfPtr = dynamic_cast< const GaussianJointPdf<V,M>* >(&(m_rvs[stageId]->pdf()));
      *m_env.subDisplayFile() << ", rvCov = " << pdfPtr->lawCovMatrix(); // FIX ME: might demand parallelism
    }
    *m_env.subDisplayFile() << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Leaving ScaledCovMatrixTKGroup<V,M>::setPreComputingPosition()"
                           << ": position = " << position
                           << ", stageId = "  << stageId
                           << std::endl;
  }

  return true;
}

template<class V , class M >

void QUESO::ScaledCovMatrixTKGroup< V, M >::setRVsWithZeroMean ( )

private

Sets the mean of the RVs to zero.

Definition at line 231 of file ScaledCovMatrixTKGroup.C.

References QUESO::queso_require_equal_to_msg, and QUESO::queso_require_not_equal_to_msg.

Referenced by QUESO::ScaledCovMatrixTKGroup< V, M >::ScaledCovMatrixTKGroup().

{
  queso_require_not_equal_to_msg(m_rvs.size(), 0, "m_rvs.size() = 0");

  queso_require_equal_to_msg(m_rvs.size(), m_scales.size(), "m_rvs.size() != m_scales.size()");

  for (unsigned int i = 0; i < m_scales.size(); ++i) {
    double factor = 1./m_scales[i]/m_scales[i];
    queso_require_msg(!(m_rvs[i]), "m_rvs[i] != NULL");
    m_rvs[i] = new GaussianVectorRV<V,M>(m_prefix.c_str(),
                                         *m_vectorSpace,
                                         m_vectorSpace->zeroVector(),
                                         factor*m_originalCovMatrix);
  }
}

template<class V , class M >

bool QUESO::ScaledCovMatrixTKGroup< V, M >::symmetric ( ) const

virtual

Whether or not the matrix is symmetric. Always 'true'.

Todo:

: It only returns 'true', thus a test for its symmetricity must be included.

Implements QUESO::BaseTKGroup< V, M >.

Definition at line 72 of file ScaledCovMatrixTKGroup.C.

{
  return true;
}

template<class V , class M >

void QUESO::ScaledCovMatrixTKGroup< V, M >::updateLawCovMatrix

(

const M &

covMatrix

)

Scales the covariance matrix.

The covariance matrix is scaled by a factor of \( 1/scales^2 \).

Definition at line 153 of file ScaledCovMatrixTKGroup.C.

{
  for (unsigned int i = 0; i < m_scales.size(); ++i) {
    double factor = 1./m_scales[i]/m_scales[i];
    if ((m_env.subDisplayFile()        ) &&
        (m_env.displayVerbosity() >= 10)) {
      *m_env.subDisplayFile() << "In ScaledCovMatrixTKGroup<V,M>::updateLawCovMatrix()"
                              << ", m_scales.size() = " << m_scales.size()
                              << ", i = "               << i
                              << ", m_scales[i] = "     << m_scales[i]
                              << ", factor = "          << factor
                              << ": about to call m_rvs[i]->updateLawCovMatrix()"
                              << ", covMatrix = \n" << factor*covMatrix // FIX ME: might demand parallelism
                              << std::endl;
    }
    dynamic_cast<GaussianVectorRV<V, M> * >(m_rvs[i])->updateLawCovMatrix(factor*covMatrix);
  }
}

Member Data Documentation

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

M QUESO::ScaledCovMatrixTKGroup< V, M >::m_originalCovMatrix

private

Definition at line 107 of file ScaledCovMatrixTKGroup.h.

Referenced by QUESO::ScaledCovMatrixTKGroup< V, M >::ScaledCovMatrixTKGroup().

---

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

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