Generate and return a scalar or array of rank 1
of length size
or the same rank and size as p
of Bernoullidistributed 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 Bernoullidistributed random output value.
Possible calling interfaces ⛓
!
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 Bernoullidistributed random numbers.
 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
.
 See also
 isHead
setBernRand
getUnifRand
setUnifRand
Example usage ⛓
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
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(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
27 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
28 call disp%show(
"! Generate a scalar real random number.")
29 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
32 call disp%show(
"rand_RKS(1) = getBernRand(p = 0.5_RKS) ! 0.5 odds of success.")
38 call disp%show(
"rand_RKD(1) = getBernRand(p = 0.5_RKD)")
44 call disp%show(
"rand_RKH(1) = getBernRand(p = 0.5_RKH)")
51 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
52 call disp%show(
"! Generate a vector of real random numbers.")
53 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
56 call disp%show(
"rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP) ! 0.5 odds of success.")
62 call disp%show(
"rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)")
68 call disp%show(
"rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)")
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 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 typeparameters frequently used in the ParaMonte librar...
integer, parameter RK
The default real kind in the ParaMonte library: real64 in Fortran, c_double in CFortran Interoperati...
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in CFortran Interoper...
integer, parameter RKD
The double precision real kind in Fortran mode. On most platforms, this is an 64bit real kind.
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in CFortran Intero...
integer, parameter RKH
The scalar integer constant of intrinsic default kind, representing the highestprecision real kind t...
integer, parameter RKS
The singleprecision real kind in Fortran mode. On most platforms, this is an 32bit real kind.
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort fpp standardsemantics 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 /standardsemantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran cpp ffreelinelengthnone O3 Wl,rpath,../../../lib I../../../inc main.F90 ../../../lib/libparamonte* o main.exe
Example output ⛓
23+0.00000000000000000000000000000000000
32+1.00000000,
+0.00000000,
+0.00000000,
+0.00000000,
+1.00000000
36+1.0000000000000000,
+0.0000000000000000,
+0.0000000000000000,
+0.0000000000000000,
+1.0000000000000000
40+1.00000000000000000000000000000000000,
+1.00000000000000000000000000000000000,
+1.00000000000000000000000000000000000,
+1.00000000000000000000000000000000000,
+1.00000000000000000000000000000000000
 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.

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