Return the Probability Density Function (PDF) of the Raised Cosine distribution for an input x within the support of the distribution \(x \in [\mu - \sigma, \mu + \sigma]\).
More...
Return the Probability Density Function (PDF) of the Raised Cosine distribution for an input x within the support of the distribution \(x \in [\mu - \sigma, \mu + \sigma]\).
See the documentation of pm_distCosRaised for more information on the Raised Cosine distribution.
- Parameters
-
| [out] | pdf | : The output scalar or array of the same shape as any input array-like argument, of the same type and kind the input argument x, containing the PDF of the distribution.
|
| [in] | x | : The input scalar or array of the same shape as other array like arguments, of
-
type
real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
containing the value at which the PDF must be computed.
|
| [in] | mu | : The input scalar or array of the same shape as other array-like arguments, of the same type and kind the input argument x, containing the location parameter of the distribution.
(optional, default = \(0.\). It must be present if invSigma is also present.) |
| [in] | invSigma | : The input scalar or array of the same shape as other array-like arguments, of the same type and kind as x, containing the inverse of the scale parameter of the distribution.
(optional, default = \(1.\). It can be present only if mu is also present.) |
Possible calling interfaces ⛓
Return the Probability Density Function (PDF) of the Raised Cosine distribution for an input x within...
This module contains classes and procedures for computing various statistical quantities related to t...
- Warning
- The condition
0 < invSigma must hold for the corresponding input arguments.
The condition x >= mu - 1 / sigma must hold for the corresponding input arguments.
The condition x <= mu + 1 / sigma must hold for the corresponding input arguments.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
-
The
pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.
- See also
- setCosRaisedPDF
Example usage ⛓
15 integer(IK),
parameter :: NP
= 5_IK
16 real(RKG), dimension(NP) :: mu, invSigma, PDF
18 type(display_type) :: disp
22 call disp%show(
"!%%%%%%%%%%%%%%%%%%")
23 call disp%show(
"! The standard PDF.")
24 call disp%show(
"!%%%%%%%%%%%%%%%%%%")
28 call setLogSpace(invSigma, logx1
= log(
0.1_RKG), logx2
= log(
10._RKG))
31 call disp%show(
"call setCosRaisedPDF(PDF(1), 0._RKG)")
38 call disp%show(
"call setCosRaisedPDF(PDF(1:5), [real(RKG) :: -1., -.5, 0., .5, 1.])")
53 call disp%show(
"call setCosRaisedPDF(PDF(1), mu(1), mu(1))")
60 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
61 call disp%show(
"! PDF with a mean and a standard deviation.")
62 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
70 call disp%show(
"call setCosRaisedPDF(PDF(1:2), mu(1) .subadd. invSigma(1) / 2, mu(1), invSigma(1))")
71 call setCosRaisedPDF(PDF(
1:
2), mu(
1) .subadd. invSigma(
1)
/ 2, mu(
1), invSigma(
1))
77 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
78 call disp%show(
"! A vector of PDF at different points with the same mean and standard deviation.")
79 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
87 call disp%show(
"call setCosRaisedPDF(PDF(1:NP), getLinSpace(mu(1) - invSigma(1), mu(1) + invSigma(1), count = NP), mu(1), invSigma(1))")
94 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
95 call disp%show(
"! A vector of PDF at the same point but with different means and standard deviations.")
96 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
104 call disp%show(
"call setCosRaisedPDF(PDF(1:NP), mu(1:NP), mu(1:NP), invSigma(1:NP))")
111 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
112 call disp%show(
"! A vector of PDF at different points with different means and a standard deviations.")
113 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
121 call disp%show(
"call setCosRaisedPDF(PDF(1:NP), mu(1:NP), mu(1:NP), invSigma(1:NP))")
132 integer(IK) :: fileUnit, i, j
133 real(RKG) :: point(
1000), PDF(
4), mu(
4), invSigma(
4)
134 open(newunit
= fileUnit, file
= "setCosRaisedPDF.RK.txt")
135 call setLinSpace(point, x1
= -4._RKG, x2
= +4._RKG)
136 invSigma
= 1._RKG / [
+3._RKG,
+1._RKG,
+.
3_RKG,
1._RKG]
137 mu
= [
+0._RKG,
+0._RKG,
+0._RKG,
-2._RKG]
138 do i
= 1,
size(point)
140 if(point(i) .inrange. (mu(j) .subadd.
1._RKG / invSigma(j)))
then
146 write(fileUnit,
"(5(g0,:,' '))") point(i), PDF
Generate count evenly spaced points over the interval [x1, x2] if x1 < x2, or [x2,...
Return the linSpace output argument with size(linSpace) elements of evenly-spaced values over the int...
Return the logSpace output argument with size(logSpace) elements of logarithmically-evenly-spaced val...
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
This module contains procedures and generic interfaces for assessing whether particular value(s) or a...
This module contains procedures and generic interfaces for generating arrays with linear or logarithm...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter RK
The default real kind in the ParaMonte library: real64 in Fortran, c_double in C-Fortran Interoperati...
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
This module contains procedures and generic interfaces for evaluating the mathematical operator acti...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
14+0.0000000000000000,
+0.50000000000000000,
+1.0000000000000000,
+0.50000000000000000,
+0.0000000000000000
38call setCosRaisedPDF(PDF(
1:
2), mu(
1) .subadd. invSigma(
1)
/ 2, mu(
1), invSigma(
1))
40+0.99993831624083068E-1,
+0.99993831624083068E-1
54+0.99975328018286611E-1,
+0.99993831624083068E-1,
+0.10000000000000003,
+0.99993831624083068E-1,
+0.99975328018286611E-1
63-5.0000000000000000,
-2.5000000000000000,
+0.0000000000000000,
+2.5000000000000000,
+5.0000000000000000
65+0.10000000000000003,
+0.31622776601683800,
+1.0000000000000004,
+3.1622776601683813,
+10.000000000000002
68+0.10000000000000003,
+0.31622776601683800,
+1.0000000000000004,
+3.1622776601683813,
+10.000000000000002
77-5.0000000000000000,
-2.5000000000000000,
+0.0000000000000000,
+2.5000000000000000,
+5.0000000000000000
79+0.10000000000000003,
+0.31622776601683800,
+1.0000000000000004,
+3.1622776601683813,
+10.000000000000002
82+0.10000000000000003,
+0.31622776601683800,
+1.0000000000000004,
+3.1622776601683813,
+10.000000000000002
Postprocessing of the example output ⛓
3import matplotlib.pyplot
as plt
16xlab = {
"CK" :
"X ( real/imaginary components )"
17 ,
"IK" :
"X ( integer-valued )"
18 ,
"RK" :
"X ( real-valued )"
20legends = [
r"$\mu = 0.0,~\sigma = 2.00$"
21 ,
r"$\mu = 0.0,~\sigma = 1.00$"
22 ,
r"$\mu = 0.0,~\sigma = 0.50$"
23 ,
r"$\mu = 0.0,~\sigma = 0.25$"
26for kind
in [
"IK",
"CK",
"RK"]:
28 pattern =
"*." + kind +
".txt"
29 fileList = glob.glob(pattern)
30 if len(fileList) == 1:
32 df = pd.read_csv(fileList[0], delimiter =
" ")
34 fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
38 plt.plot( df.values[:, 0]
41 , linewidth = linewidth
44 plt.plot( df.values[:, 1]
47 , linewidth = linewidth
51 plt.plot( df.values[:, 0]
54 , linewidth = linewidth
61 plt.xticks(fontsize = fontsize - 2)
62 plt.yticks(fontsize = fontsize - 2)
63 ax.set_xlabel(xlab[kind], fontsize = 17)
64 ax.set_ylabel(
"Probability Density Function (PDF)", fontsize = 17)
66 plt.grid(visible =
True, which =
"both", axis =
"both", color =
"0.85", linestyle =
"-")
67 ax.tick_params(axis =
"y", which =
"minor")
68 ax.tick_params(axis =
"x", which =
"minor")
71 plt.savefig(fileList[0].replace(
".txt",
".png"))
73 elif len(fileList) > 1:
75 sys.exit(
"Ambiguous file list exists.")
Visualization of the example output ⛓
- Test:
- test_pm_distCosRaised
- Todo:
- Very Low Priority: This generic interface can be extended to
complex arguments.
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.
-
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.
-
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 332 of file pm_distCosRaised.F90.
1.9.3