summaryrefslogtreecommitdiff log msg author committer range
path: root/array.rb
blob: a43a3b27b17d36c585cb74f80caf6b76c77b3004 (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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 ``` ``````class Array # call-seq: # array.shuffle!(random: Random) -> array # # Shuffles the elements of +self+ in place. # a = [1, 2, 3] #=> [1, 2, 3] # a.shuffle! #=> [2, 3, 1] # a #=> [2, 3, 1] # # The optional +random+ argument will be used as the random number generator: # a.shuffle!(random: Random.new(1)) #=> [1, 3, 2] def shuffle!(random: Random) Primitive.rb_ary_shuffle_bang(random) end # call-seq: # array.shuffle(random: Random) -> 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 +random+ argument will be used as the random number generator: # a.shuffle(random: Random.new(1)) #=> [1, 3, 2] def shuffle(random: Random) Primitive.rb_ary_shuffle(random) end # call-seq: # array.sample(random: Random) -> object # array.sample(n, random: Random) -> new_ary # # Returns random elements from +self+. # # When no arguments are given, returns a random element from +self+: # a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] # a.sample # => 3 # a.sample # => 8 # If +self+ is empty, returns +nil+. # # When argument +n+ is given, returns a new \Array containing +n+ random # elements from +self+: # a.sample(3) # => [8, 9, 2] # a.sample(6) # => [9, 6, 10, 3, 1, 4] # Returns no more than a.size elements # (because no new duplicates are introduced): # a.sample(a.size * 2) # => [6, 4, 1, 8, 5, 9, 10, 2, 3, 7] # But +self+ may contain duplicates: # a = [1, 1, 1, 2, 2, 3] # a.sample(a.size * 2) # => [1, 1, 3, 2, 1, 2] # Returns a new empty \Array if +self+ is empty. # # The optional +random+ argument will be used as the random number generator: # a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] # a.sample(random: Random.new(1)) #=> 6 # a.sample(4, random: Random.new(1)) #=> [6, 10, 9, 2] def sample(n = (ary = false), random: Random) Primitive.rb_ary_sample(random, n, ary) end end ``````