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 ⛓

use pm_distBern, only: getBernRand
 
rand = getBernRand(p) ! elemental
rand(1:size) = getBernRand(p, size) ! non-elemental
!

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 ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_kind, only: RK, RKS, RKD, RKH
    use pm_io, only: display_type
    use pm_distBern, only: getBernRand
 
    implicit none
 
    integer(IK) , parameter :: NP = 5_IK
    real(RKS)               :: rand_RKS(NP)
    real(RKD)               :: rand_RKD(NP)
    real(RKH)               :: rand_RKH(NP)
    type(display_type)      :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Generate `real`-valued random numbers.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Generate a scalar real random number.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%show("rand_RKS(1) = getBernRand(p = 0.5_RKS) ! 0.5 odds of success.")
                    rand_RKS(1) = getBernRand(p = 0.5_RKS)
    call disp%show("rand_RKS(1)")
    call disp%show( rand_RKS(1) )
    call disp%skip()
 
    call disp%show("rand_RKD(1) = getBernRand(p = 0.5_RKD)")
                    rand_RKD(1) = getBernRand(p = 0.5_RKD)
    call disp%show("rand_RKD(1)")
    call disp%show( rand_RKD(1) )
    call disp%skip()
 
    call disp%show("rand_RKH(1) = getBernRand(p = 0.5_RKH)")
                    rand_RKH(1) = getBernRand(p = 0.5_RKH)
    call disp%show("rand_RKH(1)")
    call disp%show( rand_RKH(1) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Generate a vector of real random numbers.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%show("rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP) ! 0.5 odds of success.")
                    rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP)
    call disp%show("rand_RKS(:)")
    call disp%show( rand_RKS(:) )
    call disp%skip()
 
    call disp%show("rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)")
                    rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)
    call disp%show("rand_RKD(:)")
    call disp%show( rand_RKD(:) )
    call disp%skip()
 
    call disp%show("rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)")
                    rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)
    call disp%show("rand_RKH(:)")
    call disp%show( rand_RKH(:) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Generate `real`-valued random numbers.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Generate a scalar real random number.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
rand_RKS(1) = getBernRand(p = 0.5_RKS) ! 0.5 odds of success.
rand_RKS(1)
+0.00000000
 
rand_RKD(1) = getBernRand(p = 0.5_RKD)
rand_RKD(1)
+1.0000000000000000
 
rand_RKH(1) = getBernRand(p = 0.5_RKH)
rand_RKH(1)
+1.00000000000000000000000000000000000
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Generate a vector of real random numbers.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
rand_RKS(:) = getBernRand(p = 0.5_RKS, size = NP) ! 0.5 odds of success.
rand_RKS(:)
+1.00000000, +0.00000000, +1.00000000, +1.00000000, +1.00000000
 
rand_RKD(:) = getBernRand(p = 0.5_RKD, size = NP)
rand_RKD(:)
+1.0000000000000000, +0.0000000000000000, +1.0000000000000000, +0.0000000000000000, +1.0000000000000000
 
rand_RKH(:) = getBernRand(p = 0.5_RKH, size = NP)
rand_RKH(:)
+1.00000000000000000000000000000000000, +1.00000000000000000000000000000000000, +1.00000000000000000000000000000000000, +1.00000000000000000000000000000000000, +0.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.

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.

Copyright

Computational Data Science Lab

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:

• src/fortran/main/pm_distBern.F90