ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_distGeomCyclic::setGeomCyclicRand Interface Reference

Return a scalar (or array of arbitrary rank of) random value(s) from the Cyclic Geometric distribution.
More...

Detailed Description

Return a scalar (or array of arbitrary rank of) random value(s) from the Cyclic Geometric distribution.

See the documentation of pm_distGeomCyclic for more details.

Parameters
[in,out]rng: The input/output scalar that can be an object of,
  1. type rngf_type, implying the use of intrinsic Fortran uniform RNG.
  2. type xoshiro256ssw_type, implying the use of xoshiro256** uniform RNG.
(optional, default = rngf_type, implying the use of the intrinsic Fortran URNG.)
[out]rand: The output scalar or
  1. array of rank 1, or
  2. array of arbitrary rank if the rng argument is missing or set to rngf_type,
of type integer of default kind IK, containing the Poisson-distributed random value(s).
[in]logProbFailure: The input scalar (or array of the same rank, shape, and size as other array-like arguments), of
  1. type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
representing the natural logarithm of the probability of failure(s) log(1 - probSuccess, period) of the distribution(s).
[in]period: The input positive scalar (or array of the same rank, shape, and size as other array-like arguments), of
type integer of default kind IK, containing the period of the Cyclic Geometric distribution.
The period represents the maximum number of Bernoulli trials in the experiment.


Possible calling interfaces

use pm_kind, only: IK
integer(IK) :: rand
call setGeomCyclicRand(rand, logProbFailure, period) ! elemental
call setGeomCyclicRand(rng, rand, logProbFailure, period)
call setGeomCyclicRand(rng, rand(:), logProbFailure(:), period)
Return a scalar (or array of arbitrary rank of) random value(s) from the Cyclic Geometric distributio...
This module contains classes and procedures for computing various statistical quantities related to t...
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
Warning
The condition 0 < period must hold for the corresponding input arguments.
The condition logProbFailure < 0. 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.
Remarks
The procedures under discussion are elemental.
See also
getGeomCyclicRand


Example usage

