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

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

#include <UniformVectorRealizer.h>

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

Public Member Functions
Constructor/Destructor methods
	UniformVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet)
	Constructor. More...
	~UniformVectorRealizer ()
	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 = GslVector, class M = GslMatrix>
class QUESO::UniformVectorRealizer< V, M >

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

This class handles sampling from a uniform probability density distribution.

Definition at line 45 of file UniformVectorRealizer.h.

Constructor & Destructor Documentation

template<class V , class M >

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

Constructor.

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

Note: If unifiedImageSet is unbounded, it does not make sense to ask for realizations.

Definition at line 35 of file UniformVectorRealizer.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 UniformVectorRealizer<V,M>::constructor()"
                            << ": prefix = " << m_prefix
                            << std::endl;
  }

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

template<class V , class M >

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

(

)

Destructor.

Definition at line 55 of file UniformVectorRealizer.C.

{
}

Member Function Documentation

template<class V , class M >

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

virtual

Draws a realization.

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

Note: If the state space is unbounded, the distribution is improper and realizations do not make sense.

Implements QUESO::BaseVectorRealizer< V, M >.

Definition at line 61 of file UniformVectorRealizer.C.

References QUESO::BoxSubset< V, M >::maxValues(), QUESO::BoxSubset< V, M >::minValues(), QUESO::queso_isfinite(), and QUESO::VectorSet< V, M >::volume().

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

  queso_require_msg(imageBox, "only box images are supported right now");
  queso_require_msg(queso_isfinite(imageBox->volume()), "drawing realisations from an improper uniform is not supported");

  nextValues.cwSetUniform(imageBox->minValues(),imageBox->maxValues());
}

---

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

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