Generate and return a scalar (or array of arbitrary rank of) random value(s) from the Geometric distribution.
More...
Generate and return a scalar (or array of arbitrary rank of) random value(s) from the Geometric distribution.
See the documentation of pm_distGeom for more details.
- Parameters
-
[in] | probSuccess | : The input scalar (or array of the same rank, shape, and size as other array-like arguments), of
-
type
real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
representing the probability of success parameter of the distribution.
|
- Returns
rand
: The output positive scalar (or array of the same rank, shape, and size as other array-like arguments), of the same type and kind as probSuccess
, containing random value(s) from the distribution.
Possible calling interfaces ⛓
Generate and return a scalar (or array of arbitrary rank of) random value(s) from the Geometric distr...
This module contains classes and procedures for computing various statistical quantities related to t...
- Warning
- The condition
0 < probSuccess .and. probSuccess <= 1
must hold for the corresponding input arguments.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1
.
- See also
- setGeomRand
Example usage ⛓
12 integer(IK),
parameter :: NP
= 1000_IK
13 integer(IK) :: rand(NP)
14 real(RKG) :: probSuccess(NP)
16 type(display_type) :: disp
19 call setLinSpace(probSuccess, x1
= 0.001_RKG, x2
= 1._RKG)
24 call disp%show(
"rand(1) = getGeomRand(probSuccess(1))")
33 call disp%show(
"rand(1:2) = getGeomRand(probSuccess(1))")
42 call disp%show(
"rand(1:2) = getGeomRand(probSuccess(1))")
49 call disp%show(
"probSuccess(NP-2:NP)")
50 call disp%show( probSuccess(NP
-2:NP) )
51 call disp%show(
"rand(NP-2:NP) = getGeomRand(probSuccess(NP-2:NP))")
62 integer(IK) :: fileUnit, i
63 integer(IK) ,
parameter :: NP
= 5000_IK
64 real(RKG) ,
parameter :: probSuccess(
4)
= [.
1_RKG, .
2_RKG, .
5_RKG, .
8_RKG]
65 open(newunit
= fileUnit, file
= "getGeomRand.IK.txt")
67 write(fileUnit,
"(*(g0,:,','))")
getGeomRand(probSuccess)
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 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 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...
integer, parameter RKS
The single-precision real kind in Fortran mode. On most platforms, this is an 32-bit real kind.
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 ⛓
24+0.998000026,
+0.999000013,
+1.00000000
Postprocessing of the example output ⛓
3import matplotlib.pyplot
as plt
17xlab = {
"CK" :
"Geometric Random Value ( real/imaginary components )"
18 ,
"IK" :
"Geometric Random Value ( integer-valued )"
19 ,
"RK" :
"Geometric Random Value ( real-valued )"
21legends = [
r"$\lambda = 0.1$"
27for kind
in [
"IK",
"CK",
"RK"]:
29 pattern =
"*." + kind +
".txt"
30 fileList = glob.glob(pattern)
31 if len(fileList) == 1:
33 df = pd.read_csv(fileList[0], delimiter =
",", header =
None)
35 fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
38 for j
in range(len(df.values[0,:])):
41 plt.hist( df.values[:,j]
42 , histtype =
"stepfilled"
45 , bins = range(min(data), max(data) + binwidth, binwidth)
48 plt.hist( df.values[:,j]
49 , histtype =
"stepfilled"
52 , bins = range(min(data), max(data) + binwidth, binwidth)
57 plt.xticks(fontsize = fontsize - 2)
58 plt.yticks(fontsize = fontsize - 2)
60 ax.set_xlabel(xlab[kind], fontsize = 17)
61 ax.set_ylabel(
"Count", fontsize = 17)
62 ax.set_title(
"Histograms of {} Geometric random values".format(len(df.values[:, 0])), fontsize = 17)
64 plt.grid(visible =
True, which =
"both", axis =
"both", color =
"0.85", linestyle =
"-")
65 ax.tick_params(axis =
"y", which =
"minor")
66 ax.tick_params(axis =
"x", which =
"minor")
68 plt.savefig(fileList[0].replace(
".txt",
".png"))
70 elif len(fileList) > 1:
72 sys.exit(
"Ambiguous file list exists.")
Visualization of the example output ⛓
- Test:
- test_pm_distGeom
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 772 of file pm_distGeom.F90.