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

Generate and return the natural logarithm of the Probability Mass Function (PMF) of the Cyclic Geometric distribution for an input stepSuccess within the discrete integer support of the distribution \([0, \ms{period}]\). More...

Detailed Description

Generate and return the natural logarithm of the Probability Mass Function (PMF) of the Cyclic Geometric distribution for an input stepSuccess within the discrete integer support of the distribution \([0, \ms{period}]\).

Parameters
[in]stepSuccess: The input positive scalar (or array of the same rank, shape, and size as other array-like arguments), of
  1. type real of the same kind as that of probSuccess,
  2. type integer of default kind IK,
containing the values at which the PMF must be computed.
Note that stepSuccess represents the Bernoulli trial step at which the first success occurs.
As such, it must never exceed the value of the input argument period.
[in]probSuccess: 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),
containing the probability of success at each Bernoulli step.
[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.
Returns
logPMF : The output scalar (or array of the same rank, shape, and size as other array-like arguments), of the same type and kind as probSuccess, containing the natural logarithm of the PMF of the distribution at the specified point stepSuccess.


Possible calling interfaces

logPMF = getGeomCyclicLogPMF(stepSuccess, probSuccess, period)
Generate and return the natural logarithm of the Probability Mass Function (PMF) of the Cyclic Geomet...
This module contains classes and procedures for computing various statistical quantities related to t...
Warning
The condition 0. < probSuccess must hold for the corresponding input arguments.
The condition probSuccess <= 1 must hold for the corresponding input arguments.
The condition 1 <= stepSuccess must hold for the corresponding input arguments.
The condition stepSuccess <= period 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
getGeomCyclicLogCDF
setGeomCyclicLogCDF
getGeomCyclicLogPMF
setGeomCyclicLogPMF


Example usage

1program example
2
3 use pm_kind, only: SK, IK, LK
4 use pm_kind, only: RKG => RK ! all processor kinds are supported.
5 use pm_io, only: display_type
7
8 implicit none
9
10 type(display_type) :: disp
11 disp = display_type(file = "main.out.F90")
12
13 call disp%skip()
14 call disp%show("getGeomCyclicLogPMF(1_IK, probSuccess = .5_RKG, period = 2_IK)")
15 call disp%show( getGeomCyclicLogPMF(1_IK, probSuccess = .5_RKG, period = 2_IK) )
16 call disp%skip()
17
18 call disp%skip()
19 call disp%show("getGeomCyclicLogPMF(2_IK, probSuccess = .5_RKG, period = 2_IK)")
20 call disp%show( getGeomCyclicLogPMF(2_IK, probSuccess = .5_RKG, period = 2_IK) )
21 call disp%skip()
22
23 call disp%skip()
24 call disp%show("getGeomCyclicLogPMF(2_IK, probSuccess = .2_RKG, period = 2_IK)")
25 call disp%show( getGeomCyclicLogPMF(2_IK, probSuccess = .2_RKG, period = 2_IK) )
26 call disp%skip()
27
28 call disp%skip()
29 call disp%show("getGeomCyclicLogPMF([integer(IK) :: 1, 2, 3], probSuccess = .9_RKG, period = 3_IK)")
30 call disp%show( getGeomCyclicLogPMF([integer(IK) :: 1, 2, 3], probSuccess = .9_RKG, period = 3_IK) )
31 call disp%skip()
32
33 call disp%skip()
34 call disp%show("getGeomCyclicLogPMF([integer(IK) :: 1, 2, 3, 4], probSuccess = [0.01_RKG, 0.1_RKG, .1_RKG, 1._RKG], period = 10_IK)")
35 call disp%show( getGeomCyclicLogPMF([integer(IK) :: 1, 2, 3, 4], probSuccess = [0.01_RKG, 0.1_RKG, .1_RKG, 1._RKG], period = 10_IK) )
36 call disp%skip()
37
38 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
39 ! Output an example array for visualization.
40 !%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
41
42 block
43
44 use pm_arrayRange, only: getRange
45 integer(IK), allocatable :: count(:)
46 integer :: fileUnit, i
47
48 count = getRange(1_IK, 10_IK)
49 open(newunit = fileUnit, file = "getGeomCyclicLogPMF.IK.txt")
50 do i = 1, size(count)
51 write(fileUnit, "(*(g0,:,','))") count(i), exp(getGeomCyclicLogPMF(count(i), [.05_RKG, .25_RKG, .05_RKG, .25_RKG], period = [10_IK, 10_IK, 10000_IK, 10000_IK]))
52 end do
53 close(fileUnit)
54
55 end block
56
57end program example
Generate minimally-spaced character, integer, real sequences or sequences at fixed intervals of size ...
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 ranges of discrete character,...
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
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter RK
The default real kind in the ParaMonte library: real64 in Fortran, c_double in C-Fortran Interoperati...
Definition: pm_kind.F90:543
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
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
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
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
2getGeomCyclicLogPMF(1_IK, probSuccess = .5_RKG, period = 2_IK)
3-0.40546510810816438
4
5
6getGeomCyclicLogPMF(2_IK, probSuccess = .5_RKG, period = 2_IK)
7-1.0986122886681096
8
9
10getGeomCyclicLogPMF(2_IK, probSuccess = .2_RKG, period = 2_IK)
11-0.81093021621632855
12
13
14getGeomCyclicLogPMF([integer(IK) :: 1, 2, 3], probSuccess = .9_RKG, period = 3_IK)
15-0.10436001532424274, -2.4069451083182885, -4.7095302013123330
16
17
18getGeomCyclicLogPMF([integer(IK) :: 1, 2, 3, 4], probSuccess = [0.01_RKG, 0.1_RKG, .1_RKG, 1._RKG], period = 10_IK)
19-2.2577752093953025, -1.9791937975453833, -2.0845543132032098, -709.78271289338397
20
21

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
9fontsize = 17
10
11kind = "IK"
12label = [ r"probSuccess = .05, period = 10"
13 , r"probSuccess = .25, period = 10"
14 , r"probSuccess = .05, period = 10000"
15 , r"probSuccess = .25, period = 10000"
16 ]
17
18pattern = "*." + kind + ".txt"
19fileList = glob.glob(pattern)
20if len(fileList) == 1:
21
22 df = pd.read_csv(fileList[0], delimiter = ",", header = None)
23
24 fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
25 ax = plt.subplot()
26
27 for i in range(1,len(df.values[0,:]+1)):
28
29 plt.plot( df.values[:, 0]
30 , df.values[:,i]
31 , marker = "."
32 )
33
34 plt.xticks(fontsize = fontsize - 2)
35 plt.yticks(fontsize = fontsize - 2)
36 ax.set_xlim([0, None])
37 ax.set_xlabel("stepSuccess", fontsize = fontsize)
38 ax.set_ylabel("PMF", fontsize = fontsize)
39
40 plt.grid(visible = True, which = "both", axis = "both", color = "0.85", linestyle = "-")
41 ax.tick_params(axis = "y", which = "minor")
42 ax.tick_params(axis = "x", which = "minor")
43
44 ax.legend ( label
45 , fontsize = fontsize
46 #, loc = "center left"
47 #, bbox_to_anchor = (1, 0.5)
48 )
49
50 plt.savefig(fileList[0].replace(".txt",".png"))
51
52else:
53
54 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, Monday March 6, 2017, 3:22 pm, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin.

Definition at line 198 of file pm_distGeomCyclic.F90.


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