1program example
2
3 use pm_kind, only: SK, IK
4 use pm_kind, only: RKG => RKS ! all real kinds are supported.
9 use pm_io, only: display_type
10
11 implicit none
12
13 type(xoshiro256ssw_type) :: rng
14 integer(IK), parameter :: NP = 1000_IK
15 integer(IK) :: rand(NP)
16 real(RKG) :: logProbFailure(NP)
17
18 type(display_type) :: disp
19 disp = display_type(file = "main.out.F90")
20
21 logProbFailure = log(1 - getLinSpace(x1 = 0.001_RKG, x2 = .999_RKG, count = NP))
22
23 call disp%skip()
24 call disp%show("logProbFailure(1)")
25 call disp%show( logProbFailure(1) )
26 call disp%show("call setGeomCyclicRand(rand(1), logProbFailure(1), period = 10_IK)")
27 call setGeomCyclicRand(rand(1), logProbFailure(1), period = 10_IK)
28 call disp%show("rand(1)")
29 call disp%show( rand(1) )
30 call disp%skip()
31
32 call disp%skip()
33 call disp%show("logProbFailure(1)")
34 call disp%show( logProbFailure(1) )
35 call disp%show("rng = xoshiro256ssw_type()")
36 rng = xoshiro256ssw_type()
37 call disp%show("call setGeomCyclicRand(rng, rand(1:2), logProbFailure(1), period = 10_IK)")
38 call setGeomCyclicRand(rng, rand(1:2), logProbFailure(1), period = 10_IK)
39 call disp%show("rand(1:2)")
40 call disp%show( rand(1:2) )
41 call disp%skip()
42
43 call disp%skip()
44 call disp%show("logProbFailure(1)")
45 call disp%show( logProbFailure(1) )
46 call disp%show("call setGeomCyclicRand(rand(1:2), logProbFailure(1), period = 100_IK)")
47 call setGeomCyclicRand(rand(1:2), logProbFailure(1), period = 100_IK)
48 call disp%show("rand(1:2)")
49 call disp%show( rand(1:2) )
50 call disp%skip()
51
52 call disp%skip()
53 call disp%show("logProbFailure(NP-2:NP)")
54 call disp%show( logProbFailure(NP-2:NP) )
55 call disp%show("call setGeomCyclicRand(rand(NP-2:NP), logProbFailure(NP-2:NP), period = 100_IK)")
56 call setGeomCyclicRand(rand(NP-2:NP), logProbFailure(NP-2:NP), period = 100_IK)
57 call disp%show("rand(NP-2:NP)")
58 call disp%show( rand(NP-2:NP) )
59 call disp%skip()
60
61 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62 ! Output an example rand array for visualization.
63 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
64
65 block
66
67 integer :: fileUnit, i
68 integer(IK) :: rand(4)
69 open(newunit = fileUnit, file = "setGeomCyclicRand.IK.txt")
70 do i = 1, 5000
71 call setGeomCyclicRand(rand, log(1 - [.05_RKG, .25_RKG, .05_RKG, .25_RKG]), period = [10_IK, 10_IK, 10000_IK, 10000_IK])
72 write(fileUnit, "(*(g0,:,','))") rand
73 end do
74 close(fileUnit)
75
76 end block
77
78end program example
Generate count evenly spaced points over the interval [x1, x2] if x1 < x2, or [x2,...
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.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains procedures and generic interfaces for generating arrays with linear or logarithm...
This module contains classes and procedures for computing various statistical quantities related to t...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
integer, parameter RKS
The single-precision real kind in Fortran mode. On most platforms, this is an 32-bit real kind.
Definition: pm_kind.F90:567
This is the derived type for declaring and generating objects of type xoshiro256ssw_type containing a...
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
2logProbFailure(1)
3-0.100048748E-2
4call setGeomCyclicRand(rand(1), logProbFailure(1), period = 10_IK)
5rand(1)
6+3
7
8
9logProbFailure(1)
10-0.100048748E-2
12call setGeomCyclicRand(rng, rand(1:2), logProbFailure(1), period = 10_IK)
13rand(1:2)
14+5, +7
15
16
17logProbFailure(1)
18-0.100048748E-2
19call setGeomCyclicRand(rand(1:2), logProbFailure(1), period = 100_IK)
20rand(1:2)
21+62, +48
22
23
24logProbFailure(NP-2:NP)
25-5.80981159, -6.21509790, -6.90776825
26call setGeomCyclicRand(rand(NP-2:NP), logProbFailure(NP-2:NP), period = 100_IK)
27rand(NP-2:NP)
28+1, +1, +1
29
30

Postprocessing of the example output
1#!/usr/bin/env python
2
3import matplotlib.pyplot as plt
4import pandas as pd
5import numpy as np
6import glob
7import sys
8
9linewidth = 2
10fontsize = 17
11
12marker ={ "CK" : "-"
13 , "IK" : "."
14 , "RK" : "-"
15 }
16xlab = { "CK" : "Cyclic Geometric Random Value ( real/imaginary components )"
17 , "IK" : "Cyclic Geometric Random Value ( integer-valued )"
18 , "RK" : "Cyclic Geometric Random Value ( real-valued )"
19 }
20label = [ r"probSuccess = .05, period = 10"
21 , r"probSuccess = .25, period = 10"
22 , r"probSuccess = .05, period = 10000"
23 , r"probSuccess = .25, period = 10000"
24 ]
25
26for kind in ["IK", "CK", "RK"]:
27
28 pattern = "*." + kind + ".txt"
29 fileList = glob.glob(pattern)
30 if len(fileList) == 1:
31
32 df = pd.read_csv(fileList[0], delimiter = ",", header = None)
33
34 fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
35 ax = plt.subplot()
36
37 for j in range(len(df.values[0,:])):
38 if kind == "CK":
39 plt.hist( df.values[:,j]
40 , histtype = "stepfilled"
41 , density = False
42 , alpha = 0.5
43 , bins = 75
44 )
45 else:
46 plt.hist( df.values[:,j]
47 , histtype = "stepfilled"
48 , density = False
49 , alpha = 0.5
50 , bins = 75
51 )
52 ax.legend ( label
53 , fontsize = fontsize
54 )
55 plt.xticks(fontsize = fontsize - 2)
56 plt.yticks(fontsize = fontsize - 2)
57 ax.set_xlim(0, 10)
58 ax.set_xlabel(xlab[kind], fontsize = 17)
59 ax.set_ylabel("Count", fontsize = 17)
60 ax.set_title("Histograms of {} Cyclic Geometric random values".format(len(df.values[:, 0])), fontsize = 17)
61
62 plt.grid(visible = True, which = "both", axis = "both", color = "0.85", linestyle = "-")
63 ax.tick_params(axis = "y", which = "minor")
64 ax.tick_params(axis = "x", which = "minor")
65
66 plt.savefig(fileList[0].replace(".txt",".png"))
67
68 elif len(fileList) > 1:
69
70 sys.exit("Ambiguous file list exists.")

Visualization of the example output
Test:
test_pm_distGeomCyclic


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.

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

Definition at line 2049 of file pm_distGeomCyclic.F90.


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