pm_quadPack::wcauchy_type Interface Reference

This is the derived type for constructing objects that signify the computation of the Cauchy Principal Value of arbitrary function whose Cauchy singularities is stored in the cs components of the objects of this type.
More...

Public Attributes
real(RKH)	cs
	The scalar component of type real of kind RKH (the highest (precision) real kind available in the ParaMonte library, representing the point of singularity in the Cauchy weight of an integrand function: \(\frac{1}{x - \ms{cs}}\). More...

Detailed Description

This is the derived type for constructing objects that signify the computation of the Cauchy Principal Value of arbitrary function whose Cauchy singularities is stored in the cs components of the objects of this type.

Return an object of type wcauchy_type containing the Cauchy singularity of a weight of the form,.

The Cauchy type of singularity represented by this derived type has the form,

\begin{equation} \frac{1}{(x - c)} ~,~ x \in (\ms{lb}, \ms{ub}) ~,~ \ms{lb} < 0 < \ms{ub} \end{equation}

where \((\ms{lb}, \ms{ub})\) represent the integration bounds.

Objects of this derived type can be passed to the primary integrators of the parent modules of this derived type:

1. getQuadErr
   
2. isFailedQuad
   

Possible calling interfaces ⛓

use pm_quadPack, only: wcauchy_type
type(wcauchy_type) :: wcauchy
 
wcauchy = wcauchy_type(cs)

Remarks

The procedures under discussion are pure.

See also

getQuadErr.
isFailedQuad.

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

\begin{equation} \frac{1}{(x - c)} ~,~ x \in (\ms{lb}, \ms{ub}) ~,~ \ms{lb} < 0 < \ms{ub} \end{equation}

where \((\ms{lb}, \ms{ub})\) represent the integration bounds.

Developer Remark:

This generic interface exists because of the lack of support for PDTs in gfortran, requiring the derived type wcauchy_type to have cs component with the highest precision.

Parameters

[in]

cs

: The input scalar of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), containing the Cauchy singularity.

Returns

wcauchy : The output scalar object of type wcauchy_type containing the Cauchy singularity.

Possible calling interfaces ⛓

use pm_quadPack, only: wcauchy_type
type(wcauchy_type) :: wcauchy
 
wcauchy = wcauchy_type(cs)

Remarks

The procedures under discussion are pure.

See also

getQuadErr
isFailedQuad
wcauchy_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 193 of file pm_quadPack.F90.

Member Data Documentation

cs

real(RKH) pm_quadPack::wcauchy_type::cs

The scalar component of type real of kind RKH (the highest (precision) real kind available in the ParaMonte library, representing the point of singularity in the Cauchy weight of an integrand function: \(\frac{1}{x - \ms{cs}}\).

Definition at line 194 of file pm_quadPack.F90.

---

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

• src/fortran/main/pm_quadPack.F90