queso-0.51.1
Public Member Functions | Protected Attributes | List of all members
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 >:
Inheritance graph
[legend]
Collaboration diagram for QUESO::BoxSubset< V, M >:
Collaboration graph
[legend]

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...
 
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 ()
 Default Constructor. More...
 
 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, class M>
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 41 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::VectorSet< V, M >::m_env, QUESO::BoxSubset< V, M >::m_maxValues, QUESO::BoxSubset< V, M >::m_minValues, QUESO::VectorSubset< V, M >::m_vectorSpace, QUESO::VectorSet< V, M >::m_volume, UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().

38  : VectorSubset<V,M>(prefix,vectorSpace,0.),
39  m_minValues(minValues),
40  m_maxValues(maxValues)
41 {
42  UQ_FATAL_TEST_MACRO(minValues.sizeLocal() != maxValues.sizeLocal(),
43  m_env.worldRank(),
44  "BoxSubset<V,M>::BoxSubset()",
45  "vectors 'minValues' and 'maxValues' should have the same size");
46  UQ_FATAL_TEST_MACRO(minValues.sizeLocal() != vectorSpace.dimLocal(),
47  m_env.worldRank(),
48  "BoxSubset<V,M>::BoxSubset()",
49  "sizes of vectors 'minValues' and 'maxValues' should be equal to dimension of the vector space");
50  for (unsigned int i = 0; i < m_vectorSpace->dimLocal(); ++i) {
51  UQ_FATAL_TEST_MACRO(minValues[i] > maxValues[i],
52  m_env.worldRank(),
53  "BoxSubset<V,M>::BoxSubset()",
54  "it should happen minValue <= maxValue for all dimensions");
55  }
56 
57  m_volume = 1.;
58  for (unsigned int i = 0; i < m_vectorSpace->dimLocal(); ++i) {
59  m_volume *= (m_maxValues[i] - m_minValues[i]);
60  }
61 }
QUESO::VectorSet::prefix
const std::string & prefix() const
Access to private attribute m_prefix.
Definition: VectorSet.C:88
QUESO::BoxSubset::minValues
const V & minValues() const
Vector of the minimum values of the box subset.
Definition: BoxSubset.C:82
QUESO::BaseEnvironment::worldRank
int worldRank() const
Returns the process world rank.
Definition: Environment.C:235
QUESO::VectorSubset::vectorSpace
const VectorSpace< V, M > & vectorSpace() const
Vector space to which this set belongs to. See template specialization.
Definition: VectorSubset.C:80
QUESO::BoxSubset::maxValues
const V & maxValues() const
Vector of the maximum values of the box subset.
Definition: BoxSubset.C:88
QUESO::VectorSet::m_env
const BaseEnvironment & m_env
Definition: VectorSet.h:99
UQ_FATAL_TEST_MACRO
#define UQ_FATAL_TEST_MACRO(test, givenRank, where, what)
Definition: Defines.h:223
QUESO::BoxSubset::m_maxValues
V m_maxValues
Vector of templated type V to store the maximum values of the box subset class.
Definition: BoxSubset.h:86
QUESO::VectorSubset::m_vectorSpace
const VectorSpace< V, M > * m_vectorSpace
Definition: VectorSubset.h:79
QUESO::BoxSubset::m_minValues
V m_minValues
Vector of templated type V to store the minimum values of the box subset class.
Definition: BoxSubset.h:83
template<class V , class M >
QUESO::BoxSubset< V, M >::~BoxSubset ( )

Destructor.

Definition at line 65 of file BoxSubset.C.

66 {
67 }

Member Function Documentation

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 71 of file BoxSubset.C.

72 {
73  // prudenci, 2012-09-26: allow boundary values because of 'beta' realizer, which can generate a sample with boundary value '1'
74  //return (!vec.atLeastOneComponentSmallerOrEqualThan(m_minValues) &&
75  // !vec.atLeastOneComponentBiggerOrEqualThan (m_maxValues));
76  return (!vec.atLeastOneComponentSmallerThan(m_minValues) &&
77  !vec.atLeastOneComponentBiggerThan (m_maxValues));
78 }
QUESO::BoxSubset::m_maxValues
V m_maxValues
Vector of templated type V to store the maximum values of the box subset class.
Definition: BoxSubset.h:86
QUESO::BoxSubset::m_minValues
V m_minValues
Vector of templated type V to store the minimum values of the box subset class.
Definition: BoxSubset.h:83
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 88 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::UniformVectorRealizer< V, M >::realization(), QUESO::GammaVectorRealizer< V, M >::realization(), and QUESO::MetropolisHastingsSG< P_V, P_M >::transformInitialCovMatrixToGaussianSpace().

89 {
90  return m_maxValues;
91 }
QUESO::BoxSubset::m_maxValues
V m_maxValues
Vector of templated type V to store the maximum values of the box subset class.
Definition: BoxSubset.h:86
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 82 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::UniformVectorRealizer< V, M >::realization(), QUESO::GammaVectorRealizer< V, M >::realization(), and QUESO::MetropolisHastingsSG< P_V, P_M >::transformInitialCovMatrixToGaussianSpace().

83 {
84  return m_minValues;
85 }
QUESO::BoxSubset::m_minValues
V m_minValues
Vector of templated type V to store the minimum values of the box subset class.
Definition: BoxSubset.h:83
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 95 of file BoxSubset.C.

96 {
97  os << "In BoxSubset<V,M>::print()"
98  << ": m_minValues = " << m_minValues
99  << ", m_maxValues = " << m_maxValues
100  << ", m_volume = " << m_volume
101  << std::endl;
102 
103  return;
104 }
QUESO::BoxSubset::m_maxValues
V m_maxValues
Vector of templated type V to store the maximum values of the box subset class.
Definition: BoxSubset.h:86
QUESO::BoxSubset::m_minValues
V m_minValues
Vector of templated type V to store the minimum values of the box subset class.
Definition: BoxSubset.h:83

Member Data Documentation

template<class V, class M>
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 86 of file BoxSubset.h.

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

template<class V, class M>
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 83 of file BoxSubset.h.

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

The documentation for this class was generated from the following files:
Generated on Thu Apr 23 2015 19:26:17 for queso-0.51.1 by  doxygen 1.8.5