Class for one-dimensional sampled functions. More...

#include <1D1DFunction.h>

Inheritance diagram for QUESO::Sampled1D1DFunction:

Collaboration diagram for QUESO::Sampled1D1DFunction:

Public Member Functions
Constructor/Destructor methods
	Sampled1D1DFunction ()
	Default constructor. It should not be called by the user. More...

	Sampled1D1DFunction (const std::vector< double > &domainValues, const std::vector< double > &imageValues)
	Constructor. More...

virtual	~Sampled1D1DFunction ()
	Destructor. More...

Mathematical methods
virtual double	value (double domainValue) const
	Returns the value of the sampled function at point `domainValue`. More...

double	deriv (double domainValue) const
	Bogus: Derivative of the function. More...

const std::vector< double > &	domainValues () const
	Array of the domain values (values of the independent variable). More...

const std::vector< double > &	imageValues () const
	Array of the image values (values of the dependent variable). More...

bool	domainValueMatchesExactly (double domainValue) const
	Checks whether the domain value `domainValue` matches exactly one of the values in the function domain `domainValues()`. More...

void	set (const std::vector< double > &domainValues, const std::vector< double > &imageValues)
	Sets the values of the independent (`domainValues`) and dependent (`imageValues`) variables of this sampled function. More...

I/O methods
virtual void	printForMatlab (const BaseEnvironment &env, std::ofstream &ofsvar, const std::string &prefixName) const
	Prints the values of the function in Matlab/Octave format. More...

Public Member Functions inherited from QUESO::Base1D1DFunction
	Base1D1DFunction (double minDomainValue, double maxDomainValue)
	Default constructor. More...

virtual	~Base1D1DFunction ()
	Destructor. More...

double	minDomainValue () const
	Returns the minimum value of the domain of the (one-dimensional) function. More...

double	maxDomainValue () const
	Returns the maximum value of the domain of the (one-dimensional) function. More...

virtual double	multiplyAndIntegrate (const Base1D1DFunction &func, unsigned int quadratureOrder, double *resultWithMultiplicationByTAsWell) const
	TODO: Multiplies `this` function with `function`, and integrates it numerically. See template specialization. More...

Protected Attributes
std::vector< double >	m_domainValues
	Array of the values in the domain of the function (values of the independent variable). More...

std::vector< double >	m_imageValues
	Array of the values in the image of the function (values of the dependent variable). More...

Protected Attributes inherited from QUESO::Base1D1DFunction
double	m_minDomainValue

double	m_maxDomainValue

Detailed Description

Class for one-dimensional sampled functions.

This class implements sampled one-dimensional functions. A sample function is one whose values are known only at discrete values of the independent variable; i.e., its values are only known at grid points. There are several QUESO classes which handle grids, all derived from BaseOneDGrid. Sampled functions are usually defined by arrays.

Definition at line 347 of file 1D1DFunction.h.

Constructor & Destructor Documentation

QUESO::Sampled1D1DFunction::Sampled1D1DFunction ( )

Default constructor. It should not be called by the user.

Definition at line 427 of file 1D1DFunction.C.

   :
   Base1D1DFunction(-INFINITY,INFINITY)
 {
 
   //                    UQ_UNAVAILABLE_RANK,
   //                    "SampledD1DFunction::deriv()",
   //                    "invalid constructor");
 }

QUESO::Sampled1D1DFunction::Sampled1D1DFunction	(	const std::vector< double > &	domainValues,
		const std::vector< double > &	imageValues
	)

Constructor.

When calling this constructor, the user provides the values of the independent variable (domainValues) and their respective values in the image set (independent variable, imageValue)

Definition at line 437 of file 1D1DFunction.C.

References m_domainValues, and m_imageValues.

   :
   Base1D1DFunction(domainValues[0],domainValues[domainValues.size()-1]),
   m_domainValues    (domainValues.size(),0.),
   m_imageValues     (imageValues.size(), 0.)
 {
   unsigned int tmpSize = m_domainValues.size();
   for (unsigned int i = 0; i < tmpSize; ++i) {
     m_domainValues[i] = domainValues[i];
     m_imageValues [i] = imageValues [i];
   }
 }

