QUESO::StdOneDGrid< T > Class Template Reference

Class for accommodating standard one-dimensional grids. More...

#include <StdOneDGrid.h>

Inheritance diagram for QUESO::StdOneDGrid< T >:

Public Member Functions
Constructor/Destructor methods
	StdOneDGrid (const BaseEnvironment &env, const char *prefix, const std::vector< T > &points)
	Default constructor. More...
	~StdOneDGrid ()
	Destructor. More...
Accessor methods
T	operator[] (unsigned int i) const
	Returns the position of the i-th point in the grid. More...
Mathematical methods
unsigned int	size () const
	Grid size; the amount of points which defines the grid. More...
unsigned int	findIntervalId (const T &paramValue) const
	Finds the ID of an interval. See template specialization. More...
Public Member Functions inherited from QUESO::BaseOneDGrid< T >
	BaseOneDGrid (const BaseEnvironment &env, const char *prefix)
	Default constructor. More...
virtual	~BaseOneDGrid ()
	Virtual destructor. More...
void	print (std::ostream &ofsvar) const
	Prints the values of the grid points. More...

Protected Attributes
std::vector< T >	m_points
Protected Attributes inherited from QUESO::BaseOneDGrid< T >
const BaseEnvironment &	m_env
std::string	m_prefix

Detailed Description

template<class T>
class QUESO::StdOneDGrid< T >

Class for accommodating standard one-dimensional grids.

This class implements a standard one-dimensional grid, which is required, for instance, in the evaluation of the cumulative distribution function (CDF) of a random variable.

Definition at line 45 of file StdOneDGrid.h.

Constructor & Destructor Documentation

template<class T >

QUESO::StdOneDGrid< T >::StdOneDGrid	(	const BaseEnvironment &	env,
		const char *	prefix,
		const std::vector< T > &	points
	)

Default constructor.

Definition at line 30 of file StdOneDGrid.C.

References QUESO::BaseEnvironment::displayVerbosity(), QUESO::BaseOneDGrid< T >::m_env, QUESO::BaseOneDGrid< T >::m_prefix, and QUESO::BaseEnvironment::subDisplayFile().

  :
  BaseOneDGrid<T>(env,prefix),
  m_points              (points)
{
  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Entering StdOneDGrid<T>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }

  if ((m_env.subDisplayFile()) && (m_env.displayVerbosity() >= 5)) {
    *m_env.subDisplayFile() << "Leaving StdOneDGrid<T>::constructor()"
                           << ": prefix = " << m_prefix
                           << std::endl;
  }
}

template<class T >

QUESO::StdOneDGrid< T >::~StdOneDGrid

(

)

Destructor.

Definition at line 52 of file StdOneDGrid.C.

{
}

Member Function Documentation

template<class T >

unsigned int QUESO::StdOneDGrid< T >::findIntervalId ( const T &  paramValue ) const

virtual

Finds the ID of an interval. See template specialization.

Implements QUESO::BaseOneDGrid< T >.

Definition at line 74 of file StdOneDGrid.C.

{
  queso_require_msg(!((paramValue < m_points[0]) || (m_points[m_points.size()-1] < paramValue)), "paramValue is out of domain");

  unsigned int iMax = m_points.size();
  unsigned int i = 1; // Yes, '1'
  for (i = 1; i < iMax; ++i) { // Yes, '1'
    if (paramValue < m_points[i]) {
      i--;
      break;
    }
  }

  return i;
}

template<class T >

T QUESO::StdOneDGrid< T >::operator[] ( unsigned int  i ) const

virtual

Returns the position of the i-th point in the grid.

Implements QUESO::BaseOneDGrid< T >.

Definition at line 65 of file StdOneDGrid.C.

{
  queso_require_less_msg(i, m_points.size(), "too large i");

  return m_points[i];
}

template<class T >

unsigned int QUESO::StdOneDGrid< T >::size ( ) const

virtual

Grid size; the amount of points which defines the grid.

Implements QUESO::BaseOneDGrid< T >.

Definition at line 58 of file StdOneDGrid.C.

{
  return m_points.size();
}

Member Data Documentation

template<class T >

std::vector<T> QUESO::StdOneDGrid< T >::m_points

protected

Definition at line 76 of file StdOneDGrid.h.

---

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

• src/misc/inc/StdOneDGrid.h
• src/misc/src/StdOneDGrid.C