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

Class representing a subset of a vector space shaped like a hypercube. More...

#include <BoxSubset.h>

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

Public Member Functions
void	print (std::ostream &os) const
	Prints the volume, the minimum and the maximum values of this. More...
Constructor/Destructor methods
	BoxSubset (const char *prefix, const VectorSpace< V, M > &vectorSpace, const V &minValues, const V &maxValues)
	Shaped, default constructor. More...
	~BoxSubset ()
	Destructor. More...
Mathematical methods.
bool	contains (const V &vec) const
	Checks whether this box subset contains vector vec. More...
void	centroid (V &vec) const
	Returns the centroid of this box subset in the vector vec. More...
void	moments (M &mat) const
	Returns the moments of inertia of this box subset in the matrix mat. More...
const V &	minValues () const
	Vector of the minimum values of the box subset. More...
const V &	maxValues () const
	Vector of the maximum values of the box subset. More...
Public Member Functions inherited from QUESO::VectorSubset< V, M >
	VectorSubset ()
	Default Constructor. More...
	VectorSubset (const char *prefix, const VectorSpace< V, M > &vectorSpace, double volume)
	Shaped constructor (with volume). More...
virtual	~VectorSubset ()
	Destructor. More...
const VectorSpace< V, M > &	vectorSpace () const
	Vector space to which this set belongs to. See template specialization. More...
Public Member Functions inherited from QUESO::VectorSet< V, M >
	VectorSet (const BaseEnvironment &env, const char *prefix, double volume)
	Shaped constructor. More...
virtual	~VectorSet ()
	Virtual destructor. More...
const BaseEnvironment &	env () const
	Environment. Access to private attribute m_env. More...
const std::string &	prefix () const
	Access to private attribute m_prefix. More...
double	volume () const
	Set volume; access to private attribute m_volume. More...

Protected Attributes
V	m_minValues
	Vector of templated type V to store the minimum values of the box subset class. More...
V	m_maxValues
	Vector of templated type V to store the maximum values of the box subset class. More...
Protected Attributes inherited from QUESO::VectorSubset< V, M >
const VectorSpace< V, M > *	m_vectorSpace
Protected Attributes inherited from QUESO::VectorSet< V, M >
const BaseEnvironment &	m_env
std::string	m_prefix
double	m_volume

Detailed Description

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

Class representing a subset of a vector space shaped like a hypercube.

This class is determined by a collection of upper and lower limits of the hypercube. (line segment in \( R \), rectangle in \( R^2 \), and so on).

Definition at line 44 of file BoxSubset.h.

Constructor & Destructor Documentation

template<class V, class M>

QUESO::BoxSubset< V, M >::BoxSubset	(	const char *	prefix,
		const VectorSpace< V, M > &	vectorSpace,
		const V &	minValues,
		const V &	maxValues
	)

Shaped, default constructor.

Construct a subspace of vectorSpace, with min and max values given by the vectors minValues and maxValues, respectively. It checks for possible inconsistencies between the values stored in minValues and maxValues, and calculates the volume of the box subset, assigning it to m_volume.

Definition at line 34 of file BoxSubset.C.

References QUESO::VectorSpace< V, M >::dimLocal(), QUESO::BoxSubset< V, M >::m_maxValues, QUESO::BoxSubset< V, M >::m_minValues, QUESO::VectorSubset< V, M >::m_vectorSpace, QUESO::VectorSet< V, M >::m_volume, and QUESO::queso_require_equal_to_msg.

  : VectorSubset<V,M>(prefix,vectorSpace,0.),
    m_minValues(minValues),
    m_maxValues(maxValues)
{
  queso_require_equal_to_msg(minValues.sizeLocal(), maxValues.sizeLocal(), "vectors 'minValues' and 'maxValues' should have the same size");
  queso_require_equal_to_msg(minValues.sizeLocal(), vectorSpace.dimLocal(), "sizes of vectors 'minValues' and 'maxValues' should be equal to dimension of the vector space");
  for (unsigned int i = 0; i < m_vectorSpace->dimLocal(); ++i) {
    queso_require_less_equal_msg(minValues[i], maxValues[i], "it should happen minValue <= maxValue for all dimensions");
  }

  m_volume = 1.;
  for (unsigned int i = 0; i < m_vectorSpace->dimLocal(); ++i) {
    m_volume *= (m_maxValues[i] - m_minValues[i]);
  }
}

template<class V , class M >

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

