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

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

#include <WignerVectorRealizer.h>

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

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

Public Member Functions
Constructor/Destructor methods
	WignerVectorRealizer (const char *prefix, const VectorSet< V, M > &unifiedImageSet, const V &centerPos, double radius)
	Constructor. More...
	~WignerVectorRealizer ()
	Destructor. More...
Realization-related methods
void	realization (V &nextValues) const
	TODO: 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...

Private Attributes
V *	m_centerPos
double	m_radius

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::WignerVectorRealizer< V, M >

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

This class will handle sampling from an Wigner probability density distribution, with a given center position and a radius.

Todo:

: The method WignerVectorRealizer:realization() is not yet available, thus this class does nothing.

Definition at line 49 of file WignerVectorRealizer.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::WignerVectorRealizer< V, M >::WignerVectorRealizer	(	const char *	prefix,
		const VectorSet< V, M > &	unifiedImageSet,
		const V &	centerPos,
		double	radius
	)

Constructor.

Constructs a new object, given a prefix, the image set of the vector realizer, the center position centerPos, and a radius radius.

Definition at line 34 of file WignerVectorRealizer.C.

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

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

  queso_require_greater_msg(m_radius, 0., "invalid radius");

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

template<class V , class M >

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

(

)

Destructor.

Definition at line 60 of file WignerVectorRealizer.C.

{
  delete m_centerPos;
}

Member Function Documentation

template<class V , class M >

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

virtual

TODO: Draws a realization.

Todo:

: implement and explain me!

Implements QUESO::BaseVectorRealizer< V, M >.

Definition at line 68 of file WignerVectorRealizer.C.

References queso_not_implemented.

{
  queso_not_implemented();

  nextValues.cwSet(0.);
  return;
}

Member Data Documentation

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

V* QUESO::WignerVectorRealizer< V, M >::m_centerPos

private

Definition at line 77 of file WignerVectorRealizer.h.

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

double QUESO::WignerVectorRealizer< V, M >::m_radius

private

Definition at line 78 of file WignerVectorRealizer.h.

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

---

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

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