A templated class for handling sets. More...

#include <VectorSet.h>

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

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

Public Member Functions
Constructor/Destructor methods.
	VectorSet ()
	Default Constructor. More...

	VectorSet (const BaseEnvironment &env, const char *prefix, double volume)
	Shaped constructor. More...

virtual	~VectorSet ()
	Virtual destructor. More...

Environment methods
const BaseEnvironment &	env () const
	Environment. Access to private attribute m_env. More...

const std::string &	prefix () const
	Access to private attribute m_prefix. More...

Mathematical methods.
double	volume () const
	Set volume; access to private attribute m_volume. More...

virtual const VectorSpace< V, M > &	vectorSpace () const =0
	Vector space to which `this` set belongs to. See template specialization. More...

virtual bool	contains (const V &vec) const =0
	Checks whether a set contains vector `vec`. See template specialization. More...

Protected Attributes
const BaseEnvironment &	m_env

std::string	m_prefix

double	m_volume

I/O methods.
virtual void	print (std::ostream &os) const
	Prints nothing. More...

std::ostream &	operator<< (std::ostream &os, const VectorSet< V, M > &obj)

Detailed Description

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

A templated class for handling sets.

This class allows the mathematical definition of a scalar function such as: $\pi: B \subset R^n \rightarrow R$ , since it requires the specification of the domain $ B $ , which is a subset of the vector space $ R^n $ , which is itself a set.

Definition at line 49 of file VectorSet.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::VectorSet< V, M >::VectorSet ( )

Default Constructor.

It should not be used by the user.

Definition at line 37 of file VectorSet.C.

References QUESO::VectorSet< V, M >::m_env, UQ_FATAL_TEST_MACRO, and QUESO::BaseEnvironment::worldRank().

   : m_env(*(new EmptyEnvironment()))
 {
   UQ_FATAL_TEST_MACRO(true,
                       m_env.worldRank(),
                       "VectorSet<V,M>::constructor(), default",
                       "should not be used by user");
 }

template<class V , class M >

QUESO::VectorSet< V, M >::VectorSet	(	const BaseEnvironment &	env,
		const char *	prefix,
		double	volume
	)

Shaped constructor.

Creates a vector set given an environment, a identifying prefix and a volume.

Definition at line 48 of file VectorSet.C.

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

   : m_env(env),
     m_prefix(prefix),
     m_volume(volume)
 {
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
     *m_env.subDisplayFile() << "Entering VectorSet<V,M>::constructor()"
                            << std::endl;
   }
 
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
     *m_env.subDisplayFile() << "Leaving VectorSet<V,M>::constructor()"
                            << std::endl;
   }
 }

template<class V , class M >

QUESO::VectorSet< V, M >::~VectorSet ( )

virtual

Virtual destructor.

Definition at line 67 of file VectorSet.C.

 {
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
     *m_env.subDisplayFile() << "Entering VectorSet<V,M>::destructor()"
                            << std::endl;
   }
 
   if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 54)) {
     *m_env.subDisplayFile() << "Leaving VectorSet<V,M>::destructor()"
                            << std::endl;
   }
 }

Member Function Documentation

template<class V, class M>

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

pure virtual

Checks whether a set contains vector vec. See template specialization.

Implemented in QUESO::VectorSpace< V, M >, QUESO::ConcatenationSubset< V, M >, QUESO::VectorSubset< V, M >, QUESO::BoxSubset< V, M >, QUESO::IntersectionSubset< V, M >, and QUESO::DiscreteSubset< V, M >.

template<class V , class M >

const BaseEnvironment & QUESO::VectorSet< V, M >::env ( ) const

Environment. Access to private attribute m_env.

Definition at line 82 of file VectorSet.C.

Referenced by QUESO::InstantiateIntersection().

 {
   return m_env;
 }

template<class V , class M >

const std::string & QUESO::VectorSet< V, M >::prefix ( ) const

Access to private attribute m_prefix.

Definition at line 88 of file VectorSet.C.

Referenced by QUESO::InstantiateIntersection().

 {
   return m_prefix;
 }

template<class V , class M >

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

virtual

Prints nothing.

Reimplemented in QUESO::VectorSpace< V, M >, QUESO::VectorSpace< P_V, P_M >, QUESO::VectorSpace< Q_V, Q_M >, QUESO::BoxSubset< V, M >, QUESO::BoxSubset< P_V, P_M >, QUESO::BoxSubset< Q_V, Q_M >, QUESO::ConcatenationSubset< V, M >, QUESO::VectorSubset< V, M >, QUESO::VectorSubset< Q_V, Q_M >, QUESO::VectorSubset< P_V, P_M >, QUESO::IntersectionSubset< V, M >, and QUESO::DiscreteSubset< V, M >.

Definition at line 102 of file VectorSet.C.

 {
   os << "In VectorSet<V,M>::print()"
      << ": nothing to be printed" << std::endl;
   return;
 }

template<class V, class M>

virtual const VectorSpace<V,M>& QUESO::VectorSet< V, M >::vectorSpace ( ) const

pure virtual

Vector space to which this set belongs to. See template specialization.

Implemented in QUESO::VectorSpace< V, M >, QUESO::VectorSpace< P_V, P_M >, QUESO::VectorSpace< Q_V, Q_M >, QUESO::VectorSubset< V, M >, QUESO::VectorSubset< Q_V, Q_M >, and QUESO::VectorSubset< P_V, P_M >.

Referenced by QUESO::ComputeCovCorrMatricesBetweenVectorRvs(), QUESO::ConcatenatedJointPdf< V, M >::ConcatenatedJointPdf(), QUESO::ExponentialMatrixCovarianceFunction< P_V, P_M, Q_V, Q_M >::ExponentialMatrixCovarianceFunction(), QUESO::InstantiateIntersection(), and QUESO::StatisticalInverseProblem< P_V, P_M >::StatisticalInverseProblem().

template<class V , class M >

double QUESO::VectorSet< V, M >::volume ( ) const

Set volume; access to private attribute m_volume.

Definition at line 95 of file VectorSet.C.

 {
   return m_volume;
 }

Friends And Related Function Documentation

template<class V, class M>

std::ostream& operator<<	(	std::ostream &	os,
		const VectorSet< V, M > &	obj
	)

friend

Definition at line 91 of file VectorSet.h.

                                    {
     obj.print(os);
     return os;
   }

Member Data Documentation

template<class V, class M>

const BaseEnvironment& QUESO::VectorSet< V, M >::m_env

protected

Definition at line 99 of file VectorSet.h.

Referenced by QUESO::BoxSubset< V, M >::BoxSubset(), QUESO::DiscreteSubset< V, M >::DiscreteSubset(), QUESO::VectorSet< V, M >::VectorSet(), QUESO::VectorSpace< V, M >::VectorSpace(), and QUESO::VectorSubset< V, M >::VectorSubset().

template<class V, class M>

std::string QUESO::VectorSet< V, M >::m_prefix

protected

Definition at line 100 of file VectorSet.h.

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

template<class V, class M>

double QUESO::VectorSet< V, M >::m_volume

protected

Definition at line 101 of file VectorSet.h.

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

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

src/basic/inc/VectorSet.h
src/basic/src/VectorSet.C

Public Member Functions

Protected Attributes

I/O methods.

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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