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

A class for handling sampling from a jeffreys probability density distribution. More...

#include <JeffreysVectorRealizer.h>

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

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

Public Member Functions
Constructor/Destructor methods
	JeffreysVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet)
	Constructor. More...
	~JeffreysVectorRealizer ()
	Destructor. More...
Realization-related methods
void	realization (V &nextValues) const
	Draws a realization. More...
Public Member Functions inherited from QUESO::BaseVectorRealizer< V, M >
	BaseVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, unsigned int subPeriod)
	Default constructor. More...
virtual	~BaseVectorRealizer ()
	Virtual destructor. More...
const VectorSet< V, M > &	unifiedImageSet () const
	Image set where the realizations lie. Access to protected attribute m_unifiedImageSet. More...
unsigned int	subPeriod () const
	Sub-period of the realization. Access to protected attribute m_subPeriod. More...

Additional Inherited Members
Protected Attributes inherited from QUESO::BaseVectorRealizer< V, M >
const BaseEnvironment &	m_env
std::string	m_prefix
const VectorSet< V, M > &	m_unifiedImageSet
unsigned int	m_subPeriod

Detailed Description

template<class V, class M>
class QUESO::JeffreysVectorRealizer< V, M >

A class for handling sampling from a jeffreys probability density distribution.

This class handles sampling from a jeffreys probability density distribution.

Definition at line 43 of file JeffreysVectorRealizer.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::JeffreysVectorRealizer< V, M >::JeffreysVectorRealizer	(	const char *	prefix,
		const VectorSet< V, M > &	unifiedImageSet
	)

Constructor.

Constructs a new object, given a prefix and the image set of the vector realizer.

Definition at line 33 of file JeffreysVectorRealizer.C.

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

  :
  BaseVectorRealizer<V,M>(((std::string)(prefix)+"gen").c_str(),unifiedImageSet,std::numeric_limits<unsigned int>::max())
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering JeffreysVectorRealizer<V,M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

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

template<class V , class M >

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

(

)

Destructor.

Definition at line 53 of file JeffreysVectorRealizer.C.

{
}

Member Function Documentation

template<class V , class M >

void QUESO::JeffreysVectorRealizer< V, M >::realization ( V &  nextValues ) const

virtual

Draws a realization.

This function draws a realization of a jeffreys distribution and saves it in nextValues. It internally finds the minimum and the maximum values of the distribution.

Implements QUESO::BaseVectorRealizer< V, M >.

Definition at line 59 of file JeffreysVectorRealizer.C.

References QUESO::BoxSubset< V, M >::maxValues(), QUESO::BoxSubset< V, M >::minValues(), and queso_error_msg.

{
  const BoxSubset<V,M>* imageBox = dynamic_cast<const BoxSubset<V,M>* >(&m_unifiedImageSet);

  if (imageBox == NULL) {
    queso_error_msg("For JeffreysVectorRealizer<V,M>::realization(), only box images are supported right now");
  }
  //take log of Jeffreys bounds to set uniform bounds
  GslVector logMinValues(imageBox->minValues());
  for (unsigned int i = 0; i < logMinValues.sizeLocal(); ++i) {
    if (logMinValues[i] < 0.0) {
      queso_error_msg("The minimum value for a Jeffreys distribution should be greater than or equal to zero.");
    }
    else {
      logMinValues[i] = std::log(logMinValues[i]);
    }
  }

  GslVector logMaxValues(imageBox->maxValues());
  for (unsigned int i = 0; i < logMaxValues.sizeLocal(); ++i) {
    if (logMaxValues[i] <= 0.0) {
      queso_error_msg("The maximum value for a Jeffreys distribution should be greater than zero.");
    }
    else {
      logMaxValues[i] = std::log(logMaxValues[i]);
    }
  }

  nextValues.cwSetUniform(logMinValues,logMaxValues);
  for (unsigned int i = 0; i < nextValues.sizeLocal(); ++i) {
    nextValues[i] = std::exp(nextValues[i]);
  }
  return;
}

---

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

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