QUESO::Sampled1D1DFunction::~Sampled1D1DFunction ( )

virtual

Destructor.

Definition at line 452 of file 1D1DFunction.C.

453 {

454 }

Member Function Documentation

double QUESO::Sampled1D1DFunction::deriv ( double domainValue ) const

virtual

Bogus: Derivative of the function.

Derivatives are not defined over sampled functions! Thus, this function simply checks if point domainValue belongs to the domain of this function, and in affirmative case, it returns 0.

Implements QUESO::Base1D1DFunction.

Definition at line 505 of file 1D1DFunction.C.

References QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, queso_error_msg, and queso_require_msg.

 {
   if ((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)) {
     std::cerr << "In Sampled1D1DFunction::deriv()"
               << ": requested x ("            << domainValue
               << ") is out of the interval (" << m_minDomainValue
               << ", "                         << m_maxDomainValue
               << ")"
               << std::endl;
   }
 
   queso_require_msg(!((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)), "x out of range");
 
   queso_error_msg("this function makes no sense for this class");
   return 0.;
 }

bool QUESO::Sampled1D1DFunction::domainValueMatchesExactly ( double domainValue ) const

Checks whether the domain value domainValue matches exactly one of the values in the function domain domainValues().

Definition at line 535 of file 1D1DFunction.C.

References m_domainValues.

 {
   bool result = false;
 
   unsigned int tmpSize = m_domainValues.size();
   for (unsigned int i = 0; i < tmpSize; ++i) {
     if (domainValue <= m_domainValues[i]) {
       result = (domainValue == m_domainValues[i]);
       break;
     }
   }
 
   return result;
 }

const std::vector< double > & QUESO::Sampled1D1DFunction::domainValues ( ) const

Array of the domain values (values of the independent variable).

Definition at line 523 of file 1D1DFunction.C.

References m_domainValues.

 {
   return m_domainValues;
 }

const std::vector< double > & QUESO::Sampled1D1DFunction::imageValues ( ) const

Array of the image values (values of the dependent variable).

Definition at line 529 of file 1D1DFunction.C.

References m_imageValues.

 {
   return m_imageValues;
 }

void QUESO::Sampled1D1DFunction::printForMatlab	(	const BaseEnvironment &	env,
		std::ofstream &	ofsvar,
		const std::string &	prefixName
	)		const

virtual

Prints the values of the function in Matlab/Octave format.

Definition at line 573 of file 1D1DFunction.C.

References m_domainValues, m_imageValues, and QUESO::BaseEnvironment::subIdString().

 {
   unsigned int tmpSize = m_domainValues.size();
   if (tmpSize == 0) {
     tmpSize = 1;
     ofsvar << "\n" << prefixName << "Time_sub" << env.subIdString() << " = zeros("  << tmpSize << ",1);"
            << "\n" << prefixName << "Value_sub" << env.subIdString() << " = zeros(" << tmpSize << ",1);";
   }
   else {
     ofsvar << "\n" << prefixName << "Time_sub" << env.subIdString() << " = zeros("  << tmpSize << ",1);"
            << "\n" << prefixName << "Value_sub" << env.subIdString() << " = zeros(" << tmpSize << ",1);";
     for (unsigned int i = 0; i < tmpSize; ++i) {
       ofsvar << "\n" << prefixName << "Time_sub" << env.subIdString() << "("  << i+1 << ",1) = " << m_domainValues[i] << ";"
              << "\n" << prefixName << "Value_sub" << env.subIdString() << "(" << i+1 << ",1) = " << m_imageValues[i]  << ";";
     }
   }
 
   return;
 }

void QUESO::Sampled1D1DFunction::set	(	const std::vector< double > &	domainValues,
		const std::vector< double > &	imageValues
	)

Sets the values of the independent (domainValues) and dependent (imageValues) variables of this sampled function.

Definition at line 551 of file 1D1DFunction.C.

