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

A templated class representing the discrete vector subsets. More...

#include <DiscreteSubset.h>

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

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

Public Member Functions
Constructor/Destructor methods.
	DiscreteSubset (const char *prefix, const VectorSpace< V, M > &vectorSpace, const std::vector< V * > &elements)
	Default Constructor. More...
	~DiscreteSubset ()
	Destructor. More...
Mathematical methods.
bool	contains (const V &vec) const
	Checks whether this discrete subset contains vector vec. TODO: incomplete code. More...
I/O methods.
void	print (std::ostream &os) const
	Prints nothing. 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
std::vector< V * >	m_elements
	Number of elements in the discrete vector subset. 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::DiscreteSubset< V, M >

A templated class representing the discrete vector subsets.

This class is used to represent the a discrete vector subset. Here the notion of volume does not apply, instead there is the total number of elements (vectors) that belongs to the subset.

Definition at line 42 of file DiscreteSubset.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::DiscreteSubset< V, M >::DiscreteSubset	(	const char *	prefix,
		const VectorSpace< V, M > &	vectorSpace,
		const std::vector< V * > &	elements
	)

Default Constructor.

It constructs a class object given the prefix, vector space to which it belongs and its number of elements.

Definition at line 32 of file DiscreteSubset.C.

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

  : VectorSubset<V,M>(prefix, vectorSpace, 0.),
    m_elements(elements.size(),NULL)
{
  m_volume = 0.;
  UQ_FATAL_TEST_MACRO(true,
                      m_env.worldRank(),
                      "DiscreteSubset<V,M>::contains()",
                      "incomplete code");
}

template<class V , class M >

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

(

)

Destructor.

Definition at line 47 of file DiscreteSubset.C.

{
}

Member Function Documentation

template<class V , class M >

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

virtual

Checks whether this discrete subset contains vector vec. TODO: incomplete code.

Implements QUESO::VectorSubset< V, M >.

Definition at line 53 of file DiscreteSubset.C.

References UQ_FATAL_TEST_MACRO.

{
  UQ_FATAL_TEST_MACRO(true,
                      m_env.worldRank(),
                      "DiscreteSubset<V,M>::contains()",
                      "incomplete code");

  return false;
}

template<class V , class M >

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

virtual

Prints nothing.

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

Definition at line 65 of file DiscreteSubset.C.

{
  os << "In DiscreteSubset<V,M>::print()"
     << ": nothing to print"
     << std::endl;

  return;
}

Member Data Documentation

template<class V , class M >

std::vector<V*> QUESO::DiscreteSubset< V, M >::m_elements

protected

Number of elements in the discrete vector subset.

Definition at line 74 of file DiscreteSubset.h.

---

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

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