pm_quadTest::intGenExpGammaPDF_type Type Reference

This is the derived type for generating test integrand objects of the Probability Density Function of the GenExpGamma distribution. More...

Inheritance diagram for pm_quadTest::intGenExpGammaPDF_type:

Collaboration diagram for pm_quadTest::intGenExpGammaPDF_type:

Public Member Functions
procedure	get => getIntGenExpGammaPDF
Public Member Functions inherited from pm_quadTest::integrand_type
procedure(get_proc), deferred	get
	The function member returning the value of the unweighted integrand (whether Cauchy/sin/cos/algebraically types of weights) at a specified input point x. More...

Public Attributes
real(RKH)	kappa
	The shape parameter of the GenExpGamma distribution. More...
real(RKH)	invOmega
	The inverse of the scale parameter of the GenExpGamma distribution. More...
real(RKH)	logSigma
	The location parameter of the GenExpGamma distribution. More...
real(RKH)	logPDFNF
	The natural logarithm of the normalization factor of the GenExpGamma distribution. More...
Public Attributes inherited from pm_quadTest::integrand_type
real(RKH)	lb
	The scalar of type real of the highest kind supported by the library RKH, containing the lower limit of integration. More...
real(RKH)	ub
	The scalar of type real of the highest kind supported by the library RKH, containing the upper limit of integration. More...
real(RKH)	integral
	The scalar of type real of the highest kind supported by the library RKH, containing the true result of integration. More...
real(RKH), dimension(:), allocatable	break
	The scalar of type real of the highest kind supported by the library RKH, containing the points of difficulties of integration. More...
type(wcauchy_type), allocatable	wcauchy
	The scalar of type wcauchy_type, containing the Cauchy singularity of the integrand. More...
character(:, SK), allocatable	desc
	The scalar allocatable character of default kind SK containing a description of the integrand and integration limits and difficulties. More...

Detailed Description

This is the derived type for generating test integrand objects of the Probability Density Function of the GenExpGamma distribution.

The full integrand is the PDF of the GenExpGamma distribution as defined in the documentation of pm_distGenExpGamma, with an integral value of 1 over its full support \(x \in (-\infty, +\infty)\).

Parameters

[in]	lb	: The input scalar of type real of kind RKH, containing the lower limit of integration. (optional, default = getInfNeg(real(0,kind(lb)))
[in]	ub	: The input scalar of the same type and kind as lb, containing the upper limit of integration. (optional, default = getInfPos(real(0,kind(ub)))
[in]	kappa	: The input scalar of the same type and kind as lb, representing the shape parameter of the GenExpGamma distribution. (optional, default = 1.)
[in]	invOmega	: The input scalar of the same type and kind as lb, representing the inverse of the scale parameter of the GenExpGamma distribution. (optional, default = 1.)
[in]	logSigma	: The input scalar of the same type and kind as lb, representing the location parameter of the GenExpGamma distribution. (optional, default = 0)

Possible calling interfaces ⛓

use pm_quadTest, only: intGenExpGammaPDF_type
type(intGenExpGammaPDF_type) :: integrand
 
integrand = intGenExpGammaPDF_type(lb = lb, ub = ub, kappa = kappa, invOmega = invOmega, logSigma = logSigma)
print *, "description: ", integrand%desc
print *, "lower limit: ", integrand%lb
print *, "upper limit: ", integrand%ub
print *, "Example integrand value: ", integrand%get(x)

See also

integrand_type

Test:

test_pm_quadPack

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Oct 16, 2009, 11:14 AM, Michigan

Definition at line 1349 of file pm_quadTest.F90.

Member Function/Subroutine Documentation

get()

procedure pm_quadTest::intGenExpGammaPDF_type::get

Definition at line 1355 of file pm_quadTest.F90.

References pm_kind::RKH.

Member Data Documentation

invOmega

real(RKH) pm_quadTest::intGenExpGammaPDF_type::invOmega

The inverse of the scale parameter of the GenExpGamma distribution.

Definition at line 1351 of file pm_quadTest.F90.

kappa

real(RKH) pm_quadTest::intGenExpGammaPDF_type::kappa

The shape parameter of the GenExpGamma distribution.

Definition at line 1350 of file pm_quadTest.F90.

logPDFNF

real(RKH) pm_quadTest::intGenExpGammaPDF_type::logPDFNF

The natural logarithm of the normalization factor of the GenExpGamma distribution.

Definition at line 1353 of file pm_quadTest.F90.

logSigma

real(RKH) pm_quadTest::intGenExpGammaPDF_type::logSigma

The location parameter of the GenExpGamma distribution.

Definition at line 1352 of file pm_quadTest.F90.

---

The documentation for this type was generated from the following file:

• src/fortran/main/pm_quadTest.F90