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

Generate and return a scalar or array of rank 1 of length size or the same rank and size as p of Bernoulli-distributed random values (0 or 1) with probability of getting 1 set by the input success probability p.
More...

Detailed Description

Generate and return a scalar or array of rank 1 of length size or the same rank and size as p of Bernoulli-distributed random values (0 or 1) with probability of getting 1 set by the input success probability p.

Parameters
[in]p: The input scalar or array of arbitrary rank of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), representing the probability of success/yes/true. It must be a number between 0 and 1. It must be scalar if the input argument size is present.
[in]size: The input scalar of type integer of default kind IK, representing the size of the output rand vector.
(optional, if present, then p must be a scalar.)
Returns
rand : The output scalar or vector of length size, or array of the same shape as the input p of type integer of default kind IK, containing the Bernoulli-distributed random output value.


Possible calling interfaces

rand = getBernRand(p) ! elemental
rand(1:size) = getBernRand(p, size) ! non-elemental
!
Generate and return a scalar or array of rank 1 of length size or the same rank and size as p of Bern...
This module contains classes and procedures for generating Bernoulli-distributed random numbers.
Definition: pm_distBern.F90:39
Warning
The input value for p must be a number between 0 and 1.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
Remarks
The procedures under discussion are impure.
The procedures under discussion are elemental. The procedures under this generic interface are not elemental when the size argument is present.
See also
isHead
setBernRand
getUnifRand
setUnifRand


Example usage

1program example
2
3 use pm_kind, only: SK, IK, LK
4 use pm_kind, only: RK, RKS, RKD, RKH
5 use pm_io, only: display_type
6 use pm_distBern, only: getBernRand
7
8 implicit none
9
10 integer(IK) , parameter :: NP = 5_IK
11 real(RKS) :: rand_RKS(NP)
12 real(RKD) :: rand_RKD(NP)
13 real(RKH) :: rand_RKH(NP)
14 type(display_type) :: disp
15
16 disp = display_type(file = "main.out.F90")
17
18 call disp%skip()
19 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
20 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
21 call disp%show("! Generate `real`-valued random numbers.")
22 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
23 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
24 call disp%skip()
25
26 call disp%skip()
27 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
28 call disp%show("! Generate a scalar real random number.")
29 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
30 call disp%skip()
31
32 call disp%show("rand_RKS(1) = getBernRand(p = 0.5_RKS) ! 0.5 odds of success.")
33 rand_RKS(1) = getBernRand(p = 0.5_RKS)
34 call disp%show("rand_RKS(1)")
35 call disp%show( rand_RKS(1) )
36 call disp%skip()
37
38 call disp%show("rand_RKD(1) = getBernRand(p = 0.5_RKD)")
39 rand_RKD(1) = getBernRand(p = 0.5_RKD)
40 call disp%show("rand_RKD(1)")
41 call disp%show( rand_RKD(1) )
42 call disp%skip()
43
44 call disp%show("rand_RKH(1) = getBernRand(p = 0.5_RKH)")
45 rand_RKH(1) = getBernRand(p = 0.5_RKH)
46 call disp%show("rand_RKH(1)")
47 call disp%show( rand_RKH(1) )
48 call disp%skip()
49
50 call disp%skip()
51 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
52 call disp%show("! Generate a vector of real random numbers.")
53 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
54 call disp%skip()
55
56 call disp%show("rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP) ! 0.5 odds of success.")
57 rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP)
58 call disp%show("rand_RKS(:)")
59 call disp%show( rand_RKS(:) )
60 call disp%skip()
61
62 call disp%show("rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)")
63 rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)
64 call disp%show("rand_RKD(:)")
65 call disp%show( rand_RKD(:) )
66 call disp%skip()
67
68 call disp%show("rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)")
69 rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)
70 call disp%show("rand_RKH(:)")
71 call disp%show( rand_RKH(:) )
72 call disp%skip()
73
74end program example
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 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 RKD
The double precision real kind in Fortran mode. On most platforms, this is an 64-bit real kind.
Definition: pm_kind.F90:568
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 RKH
The scalar integer constant of intrinsic default kind, representing the highest-precision real kind t...
Definition: pm_kind.F90:858
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
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
2!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4! Generate `real`-valued random numbers.
5!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7
8
9!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10! Generate a scalar real random number.
11!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12
13rand_RKS(1) = getBernRand(p = 0.5_RKS) ! 0.5 odds of success.
14rand_RKS(1)
15+0.00000000
16
17rand_RKD(1) = getBernRand(p = 0.5_RKD)
18rand_RKD(1)
19+0.0000000000000000
20
21rand_RKH(1) = getBernRand(p = 0.5_RKH)
22rand_RKH(1)
23+0.00000000000000000000000000000000000
24
25
26!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27! Generate a vector of real random numbers.
28!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29
30rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP) ! 0.5 odds of success.
31rand_RKS(:)
32+1.00000000, +0.00000000, +0.00000000, +0.00000000, +1.00000000
33
34rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)
35rand_RKD(:)
36+1.0000000000000000, +1.0000000000000000, +0.0000000000000000, +1.0000000000000000, +0.0000000000000000
37
38rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)
39rand_RKH(:)
40+1.00000000000000000000000000000000000, +1.00000000000000000000000000000000000, +0.00000000000000000000000000000000000, +1.00000000000000000000000000000000000, +0.00000000000000000000000000000000000
41
42
Test:
test_pm_distBern


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 357 of file pm_distBern.F90.


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