QUESO::BasicPdfsBoost Class Reference

TODO: Base class for basic PDFs using Boost library. More...

#include <BasicPdfsBoost.h>

Inheritance diagram for QUESO::BasicPdfsBoost:

Collaboration diagram for QUESO::BasicPdfsBoost:

Public Member Functions
Constructor/Destructor methods
	BasicPdfsBoost ()
	Default constructor. More...
	BasicPdfsBoost (int worldRank)
	Constructor. More...
	~BasicPdfsBoost ()
	Destructor. More...
Mathematical methods
double	betaPdfActualValue (double x, double alpha, double beta) const
	TODO: Actual value of the Beta PDF. More...
double	gammaPdfActualValue (double x, double a, double b) const
	TODO: Actual value of the Gamma PDF. More...
Public Member Functions inherited from QUESO::BasicPdfsBase
	BasicPdfsBase ()
	Default constructor. More...
	BasicPdfsBase (int worldRank)
	Constructor. More...
virtual	~BasicPdfsBase ()
	Virtual destructor. More...

Additional Inherited Members
Protected Attributes inherited from QUESO::BasicPdfsBase
int	m_worldRank

Detailed Description

TODO: Base class for basic PDFs using Boost library.

Todo:

This class will acommodate the definition of a Joint PDF using distributions available in the Boost library. It will ultimately be called by BaseJointPdf and/or its derived classes (via m_env.basicPdfs()) during the construction of Joint PDFs.

Definition at line 45 of file BasicPdfsBoost.h.

Constructor & Destructor Documentation

QUESO::BasicPdfsBoost::BasicPdfsBoost

(

)

Default constructor.

Definition at line 31 of file BasicPdfsBoost.C.

References QUESO::BasicPdfsBase::m_worldRank, and UQ_FATAL_TEST_MACRO.

  :
  BasicPdfsBase()
{
  UQ_FATAL_TEST_MACRO(true,
                      m_worldRank,
                      "BasicPdfsBoost::constructor(), default",
                      "should not be used by user");
}

QUESO::BasicPdfsBoost::BasicPdfsBoost

(

int

worldRank

)

Constructor.

Constructor ------------------------—.

Definition at line 42 of file BasicPdfsBoost.C.

  :
  BasicPdfsBase(worldRank)
{
}

QUESO::BasicPdfsBoost::~BasicPdfsBoost

(

)

Destructor.

Definition at line 49 of file BasicPdfsBoost.C.

{
  //this function does nothing
}

Member Function Documentation

double QUESO::BasicPdfsBoost::betaPdfActualValue ( double  x, double  alpha, double  beta  ) const

virtual

TODO: Actual value of the Beta PDF.

Implements QUESO::BasicPdfsBase.

Definition at line 56 of file BasicPdfsBoost.C.

References QUESO::BasicPdfsBase::m_worldRank, and UQ_FATAL_TEST_MACRO.

{
  UQ_FATAL_TEST_MACRO(true,
                      m_worldRank,
                      "BasicPdfsBoost::betaPdfActualValue()",
                      "code incomplete yet");
  return 0.;
}

double QUESO::BasicPdfsBoost::gammaPdfActualValue ( double  x, double  a, double  b  ) const

virtual

TODO: Actual value of the Gamma PDF.

Implements QUESO::BasicPdfsBase.

Definition at line 67 of file BasicPdfsBoost.C.

References QUESO::BasicPdfsBase::m_worldRank, and UQ_FATAL_TEST_MACRO.

{
  UQ_FATAL_TEST_MACRO(true,
                      m_worldRank,
                      "BasicPdfsBoost::gammaPdfActualValue()",
                      "code incomplete yet");
  return 0.;
}

---

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

• src/core/inc/BasicPdfsBoost.h
• src/core/src/BasicPdfsBoost.C