pcg32_next_bernoulli_ppm Function

private function pcg32_next_bernoulli_ppm(gen, ppm) result(r)

True with probability ppm in a million, from a pcg32_t generator.

Arguments

Type IntentOptional Attributes Name
type(pcg32_t), intent(inout) :: gen

Generator, advanced by the draw unless ppm is 0 or PPM_ONE.
integer(kind=default_int), intent(in) :: ppm

Probability in parts per million, clamped to [0, PPM_ONE].

Return Value logical


Calls

proc~~pcg32_next_bernoulli_ppm~~CallsGraph proc~pcg32_next_bernoulli_ppm pcg32_next_bernoulli_ppm proc~pcg32_uniform_below pcg32_uniform_below proc~pcg32_next_bernoulli_ppm->proc~pcg32_uniform_below proc~pcg32_next_u64 pcg32_t%pcg32_next_u64 proc~pcg32_uniform_below->proc~pcg32_next_u64 proc~rejection_mask~2 rejection_mask proc~pcg32_uniform_below->proc~rejection_mask~2 proc~u64_less u64_less proc~pcg32_uniform_below->proc~u64_less proc~pcg32_step pcg32_step proc~pcg32_next_u64->proc~pcg32_step proc~u64_shr u64_shr proc~rejection_mask~2->proc~u64_shr proc~pcg32_step->proc~u64_shr proc~rotate_right32 rotate_right32 proc~pcg32_step->proc~rotate_right32 proc~u64_add u64_add proc~pcg32_step->proc~u64_add proc~u64_mul u64_mul proc~pcg32_step->proc~u64_mul

Called by

proc~~pcg32_next_bernoulli_ppm~~CalledByGraph proc~pcg32_next_bernoulli_ppm pcg32_next_bernoulli_ppm interface~next_bernoulli_ppm next_bernoulli_ppm interface~next_bernoulli_ppm->proc~pcg32_next_bernoulli_ppm

Variables

Type Visibility Attributes Name Initial
integer(kind=default_int), private :: clamped

Source Code

   function pcg32_next_bernoulli_ppm(gen, ppm) result(r)
      !! True with probability `ppm` in a million, from a pcg32_t generator.
      type(pcg32_t), intent(inout) :: gen
         !! Generator, advanced by the draw unless `ppm` is 0 or `PPM_ONE`.
      integer(default_int), intent(in) :: ppm
         !! Probability in parts per million, clamped to `[0, PPM_ONE]`.
      logical :: r

      integer(default_int) :: clamped

      clamped = max(0_default_int, min(PPM_ONE, ppm))
      if (clamped == 0_default_int) then
         r = .false.
         return
      end if
      if (clamped == PPM_ONE) then
         r = .true.
         return
      end if
      r = pcg32_uniform_below(gen, int(PPM_ONE, int64) - 1_int64) < int(clamped, int64)
   end function pcg32_next_bernoulli_ppm