References m_domainValues, m_imageValues, QUESO::Base1D1DFunction::m_maxDomainValue, and QUESO::Base1D1DFunction::m_minDomainValue.

 {
   m_domainValues.clear();
   m_imageValues.clear();
 
   unsigned int tmpSize = domainValues.size();
   m_minDomainValue = domainValues[0];
   m_maxDomainValue = domainValues[tmpSize-1];
 
   m_domainValues.resize(tmpSize,0.);
   m_imageValues.resize(tmpSize,0.);
   for (unsigned int i = 0; i < tmpSize; ++i) {
     m_domainValues[i] = domainValues[i];
     m_imageValues [i] = imageValues [i];
   }
 
   return;
 }

double QUESO::Sampled1D1DFunction::value ( double domainValue ) const

virtual

Returns the value of the sampled function at point domainValue.

This function checks if point domainValue belongs to the domain of this function, and in affirmative case, it looks for the image value associated to the domain value passed to the function. If there isn't any, it calculates a linear approximation for the image value of domainValue, considering its neighbors points in the domain.

Implements QUESO::Base1D1DFunction.

Definition at line 457 of file 1D1DFunction.C.

References m_domainValues, m_imageValues, QUESO::Base1D1DFunction::m_maxDomainValue, QUESO::Base1D1DFunction::m_minDomainValue, queso_require_greater_equal_msg, queso_require_msg, and queso_require_not_equal_to_msg.

 {
   if ((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)) {
     std::cerr << "In Sampled1D1DFunction::value()"
               << ": requested x ("            << domainValue
               << ") is out of the interval (" << m_minDomainValue
               << ", "                         << m_maxDomainValue
               << ")"
               << std::endl;
   }
 
   queso_require_msg(!((domainValue < m_minDomainValue) || (domainValue > m_maxDomainValue)), "x out of range");
 
   double returnValue = 0.;
 
   unsigned int tmpSize = m_domainValues.size();
   //std::cout << "In Sampled1D1DFunction::value()"
   //          << ": domainValue = "         << domainValue
   //          << ", tmpSize = "             << tmpSize
   //          << ", m_domainValues[0] = "   << m_domainValues[0]
   //          << ", m_domainValues[max] = " << m_domainValues[tmpSize-1]
   //          << std::endl;
 
   queso_require_not_equal_to_msg(tmpSize, 0, "m_domainValues.size() = 0");
 
   queso_require_greater_equal_msg(domainValue, m_domainValues[0], "domainValue < m_domainValues[0]");
 
   queso_require_greater_equal_msg(m_domainValues[tmpSize-1], domainValue, "m_domainValues[max] < domainValue");
 
   unsigned int i = 0;
   for (i = 0; i < tmpSize; ++i) {
     if (domainValue <= m_domainValues[i]) break;
   }
 
   if (domainValue == m_domainValues[i]) {
     //if (domainValueWasMatchedExactly) *domainValueWasMatchedExactly = true;
     returnValue = m_imageValues[i];
   }
   else {
     //if (domainValueWasMatchedExactly) *domainValueWasMatchedExactly = false;
     double ratio = (domainValue - m_domainValues[i-1])/(m_domainValues[i]-m_domainValues[i-1]);
     returnValue = m_imageValues[i-1] + ratio * (m_imageValues[i]-m_imageValues[i-1]);
   }
 
   return returnValue;
 }

Member Data Documentation

std::vector<double> QUESO::Sampled1D1DFunction::m_domainValues

protected

Array of the values in the domain of the function (values of the independent variable).

Definition at line 404 of file 1D1DFunction.h.

Referenced by domainValueMatchesExactly(), domainValues(), printForMatlab(), Sampled1D1DFunction(), set(), and value().

std::vector<double> QUESO::Sampled1D1DFunction::m_imageValues

protected

Array of the values in the image of the function (values of the dependent variable).

Definition at line 407 of file 1D1DFunction.h.

Referenced by imageValues(), printForMatlab(), Sampled1D1DFunction(), set(), and value().

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

src/misc/inc/1D1DFunction.h
src/misc/src/1D1DFunction.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation