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

A templated class representing the concatenation of two vector subsets. More...

#include <ConcatenationSubset.h>

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

Public Member Functions
Constructor/Destructor methods.
	ConcatenationSubset (const char *prefix, const VectorSpace< V, M > &vectorSpace, const VectorSet< V, M > &set1, const VectorSet< V, M > &set2)
	Constructor - two sets only. More...
	ConcatenationSubset (const char *prefix, const VectorSpace< V, M > &vectorSpace, double volume, const std::vector< const VectorSet< V, M > * > &sets)
	Constructor - collection of sets. More...
	~ConcatenationSubset ()
	Destructor. More...
Mathematical methods.
bool	contains (const V &vec) const
	Determines whether each one of the subsets m_sets (class' private attributes) contains vector vec. More...
virtual void	centroid (V &vec) const
	Returns the set centroid in the vector vec. More...
virtual void	moments (M &mat) const
	Returns the set moments of inertia in the matrix mat. More...
I/O methods.
void	print (std::ostream &os) const
	Prints the subsets (via protected attribute m_sets). 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
std::vector< const VectorSet < V, M > * >	m_sets
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::ConcatenationSubset< V, M >

A templated class representing the concatenation of two vector subsets.

This class is used to represent the concatenation of two subsets. It allows concatenation of both two subsets as well as a collection of subsets into one.

Definition at line 43 of file ConcatenationSubset.h.

Constructor & Destructor Documentation

template<class V , class M >

QUESO::ConcatenationSubset< V, M >::ConcatenationSubset	(	const char *	prefix,
		const VectorSpace< V, M > &	vectorSpace,
		const VectorSet< V, M > &	set1,
		const VectorSet< V, M > &	set2
	)

Constructor - two sets only.

It concatenates set1 and set2 into a new set, m_set, of volume given by set1.volume()*set2.volume().

Definition at line 35 of file ConcatenationSubset.C.

References QUESO::ConcatenationSubset< V, M >::m_sets.

  : VectorSubset<V,M>(prefix, vectorSpace, set1.volume()*set2.volume()),
    m_sets(2, (const VectorSet<V,M>*) NULL)
{
  m_sets[0] = &set1;
  m_sets[1] = &set2;
}

template<class V , class M >

QUESO::ConcatenationSubset< V, M >::ConcatenationSubset	(	const char *	prefix,
		const VectorSpace< V, M > &	vectorSpace,
		double	volume,
		const std::vector< const VectorSet< V, M > * > &	sets
	)

Constructor - collection of sets.

It concatenates a collection of n subsets (using the std::vector to represent such collection) into a new set, m_set, of volume given by sets[0].volume()*sets[1].volume()*...*sets[n-1].volume().

Definition at line 48 of file ConcatenationSubset.C.

References QUESO::ConcatenationSubset< V, M >::m_sets.

  : VectorSubset<V,M>(prefix, vectorSpace, volume),
    m_sets(sets.size(), (const VectorSet<V,M>*) NULL)
{
  for (unsigned int i = 0; i < m_sets.size(); ++i) {
    m_sets[i] = sets[i];
  }
}

template<class V , class M >

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

(

)

Destructor.

Definition at line 62 of file ConcatenationSubset.C.

{
}

Member Function Documentation

template<class V , class M >

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

virtual

Returns the set centroid in the vector vec.

Implements QUESO::VectorSet< V, M >.

Definition at line 96 of file ConcatenationSubset.C.

References QUESO::queso_require_equal_to_msg.

{
  unsigned int cumulativeSize = 0;
  for (unsigned int i = 0; i < m_sets.size(); ++i) {
    V subvec(m_sets[i]->vectorSpace().zeroVector());
    m_sets[i]->centroid(subvec);
    vec.cwSet(cumulativeSize,subvec);

    cumulativeSize += subvec.sizeLocal();
  }

  queso_require_equal_to_msg(vec.sizeLocal(), cumulativeSize, "incompatible vector sizes");
}

template<class V , class M >

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

virtual

Determines whether each one of the subsets m_sets (class' private attributes) contains vector vec.

Implements QUESO::VectorSubset< V, M >.

Definition at line 68 of file ConcatenationSubset.C.

References QUESO::queso_require_equal_to_msg.

{
  bool result = true;

  std::vector<V*> vecs(m_sets.size(),(V*) NULL);
  for (unsigned int i = 0; i < vecs.size(); ++i) {
    vecs[i] = new V(m_sets[i]->vectorSpace().zeroVector());
  }

  unsigned int cummulativeSize = 0;
  for (unsigned int i = 0; i < vecs.size(); ++i) {
    vec.cwExtract(cummulativeSize,*(vecs[i]));
    cummulativeSize += vecs[i]->sizeLocal();
  }

  queso_require_equal_to_msg(vec.sizeLocal(), cummulativeSize, "incompatible vector sizes");

  for (unsigned int i = 0; i < m_sets.size(); ++i) {
    result = result && m_sets[i]->contains(*(vecs[i]));
  }
  for (unsigned int i = 0; i < vecs.size(); ++i) {
    delete vecs[i];
  }

  return (result);
}

template<class V , class M >

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

virtual

Returns the set moments of inertia in the matrix mat.

Implements QUESO::VectorSet< V, M >.

Definition at line 111 of file ConcatenationSubset.C.

References QUESO::Map::NumGlobalElements(), and QUESO::queso_require_equal_to_msg.

{
  unsigned int cumulativeSize = 0;
  for (unsigned int i = 0; i < m_sets.size(); ++i) {
    const Map & map = m_sets[i]->vectorSpace().map();
    const unsigned int n_columns = map.NumGlobalElements();
    M submat(m_sets[i]->vectorSpace().env(),
             map, n_columns);
    m_sets[i]->moments(submat);
    mat.cwSet(cumulativeSize,cumulativeSize,submat);

    cumulativeSize += n_columns;
  }

  queso_require_equal_to_msg(mat.numCols(), cumulativeSize, "incompatible vector sizes");
}

template<class V , class M >

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

virtual

Prints the subsets (via protected attribute m_sets).

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

Definition at line 130 of file ConcatenationSubset.C.

{
  os << "In ConcatenationSubset<V,M>::print()"
     << ": m_sets.size() = " << m_sets.size()
     << std::endl;
  for (unsigned int i = 0; i < m_sets.size(); ++i) {
    os << "m_sets[" << i << "] = " << *(m_sets[i]);
    if (i < (m_sets.size()-1)) {
      os << ", ";
    }
  }
  os << std::endl;

  return;
}

Member Data Documentation

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

std::vector<const VectorSet<V,M>* > QUESO::ConcatenationSubset< V, M >::m_sets

protected

Definition at line 89 of file ConcatenationSubset.h.

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

---

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

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