9.6. $RANDOM: generate random integer

$RANDOM is an internal Bash function (not a constant) that returns a pseudorandom integer in the range 0 - 32767. $RANDOM should not be used to generate an encryption key.


Example 9-23. Generating random numbers

   1 #!/bin/bash
   2 
   3 # $RANDOM returns a different random integer at each invocation.
   4 # Nominal range: 0 - 32767 (signed 16-bit integer).
   5 
   6 MAXCOUNT=10
   7 count=1
   8 
   9 echo
  10 echo "$MAXCOUNT random numbers:"
  11 echo "-----------------"
  12 while [ "$count" -le $MAXCOUNT ]      # Generate 10 ($MAXCOUNT) random integers.
  13 do
  14   number=$RANDOM
  15   echo $number
  16   let "count += 1"  # Increment count.
  17 done
  18 echo "-----------------"
  19 
  20 # If you need a random int within a certain range, use the 'modulo' operator.
  21 # This returns the remainder of a division operation.
  22 
  23 RANGE=500
  24 
  25 echo
  26 
  27 number=$RANDOM
  28 let "number %= $RANGE"
  29 echo "Random number less than $RANGE  ---  $number"
  30 
  31 echo
  32 
  33 # If you need a random int greater than a lower bound,
  34 # then set up a test to discard all numbers below that.
  35 
  36 FLOOR=200
  37 
  38 number=0   #initialize
  39 while [ "$number" -le $FLOOR ]
  40 do
  41   number=$RANDOM
  42 done
  43 echo "Random number greater than $FLOOR ---  $number"
  44 echo
  45 
  46 
  47 # May combine above two techniques to retrieve random number between two limits.
  48 number=0   #initialize
  49 while [ "$number" -le $FLOOR ]
  50 do
  51   number=$RANDOM
  52   let "number %= $RANGE"  # Scales $number down within $RANGE.
  53 done
  54 echo "Random number between $FLOOR and $RANGE ---  $number"
  55 echo
  56 
  57 
  58 # Generate binary choice, that is, "true" or "false" value.
  59 BINARY=2
  60 number=$RANDOM
  61 T=1
  62 
  63 let "number %= $BINARY"
  64 # let "number >>= 14"    gives a better random distribution
  65 # (right shifts out everything except last binary digit).
  66 if [ "$number" -eq $T ]
  67 then
  68   echo "TRUE"
  69 else
  70   echo "FALSE"
  71 fi  
  72 
  73 echo
  74 
  75 
  76 # May generate toss of the dice.
  77 SPOTS=7   # Modulo 7 gives range 0 - 6.
  78 ZERO=0
  79 die1=0
  80 die2=0
  81 
  82 # Tosses each die separately, and so gives correct odds.
  83 
  84   while [ "$die1" -eq $ZERO ]     # Can't have a zero come up.
  85   do
  86     let "die1 = $RANDOM % $SPOTS" # Roll first one.
  87   done  
  88 
  89   while [ "$die2" -eq $ZERO ]
  90   do
  91     let "die2 = $RANDOM % $SPOTS" # Roll second one.
  92   done  
  93 
  94 let "throw = $die1 + $die2"
  95 echo "Throw of the dice = $throw"
  96 echo
  97 
  98 
  99 exit 0


Example 9-24. Picking a random card from a deck

   1 #!/bin/bash
   2 # pick-card.sh
   3 
   4 # This is an example of choosing a random element of an array.
   5 
   6 
   7 # Pick a card, any card.
   8 
   9 Suites="Clubs
  10 Diamonds
  11 Hearts
  12 Spades"
  13 
  14 Denominations="2
  15 3
  16 4
  17 5
  18 6
  19 7
  20 8
  21 9
  22 10
  23 Jack
  24 Queen
  25 King
  26 Ace"
  27 
  28 suite=($Suites)                # Read into array variable.
  29 denomination=($Denominations)
  30 
  31 num_suites=${#suite[*]}        # Count how many elements.
  32 num_denominations=${#denomination[*]}
  33 
  34 echo -n "${denomination[$((RANDOM%num_denominations))]} of "
  35 echo ${suite[$((RANDOM%num_suites))]}
  36 
  37 
  38 # $bozo sh pick-cards.sh
  39 # Jack of Clubs
  40 
  41 
  42 # Thank you, "jipe," for pointing out this use of $RANDOM.
  43 exit 0

Note

Jipe points out another set of techniques for generating random numbers within a range.

   1 #  Generate random number between 6 and 30.
   2 rnumber=$((RANDOM%25+6))	
   3 
   4 #  Generate random number in the same 6 - 30 range,
   5 #+ but the number must be evenly divisible by 3.
   6 rnumber=$(((RANDOM%30/3+1)*3))
   7 
   8 #  Exercise: Try to figure out the pattern here.

Just how random is $RANDOM? The best way to test this is to write a script that tracks the distribution of "random" numbers generated by $RANDOM. Let's roll a $RANDOM die a few times...


Example 9-25. Rolling the die with RANDOM

   1 #!/bin/bash
   2 # How random is RANDOM?
   3 
   4 RANDOM=$$       # Reseed the random number generator using script process ID.
   5 
   6 PIPS=6          # A die has 6 pips.
   7 MAXTHROWS=600   # Increase this, if you have nothing better to do with your time.
   8 throw=0         # Throw count.
   9 
  10 zeroes=0        # Must initialize counts to zero.
  11 ones=0          # since an uninitialized variable is null, not zero.
  12 twos=0
  13 threes=0
  14 fours=0
  15 fives=0
  16 sixes=0
  17 
  18 print_result ()
  19 {
  20 echo
  21 echo "ones =   $ones"
  22 echo "twos =   $twos"
  23 echo "threes = $threes"
  24 echo "fours =  $fours"
  25 echo "fives =  $fives"
  26 echo "sixes =  $sixes"
  27 echo
  28 }
  29 
  30 update_count()
  31 {
  32 case "$1" in
  33   0) let "ones += 1";;   # Since die has no "zero", this corresponds to 1.
  34   1) let "twos += 1";;   # And this to 2, etc.
  35   2) let "threes += 1";;
  36   3) let "fours += 1";;
  37   4) let "fives += 1";;
  38   5) let "sixes += 1";;
  39 esac
  40 }
  41 
  42 echo
  43 
  44 
  45 while [ "$throw" -lt "$MAXTHROWS" ]
  46 do
  47   let "die1 = RANDOM % $PIPS"
  48   update_count $die1
  49   let "throw += 1"
  50 done  
  51 
  52 print_result
  53 
  54 # The scores should distribute fairly evenly, assuming RANDOM is fairly random.
  55 # With $MAXTHROWS at 600, all should cluster around 100, plus-or-minus 20 or so.
  56 #
  57 # Keep in mind that RANDOM is a pseudorandom generator,
  58 # and not a spectacularly good one at that.
  59 
  60 # Exercise (easy):
  61 # ---------------
  62 # Rewrite this script to flip a coin 1000 times.
  63 # Choices are "HEADS" or "TAILS".
  64 
  65 exit 0

