admin/mruby-mruby
1
0
Fork 0
mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

mruby-array-ext: improve documentation for repeated combination/permutation

Browse Source 
The comments for `Array#repeated_combination` and
`Array#repeated_permutation` were too concise. This commit expands them
to be more descriptive and provides better examples.

Co-authored-by: Gemini <gemini@google.com>
This commit is contained in:
Yukihiro "Matz" Matsumoto
2025-08-15 23:06:26 +09:00
parent c28b29f5ef
commit 074bbe8910
1 changed files with 32 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mrbgems/mruby-array-ext/mrblib/array.rb
+32 -6
View File
@@ -646,10 +646,23 @@ class Array
##
# call-seq:
# ary.repeated_combination(n) { |combination| ... } -> self
# ary.repeated_combination(n) -> enumerator
# ary.repeated_combination(n) { |combination| ... } -> ary
# ary.repeated_combination(n) -> Enumerator
#
# A `combination` method that contains the same elements.
# When invoked with a block, yields all length `n` combinations of elements
# from the array, with replacement, and then returns the array itself.
#
# This means that, unlike `combination`, elements can be chosen more than once.
#
# The implementation makes no guarantees about the order in which the
# combinations are yielded.
#
# If no block is given, an Enumerator is returned instead.
#
# Examples:
#
# a = [1, 2, 3]
# a.repeated_combination(2).to_a #=> [[1,1],[1,2],[1,3],[2,2],[2,3],[3,3]]
def repeated_combination(n, &block)
raise TypeError, "no implicit conversion into Integer" unless 0 <=> n
return to_enum(:repeated_combination, n) unless block
@@ -658,10 +671,23 @@ class Array
##
# call-seq:
# ary.repeated_permutation(n) { |permutation| ... } -> self
# ary.repeated_permutation(n) -> enumerator
# ary.repeated_permutation(n) { |permutation| ... } -> ary
# ary.repeated_permutation(n) -> Enumerator
#
# A `permutation` method that contains the same elements.
# When invoked with a block, yields all length `n` permutations of elements
# from the array, with replacement, and then returns the array itself.
#
# This means that, unlike `permutation`, elements can be chosen more than once.
#
# The implementation makes no guarantees about the order in which the
# permutations are yielded.
#
# If no block is given, an Enumerator is returned instead.
#
# Examples:
#
# a = [1, 2]
# a.repeated_permutation(2).to_a #=> [[1,1],[1,2],[2,1],[2,2]]
def repeated_permutation(n, &block)
n = n.__to_int
raise TypeError, "no implicit conversion into Integer" unless 0 <=> n