Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[DOC] Tweaks for Array#shuffle! #11891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 15, 2024
Merged

[DOC] Tweaks for Array#shuffle! #11891

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fd49a2
[DOC] Tweaks or Array#shuffle!
BurdetteLamar Oct 12, 2024
c1c3228
[DOC] Tweaks for Array#shuffle!
BurdetteLamar Oct 14, 2024
0fdc17e
[DOC] Tweaks for Array#shuffle!
BurdetteLamar Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions array.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,25 @@ def each
end

# call-seq:
# array.shuffle!(random: Random) -> array
# shuffle!(random: Random) -> self
#
# Shuffles the elements of +self+ in place.
# a = [1, 2, 3] #=> [1, 2, 3]
# a.shuffle! #=> [2, 3, 1]
# a #=> [2, 3, 1]
# Shuffles all elements in +self+ into a random order,
# as selected by the object given by keyword argument +random+;
# returns +self+:
#
# The optional +random+ argument will be used as the random number generator:
# a.shuffle!(random: Random.new(1)) #=> [1, 3, 2]
# a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
# a.shuffle! # => [5, 3, 8, 7, 6, 1, 9, 4, 2, 0]
# a.shuffle! # => [9, 4, 0, 6, 2, 8, 1, 5, 3, 7]
#
# Duplicate elements are included:
#
# a = [0, 1, 0, 1, 0, 1, 0, 1, 0, 1]
# a.shuffle! # => [1, 0, 0, 1, 1, 0, 1, 0, 0, 1]
# a.shuffle! # => [0, 1, 0, 1, 1, 0, 1, 0, 1, 0]
#
# The object given with keyword argument +random+ is used as the random number generator.
#
# Related: see {Methods for Fetching}[rdoc-ref:Array@Methods+for+Fetching].
def shuffle!(random: Random)
Primitive.rb_ary_shuffle_bang(random)
end
Expand Down