As we have seen in the last example, it is best to "reseed" the RANDOM generator each time it is invoked. Using the same seed for RANDOM repeats the same series of numbers. (This mirrors the behavior of the random() function in C.)


Example 9-26. Reseeding RANDOM

   1 #!/bin/bash
   2 # seeding-random.sh: Seeding the RANDOM variable.
   3 
   4 MAXCOUNT=25       # How many numbers to generate.
   5 
   6 random_numbers ()
   7 {
   8 count=0
   9 while [ "$count" -lt "$MAXCOUNT" ]
  10 do
  11   number=$RANDOM
  12   echo -n "$number "
  13   let "count += 1"
  14 done  
  15 }
  16 
  17 echo; echo
  18 
  19 RANDOM=1          # Setting RANDOM seeds the random number generator.
  20 random_numbers
  21 
  22 echo; echo
  23 
  24 RANDOM=1          # Same seed for RANDOM...
  25 random_numbers    # ...reproduces the exact same number series.
  26                   #
  27                   # When is it useful to duplicate a "random" number series?
  28 
  29 echo; echo
  30 
  31 RANDOM=2          # Trying again, but with a different seed...
  32 random_numbers    # gives a different number series.
  33 
  34 echo; echo
  35 
  36 # RANDOM=$$  seeds RANDOM from process id of script.
  37 # It is also possible to seed RANDOM from 'time' or 'date' commands.
  38 
  39 # Getting fancy...
  40 SEED=$(head -1 /dev/urandom | od -N 1 | awk '{ print $2 }')
  41 #  Pseudo-random output fetched
  42 #+ from /dev/urandom (system pseudo-random device-file),
  43 #+ then converted to line of printable (octal) numbers by "od",
  44 #+ finally "awk" retrieves just one number for SEED.
  45 RANDOM=$SEED
  46 random_numbers
  47 
  48 echo; echo
  49 
  50 exit 0

Note

The /dev/urandom device-file provides a means of generating much more "random" pseudorandom numbers than the $RANDOM variable. dd if=/dev/urandom of=targetfile bs=1 count=XX creates a file of well-scattered pseudorandom numbers. However, assigning these numbers to a variable in a script requires a workaround, such as filtering through od (as in above example) or using dd (see Example 12-42).

There are also other means of generating pseudorandom numbers in a script. Awk provides a convenient means of doing this.


Example 9-27. Pseudorandom numbers, using awk

   1 #!/bin/bash
   2 # random2.sh: Returns a pseudorandom number in the range 0 - 1.
   3 # Uses the awk rand() function.
   4 
   5 AWKSCRIPT=' { srand(); print rand() } '
   6 # Command(s) / parameters passed to awk
   7 # Note that srand() reseeds awk's random number generator.
   8 
   9 echo -n "Random number between 0 and 1 = "
  10 echo | awk "$AWKSCRIPT"
  11 
  12 exit 0
  13 
  14 
  15 # Exercises:
  16 # ---------
  17 
  18 # 1) Using a loop construct, print out 10 different random numbers.
  19 #      (Hint: you must reseed the "srand()" function with a different seed
  20 #      in each pass through the loop. What happens if you fail to do this?)
  21 
  22 # 2) Using an integer multiplier as a scaling factor, generate random numbers 
  23 #    in the range between 10 and 100.
  24 
  25 # 3) Same as exercise #2, above, but generate random integers this time.