summaryrefslogtreecommitdiff
path: root/array.rb
blob: ed5779290f08ca8c970b94fb31a52ef110c81bbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#!/usr/bin/ruby
class Array
  # call-seq:
  #    ary.shuffle!              -> ary
  #    ary.shuffle!(random: rng) -> ary
  #
  # Shuffles elements in +self+ in place.
  #
  #    a = [ 1, 2, 3 ]           #=> [1, 2, 3]
  #    a.shuffle!                #=> [2, 3, 1]
  #    a                         #=> [2, 3, 1]
  #
  # The optional +rng+ argument will be used as the random number generator.
  #
  #    a.shuffle!(random: Random.new(1))  #=> [1, 3, 2]
  def shuffle!(random: Random)
    __builtin_rb_ary_shuffle_bang(random)
  end

  # call-seq:
  #    ary.shuffle              -> new_ary
  #    ary.shuffle(random: rng) -> new_ary
  #
  # Returns a new array with elements of +self+ shuffled.
  #
  #    a = [ 1, 2, 3 ]           #=> [1, 2, 3]
  #    a.shuffle                 #=> [2, 3, 1]
  #    a                         #=> [1, 2, 3]
  #
  # The optional +rng+ argument will be used as the random number generator.
  #
  #    a.shuffle(random: Random.new(1))  #=> [1, 3, 2]
  def shuffle(random: Random)
    __builtin_rb_ary_shuffle(random);
  end
end