Return a scalar or array of arbitrary rank of Bernoulli-distributed random values (0 or 1), with the specified input success probability p. More...

Detailed Description

Return a scalar or array of arbitrary rank of Bernoulli-distributed random values (0 or 1), with the specified input success probability p.

Parameters

[out]

rand

: The output scalar (or array of the same rank, shape, and size as other array-like arguments), of

type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64),
type logical of kind any supported by the processor (e.g., LK),
type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),

containing the Bernoulli-distributed random output value.

If rand is real, then an output value of 1. means success/yes/true and 0. means failure/no/false.
If rand is integer, then an output value of 1 means success/yes/true and 0 means failure/no/false.
If rand is logical, then an output value of .true. means success/yes/true and .false. means failure/no/false.

[in]

urand

: The input scalar (or array of the same rank, shape, and size as other array-like arguments), of

type real of the same kind as rand if rand is real, or
type real of the kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), if rand is of type logical or integer,

containing uniformly-distributed random value(s) with the range 0 <= urand < 1.
Such random value(s) can be readily obtained via the Fortran intrinsic procedure random_number() or via getUnifRand().
Supplying this argument ensures the purity of the procedures, allowing further compiler optimizations.

[in]

p

: The input scalar (or array of the same rank, shape, and size as other array-like arguments), of

type real of the same kind as rand if rand is real, or
type real of the kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), if rand is of type logical or integer,

representing the success probability of in the Bernoulli trial.
Note that p must be a number in the range [0,1].

Possible calling interfaces ⛓

: use pm_distBern, only: setBernRand

call setBernRand(rand, urand)

call setBernRand(rand, urand, p)

pm_distBern::setBernRand
Return a scalar or array of arbitrary rank of Bernoulli-distributed random values (0 or 1),...
Definition: pm_distBern.F90:554

pm_distBern
This module contains classes and procedures for generating Bernoulli-distributed random numbers.
Definition: pm_distBern.F90:39

Warning: The conditions 0 <= p <= 1 must hold for the corresponding input arguments.
The conditions 0 <= urand < 1 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: isHead
getBernRand
getUnifRand
setUnifRand

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK, LK ! all intrinsic types and kinds are supported.

4 use pm_io, only: display_type

5 use pm_distUnif, only: getUnifRand

6 use pm_distBern, only: setBernRand

7

8 implicit none

9

10 integer(IK) , parameter :: NP = 5_IK

11 logical :: Rand_LK(NP)

12 integer :: Rand_IK(NP)

13 real :: Rand_RK(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 `integer`-valued random state.")

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 integer random value.")

29 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

30 call disp%skip()

31

32 call disp%show("call setBernRand(Rand_IK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.")

33 call setBernRand(Rand_IK(1), getUnifRand(0., 1.), p = .5)

34 call disp%show("Rand_IK(1)")

35 call disp%show( Rand_IK(1) )

36 call disp%skip()

37

38 call disp%skip()

39 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

40 call disp%show("! Generate a vector integer random value.")

41 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

42 call disp%skip()

43

44 call disp%show("call setBernRand(Rand_IK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.")

45 call setBernRand(Rand_IK(:), getUnifRand(0., 1., NP), p = 0.75)

46 call disp%show("Rand_IK(:)")

47 call disp%show( Rand_IK(:) )

48 call disp%skip()

49

50 call disp%skip()

51 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

52 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

53 call disp%show("! Generate `logical`-valued random state.")

54 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

55 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

56 call disp%skip()

57

58 call disp%skip()

59 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

60 call disp%show("! Generate a scalar logical random value.")

61 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

62 call disp%skip()

63

64 call disp%show("call setBernRand(Rand_LK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.")

65 call setBernRand(Rand_LK(1), getUnifRand(0., 1.), p = .5)

66 call disp%show("Rand_LK(1)")

67 call disp%show( Rand_LK(1) )

68 call disp%skip()

69

70 call disp%skip()

71 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

72 call disp%show("! Generate a vector logical random value.")

73 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

74 call disp%skip()

75

76 call disp%show("call setBernRand(Rand_LK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.")

77 call setBernRand(Rand_LK(:), getUnifRand(0., 1., NP), p = 0.75)

78 call disp%show("Rand_LK(:)")

79 call disp%show( Rand_LK(:) )

80 call disp%skip()

81

82 call disp%skip()

83 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

84 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

85 call disp%show("! Generate `real`-valued random numbers.")

86 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

87 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

88 call disp%skip()

89

90 call disp%skip()

91 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

92 call disp%show("! Generate a scalar real random number.")

93 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

94 call disp%skip()

95

96 call disp%show("call setBernRand(Rand_RK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.")

97 call setBernRand(Rand_RK(1), getUnifRand(0., 1.), p = .5)

98 call disp%show("Rand_RK(1)")

99 call disp%show( Rand_RK(1) )

100 call disp%skip()

101

102 call disp%skip()

103 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

104 call disp%show("! Generate a vector of real random numbers.")

105 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")

106 call disp%skip()

107

108 call disp%show("call setBernRand(Rand_RK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.")

109 call setBernRand(Rand_RK(:), getUnifRand(0., 1., NP), p = 0.75)

110 call disp%show("Rand_RK(:)")

111 call disp%show( Rand_RK(:) )

112 call disp%skip()

113

114end program example

pm_distUnif::getUnifRand
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
Definition: pm_distUnif.F90:4150

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_distUnif
This module contains classes and procedures for computing various statistical quantities related to t...
Definition: pm_distUnif.F90:274

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

pm_kind::IK
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

pm_kind::SK
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

pm_io::display_type
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 `integer`-valued random state.

5!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

6!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

7

8

9!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

10! Generate a scalar integer random value.

11!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

12

13call setBernRand(Rand_IK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.

14Rand_IK(1)

15+1

16

17

18!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

19! Generate a vector integer random value.

20!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

21

22call setBernRand(Rand_IK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.

23Rand_IK(:)

24+1, +1, +1, +1, +0

25

26

27!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

28!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

29! Generate `logical`-valued random state.

30!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

31!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

32

33

34!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

35! Generate a scalar logical random value.

36!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

37

38call setBernRand(Rand_LK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.

39Rand_LK(1)

40F

41

42

43!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

44! Generate a vector logical random value.

45!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

46

47call setBernRand(Rand_LK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.

48Rand_LK(:)

49T, T, T, T, T

50

51

52!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

53!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

54! Generate `real`-valued random numbers.

55!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

56!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

57

58

59!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

60! Generate a scalar real random number.

61!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

62

63call setBernRand(Rand_RK(1), getUnifRand(0., 1.), p = .5) ! 0.5 odds of success.

64Rand_RK(1)

65+0.00000000

66

67

68!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

69! Generate a vector of real random numbers.

70!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

71

72call setBernRand(Rand_RK(:), getUnifRand(0., 1., NP), p = 0.75) ! 0.75 odds of success.

73Rand_RK(:)

74+1.00000000, +1.00000000, +1.00000000, +1.00000000, +1.00000000

75

76

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

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

src/fortran/main/pm_distBern.F90