(

)

Destructor.

Definition at line 56 of file BoxSubset.C.

{
}

Member Function Documentation

template<class V, class M >

void QUESO::BoxSubset< V, M >::centroid ( V &  vec ) const

virtual

Returns the centroid of this box subset in the vector vec.

Implements QUESO::VectorSet< V, M >.

Definition at line 73 of file BoxSubset.C.

{
  vec = m_minValues;
  vec += m_maxValues;
  vec *= 0.5;
}

template<class V, class M >

bool QUESO::BoxSubset< V, M >::contains ( const V &  vec ) const

virtual

Checks whether this box subset contains vector vec.

It checks if both statements are true: 1) all components in vec are larger than m_minValues, and 2) all all components in vec are smaller than m_maxValues.

Implements QUESO::VectorSubset< V, M >.

Definition at line 62 of file BoxSubset.C.

{
  // prudenci, 2012-09-26: allow boundary values because of 'beta' realizer, which can generate a sample with boundary value '1'
  //return (!vec.atLeastOneComponentSmallerOrEqualThan(m_minValues) &&
  //        !vec.atLeastOneComponentBiggerOrEqualThan (m_maxValues));
  return (!vec.atLeastOneComponentSmallerThan(m_minValues) &&
          !vec.atLeastOneComponentBiggerThan (m_maxValues));
}

template<class V , class M >

const V & QUESO::BoxSubset< V, M >::maxValues

(

)

const

Vector of the maximum values of the box subset.

Definition at line 101 of file BoxSubset.C.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::BaseJointPdf< V, M >::commonComputeLogOfNormalizationFactor(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::InstantiateIntersection(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::JeffreysVectorRealizer< V, M >::realization(), QUESO::GammaVectorRealizer< V, M >::realization(), QUESO::UniformVectorRealizer< V, M >::realization(), and QUESO::MetropolisHastingsSG< P_V, P_M >::transformInitialCovMatrixToGaussianSpace().

{
  return m_maxValues;
}

template<class V , class M >

const V & QUESO::BoxSubset< V, M >::minValues

(

)

const

Vector of the minimum values of the box subset.

Definition at line 95 of file BoxSubset.C.

Referenced by QUESO::BetaVectorRV< V, M >::BetaVectorRV(), QUESO::BaseJointPdf< V, M >::commonComputeLogOfNormalizationFactor(), QUESO::GammaVectorRV< V, M >::GammaVectorRV(), QUESO::InstantiateIntersection(), QUESO::InverseGammaVectorRV< V, M >::InverseGammaVectorRV(), QUESO::LogNormalVectorRV< V, M >::LogNormalVectorRV(), QUESO::JeffreysVectorRealizer< V, M >::realization(), QUESO::GammaVectorRealizer< V, M >::realization(), QUESO::UniformVectorRealizer< V, M >::realization(), and QUESO::MetropolisHastingsSG< P_V, P_M >::transformInitialCovMatrixToGaussianSpace().

{
  return m_minValues;
}

template<class V , class M>

void QUESO::BoxSubset< V, M >::moments ( M &  mat ) const

virtual

Returns the moments of inertia of this box subset in the matrix mat.

Implements QUESO::VectorSet< V, M >.

Definition at line 83 of file BoxSubset.C.

{
  mat.zeroLower();
  mat.zeroUpper();
  for (unsigned int i = 0; i < m_vectorSpace->dimLocal(); ++i) {
    double length_i = (m_maxValues[i] - m_minValues[i]);
    mat(i,i) = length_i*length_i*length_i/12;
  }
}

template<class V , class M >

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

virtual

Prints the volume, the minimum and the maximum values of this.

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

Definition at line 108 of file BoxSubset.C.

{
  os << "In BoxSubset<V,M>::print()"
     << ": m_minValues = " << m_minValues
     << ", m_maxValues = " << m_maxValues
     << ", m_volume = "    << m_volume
     << std::endl;

  return;
}

Member Data Documentation

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

V QUESO::BoxSubset< V, M >::m_maxValues

protected

Vector of templated type V to store the maximum values of the box subset class.

Definition at line 95 of file BoxSubset.h.

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

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

V QUESO::BoxSubset< V, M >::m_minValues

protected

Vector of templated type V to store the minimum values of the box subset class.

Definition at line 92 of file BoxSubset.h.

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

---

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

• src/basic/inc/BoxSubset.h
• src/basic/src/BoxSubset.C