Comply with guide for method doc: array.c (#3506)

Methods:

    any?
    all?
    one?
    none?
    sum
    shuffle!
    shuffle
    sample
This commit is contained in:
Burdette Lamar 2020-09-02 14:02:34 -05:00 коммит произвёл GitHub
Родитель d9b8411a7b
Коммит 54fb8fb62a
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 74 добавлений и 133 удалений

144
array.c
Просмотреть файл

@ -1732,7 +1732,7 @@ rb_ary_at(VALUE ary, VALUE pos)
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a.first(2) # => [:foo, "bar"] * a.first(2) # => [:foo, "bar"]
* *
* If <tt>n >= ary.size</tt>, returns all elements: * If <tt>n >= array.size</tt>, returns all elements:
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a.first(50) # => [:foo, "bar", 2] * a.first(50) # => [:foo, "bar", 2]
* *
@ -1773,7 +1773,7 @@ rb_ary_first(int argc, VALUE *argv, VALUE ary)
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a.last(2) # => ["bar", 2] * a.last(2) # => ["bar", 2]
* *
* If <tt>n >= ary.size</tt>, returns all elements: * If <tt>n >= array.size</tt>, returns all elements:
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a.last(50) # => [:foo, "bar", 2] * a.last(50) # => [:foo, "bar", 2]
* *
@ -2963,7 +2963,7 @@ rb_ary_rotate(VALUE ary, long cnt)
* a.rotate!(2) * a.rotate!(2)
* a # => [2, :foo, "bar"] * a # => [2, :foo, "bar"]
* *
* If +count+ is large, uses <tt>count % ary.size</tt> as the count: * If +count+ is large, uses <tt>count % array.size</tt> as the count:
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a.rotate!(20) * a.rotate!(20)
* a # => [2, :foo, "bar"] * a # => [2, :foo, "bar"]
@ -2979,7 +2979,7 @@ rb_ary_rotate(VALUE ary, long cnt)
* a.rotate!(-2) * a.rotate!(-2)
* a # => ["bar", 2, :foo] * a # => ["bar", 2, :foo]
* *
* If +count+ is small (far from zero), uses <tt>count % ary.size</tt> as the count: * If +count+ is small (far from zero), uses <tt>count % array.size</tt> as the count:
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a.rotate!(-5) * a.rotate!(-5)
* a # => ["bar", 2, :foo] * a # => ["bar", 2, :foo]
@ -3013,7 +3013,7 @@ rb_ary_rotate_bang(int argc, VALUE *argv, VALUE ary)
* a1 = a.rotate(2) * a1 = a.rotate(2)
* a1 # => [2, :foo, "bar"] * a1 # => [2, :foo, "bar"]
* *
* If +count+ is large, uses <tt>count % ary.size</tt> as the count: * If +count+ is large, uses <tt>count % array.size</tt> as the count:
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a1 = a.rotate(20) * a1 = a.rotate(20)
* a1 # => [2, :foo, "bar"] * a1 # => [2, :foo, "bar"]
@ -3029,7 +3029,7 @@ rb_ary_rotate_bang(int argc, VALUE *argv, VALUE ary)
* a1 = a.rotate(-2) * a1 = a.rotate(-2)
* a1 # => ["bar", 2, :foo] * a1 # => ["bar", 2, :foo]
* *
* If +count+ is small (far from zero), uses <tt>count % ary.size</tt> as the count: * If +count+ is small (far from zero), uses <tt>count % array.size</tt> as the count:
* a = [:foo, 'bar', 2] * a = [:foo, 'bar', 2]
* a1 = a.rotate(-5) * a1 = a.rotate(-5)
* a1 # => ["bar", 2, :foo] * a1 # => ["bar", 2, :foo]
@ -4428,18 +4428,18 @@ rb_ary_clear(VALUE ary)
* With arguments +obj+ and \Integer +start+, and no block given, * With arguments +obj+ and \Integer +start+, and no block given,
* replaces elements based on the given start. * replaces elements based on the given start.
* *
* If +start+ is in range (<tt>0 <= start < ary.size</tt>), * If +start+ is in range (<tt>0 <= start < array.size</tt>),
* replaces all elements from offset +start+ through the end: * replaces all elements from offset +start+ through the end:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(:X, 2) # => ["a", "b", :X, :X] * a.fill(:X, 2) # => ["a", "b", :X, :X]
* *
* If +start+ is too large (<tt>start >= ary.size</tt>), does nothing: * If +start+ is too large (<tt>start >= array.size</tt>), does nothing:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(:X, 4) # => ["a", "b", "c", "d"] * a.fill(:X, 4) # => ["a", "b", "c", "d"]
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(:X, 5) # => ["a", "b", "c", "d"] * a.fill(:X, 5) # => ["a", "b", "c", "d"]
* *
* If +start+ is negative, counts from the end (starting index is <tt>start + ary.size</tt>): * If +start+ is negative, counts from the end (starting index is <tt>start + array.size</tt>):
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(:X, -2) # => ["a", "b", :X, :X] * a.fill(:X, -2) # => ["a", "b", :X, :X]
* *
@ -4460,7 +4460,7 @@ rb_ary_clear(VALUE ary)
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(:X, -2, 1) # => ["a", "b", :X, "d"] * a.fill(:X, -2, 1) # => ["a", "b", :X, "d"]
* *
* If +start+ is large (<tt>start >= ary.size</tt>), extends +self+ with +nil+: * If +start+ is large (<tt>start >= array.size</tt>), extends +self+ with +nil+:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(:X, 5, 0) # => ["a", "b", "c", "d", nil] * a.fill(:X, 5, 0) # => ["a", "b", "c", "d", nil]
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
@ -4505,12 +4505,12 @@ rb_ary_clear(VALUE ary)
* from offset +start+ to the end; replaces the corresponding element * from offset +start+ to the end; replaces the corresponding element
* with the block's return value: * with the block's return value:
* *
* If start is in range (<tt>0 <= start < ary.size</tt>), * If start is in range (<tt>0 <= start < array.size</tt>),
* replaces from offset +start+ to the end: * replaces from offset +start+ to the end:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(1) { |index| "new_#{index}" } # => ["a", "new_1", "new_2", "new_3"] * a.fill(1) { |index| "new_#{index}" } # => ["a", "new_1", "new_2", "new_3"]
* *
* If +start+ is too large(<tt>start >= ary.size</tt>), does nothing: * If +start+ is too large(<tt>start >= array.size</tt>), does nothing:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(4) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"] * a.fill(4) { |index| fail 'Cannot happen' } # => ["a", "b", "c", "d"]
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
@ -4520,7 +4520,7 @@ rb_ary_clear(VALUE ary)
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(-2) { |index| "new_#{index}" } # => ["a", "b", "new_2", "new_3"] * a.fill(-2) { |index| "new_#{index}" } # => ["a", "b", "new_2", "new_3"]
* *
* If start is too small (<tt>start <= -ary.size</tt>, replaces all elements: * If start is too small (<tt>start <= -array.size</tt>, replaces all elements:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(-6) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"] * a.fill(-6) { |index| "new_#{index}" } # => ["new_0", "new_1", "new_2", "new_3"]
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
@ -4538,7 +4538,7 @@ rb_ary_clear(VALUE ary)
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(-2, 1) { |index| "new_#{index}" } # => ["a", "b", "new_2", "d"] * a.fill(-2, 1) { |index| "new_#{index}" } # => ["a", "b", "new_2", "d"]
* *
* If +start+ is large (<tt>start >= ary.size</tt>), extends +self+ with +nil+: * If +start+ is large (<tt>start >= array.size</tt>), extends +self+ with +nil+:
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
* a.fill(5, 0) { |index| "new_#{index}" } # => ["a", "b", "c", "d", nil] * a.fill(5, 0) { |index| "new_#{index}" } # => ["a", "b", "c", "d", nil]
* a = ['a', 'b', 'c', 'd'] * a = ['a', 'b', 'c', 'd']
@ -5671,7 +5671,7 @@ ary_min_opt_string(VALUE ary, long i, VALUE vmin)
* array.min -> element * array.min -> element
* array.min { |a, b| ... } -> element * array.min { |a, b| ... } -> element
* array.min(n) -> new_array * array.min(n) -> new_array
* ary.min(n) { |a, b| ... } -> new_array * array.min(n) { |a, b| ... } -> new_array
* *
* Returns one of the following: * Returns one of the following:
* - The minimum-valued element from +self+. * - The minimum-valued element from +self+.
@ -6659,7 +6659,7 @@ rb_ary_combination_size(VALUE ary, VALUE args, VALUE eobj)
/* /*
* call-seq: * call-seq:
* array.combination(n) {|element| ... } -> self * array.combination(n) {|element| ... } -> self
* ary.combination(n) -> new_enumerator * array.combination(n) -> new_enumerator
* *
* Calls the block, if given, with combinations of elements of +self+; * Calls the block, if given, with combinations of elements of +self+;
* returns +self+. The order of combinations is indeterminate. * returns +self+. The order of combinations is indeterminate.
@ -7252,8 +7252,6 @@ rb_ary_drop_while(VALUE ary)
* *
* Returns +true+ if any element of +self+ meets a given criterion. * Returns +true+ if any element of +self+ meets a given criterion.
* *
* The argument, if given, must have instance method <tt>===</tt>.
*
* With no block given and no argument, returns +true+ if +self+ has any truthy element, * With no block given and no argument, returns +true+ if +self+ has any truthy element,
* +false+ otherwise: * +false+ otherwise:
* [nil, 0, false].any? # => true * [nil, 0, false].any? # => true
@ -7265,9 +7263,6 @@ rb_ary_drop_while(VALUE ary)
* [0, 1, 2].any? {|element| element > 1 } # => true * [0, 1, 2].any? {|element| element > 1 } # => true
* [0, 1, 2].any? {|element| element > 2 } # => false * [0, 1, 2].any? {|element| element > 2 } # => false
* *
* Does not call the block if +self+ is empty:
* [].any? {|element| fail 'Cannot happen' } # => false
*
* If argument +obj+ is given, returns +true+ if +obj+.<tt>===</tt> any element, * If argument +obj+ is given, returns +true+ if +obj+.<tt>===</tt> any element,
* +false+ otherwise: * +false+ otherwise:
* ['food', 'drink'].any?(/foo/) # => true * ['food', 'drink'].any?(/foo/) # => true
@ -7276,17 +7271,7 @@ rb_ary_drop_while(VALUE ary)
* [0, 1, 2].any?(1) # => true * [0, 1, 2].any?(1) # => true
* [0, 1, 2].any?(3) # => false * [0, 1, 2].any?(3) # => false
* *
* Issues a warning ('given block not used') * Related: Enumerable#any?
* if both an argument and a block given:
* [0, 1, 2].any?(/foo/) {|element|} # => false
*
* See also Enumerable#any?
*
* ---
*
* Raises an exception if the argument does not have instance method <tt>===</tt>:
* # Raises NoMethodError (undefined method `===' for #<BasicObject:>):
* [0, 1, 2].any?(BasicObject.new)
*/ */
static VALUE static VALUE
@ -7325,8 +7310,6 @@ rb_ary_any_p(int argc, VALUE *argv, VALUE ary)
* *
* Returns +true+ if all elements of +self+ meet a given criterion. * Returns +true+ if all elements of +self+ meet a given criterion.
* *
* The argument, if given, must have instance method <tt>===</tt>.
*
* With no block given and no argument, returns +true+ if +self+ contains only truthy elements, * With no block given and no argument, returns +true+ if +self+ contains only truthy elements,
* +false+ otherwise: * +false+ otherwise:
* [0, 1, :foo].all? # => true * [0, 1, :foo].all? # => true
@ -7338,9 +7321,6 @@ rb_ary_any_p(int argc, VALUE *argv, VALUE ary)
* [0, 1, 2].all? { |element| element < 3 } # => true * [0, 1, 2].all? { |element| element < 3 } # => true
* [0, 1, 2].all? { |element| element < 2 } # => false * [0, 1, 2].all? { |element| element < 2 } # => false
* *
* Does not call the block if +self+ is empty:
* [].all? { |element| fail 'Cannot happen' } # => true
*
* If argument +obj+ is given, returns +true+ if <tt>obj.===</tt> every element, +false+ otherwise: * If argument +obj+ is given, returns +true+ if <tt>obj.===</tt> every element, +false+ otherwise:
* ['food', 'fool', 'foot'].all?(/foo/) # => true * ['food', 'fool', 'foot'].all?(/foo/) # => true
* ['food', 'drink'].all?(/bar/) # => false * ['food', 'drink'].all?(/bar/) # => false
@ -7348,18 +7328,7 @@ rb_ary_any_p(int argc, VALUE *argv, VALUE ary)
* [0, 0, 0].all?(0) # => true * [0, 0, 0].all?(0) # => true
* [0, 1, 2].all?(1) # => false * [0, 1, 2].all?(1) # => false
* *
* Issues a warning ('warning: given block not used') if both an argument and a block given: * Related: Enumerable#all?
* [0, 1, 2].all?(/foo/) { |element|} # => false
*
* See also Enumerable#all?
*
* ---
*
* Raises an exception if the argument does not have instance method <tt>===<tt/>:
* # Raises NoMethodError (undefined method `===' for #<BasicObject:>):
* [0, 1, 2].all?(BasicObject.new)
*
* See also Enumerable#all?
*/ */
static VALUE static VALUE
@ -7398,8 +7367,6 @@ rb_ary_all_p(int argc, VALUE *argv, VALUE ary)
* *
* Returns +true+ if no element of +self+ meet a given criterion. * Returns +true+ if no element of +self+ meet a given criterion.
* *
* The argument, if given, must have instance method <tt>===</tt>.
*
* With no block given and no argument, returns +true+ if +self+ has no truthy elements, * With no block given and no argument, returns +true+ if +self+ has no truthy elements,
* +false+ otherwise: * +false+ otherwise:
* [nil, false].none? # => true * [nil, false].none? # => true
@ -7411,9 +7378,6 @@ rb_ary_all_p(int argc, VALUE *argv, VALUE ary)
* [0, 1, 2].none? {|element| element > 3 } # => true * [0, 1, 2].none? {|element| element > 3 } # => true
* [0, 1, 2].none? {|element| element > 1 } # => false * [0, 1, 2].none? {|element| element > 1 } # => false
* *
* Does not call the block if +self+ is empty:
* [].none? {|element| fail 'Cannot happen' } # => true
*
* If argument +obj+ is given, returns +true+ if <tt>obj.===</tt> no element, +false+ otherwise: * If argument +obj+ is given, returns +true+ if <tt>obj.===</tt> no element, +false+ otherwise:
* ['food', 'drink'].none?(/bar/) # => true * ['food', 'drink'].none?(/bar/) # => true
* ['food', 'drink'].none?(/foo/) # => false * ['food', 'drink'].none?(/foo/) # => false
@ -7421,10 +7385,7 @@ rb_ary_all_p(int argc, VALUE *argv, VALUE ary)
* [0, 1, 2].none?(3) # => true * [0, 1, 2].none?(3) # => true
* [0, 1, 2].none?(1) # => false * [0, 1, 2].none?(1) # => false
* *
* Issues a warning ('given block not used') if both an argument and a block given: * Related: Enumerable#none?
* [0, 1, 2].none?(/foo/) { |element| } # => true
*
* See also Enumerable#none?
*/ */
static VALUE static VALUE
@ -7463,8 +7424,6 @@ rb_ary_none_p(int argc, VALUE *argv, VALUE ary)
* *
* Returns +true+ if exactly one element of +self+ meets a given criterion. * Returns +true+ if exactly one element of +self+ meets a given criterion.
* *
* The argument, if given, must have instance method <tt>===</tt>.
*
* With no block given and no argument, returns +true+ if +self+ has exactly one truthy element, * With no block given and no argument, returns +true+ if +self+ has exactly one truthy element,
* +false+ otherwise: * +false+ otherwise:
* [nil, 0].one? # => true * [nil, 0].one? # => true
@ -7478,9 +7437,6 @@ rb_ary_none_p(int argc, VALUE *argv, VALUE ary)
* [0, 1, 2].one? {|element| element > 1 } # => true * [0, 1, 2].one? {|element| element > 1 } # => true
* [0, 1, 2].one? {|element| element > 2 } # => false * [0, 1, 2].one? {|element| element > 2 } # => false
* *
* Does not call the block if +self+ is empty:
* [].one? {|element| fail 'Cannot happen' } # => false
*
* If argument +obj+ is given, returns +true+ if <tt>obj.===</tt> exactly one element, * If argument +obj+ is given, returns +true+ if <tt>obj.===</tt> exactly one element,
* +false+ otherwise: * +false+ otherwise:
* [0, 1, 2].one?(0) # => true * [0, 1, 2].one?(0) # => true
@ -7490,10 +7446,7 @@ rb_ary_none_p(int argc, VALUE *argv, VALUE ary)
* ['food', 'drink'].one?(/foo/) # => true * ['food', 'drink'].one?(/foo/) # => true
* [].one?(/foo/) # => false * [].one?(/foo/) # => false
* *
* Issues a warning ('given block not used') if both an argument and a block given: * Related: Enumerable#one?
* [0, 1, 2].one?(/foo/) { |element| } # => false
*
* See also Enumerable#none?
*/ */
static VALUE static VALUE
@ -7583,44 +7536,35 @@ finish_exact_sum(long n, VALUE r, VALUE v, int z)
/* /*
* call-seq: * call-seq:
* ary.sum(init=0) -> number * array.sum(init = 0) -> object
* ary.sum(init=0) {|e| expr } -> number * array.sum(init = 0) {|element| ... } -> object
* *
* Returns the sum of elements. * When no block is given, returns the object equivalent to:
* For example, [e1, e2, e3].sum returns init + e1 + e2 + e3. * sum = init
* array.each {|element| sum += element }
* sum
* For example, <tt>[e1, e2, e3].sum</tt> returns </tt>init + e1 + e2 + e3</tt>.
* *
* If a block is given, the block is applied to each element * Examples:
* before addition. * a = [0, 1, 2, 3]
* a.sum # => 6
* a.sum(100) # => 106
* *
* If <i>ary</i> is empty, it returns <i>init</i>. * The elements need not be numeric, but must be <tt>+</tt>-compatible
* with each other and with +init+:
* a = ['abc', 'def', 'ghi']
* a.sum('jkl') # => "jklabcdefghi"
* *
* [].sum #=> 0 * When a block is given, it is called with each element
* [].sum(0.0) #=> 0.0 * and the block's return value (instead of the element itself) is used as the addend:
* [1, 2, 3].sum #=> 6 * a = ['zero', 1, :two]
* [3, 5.5].sum #=> 8.5 * s = a.sum('Coerced and concatenated: ') {|element| element.to_s }
* [2.5, 3.0].sum(0.0) {|e| e * e } #=> 15.25 * s # => "Coerced and concatenated: zero1two"
* [Object.new].sum #=> TypeError
*
* The (arithmetic) mean value of an array can be obtained as follows.
*
* mean = ary.sum(0.0) / ary.length
*
* This method can be used for non-numeric objects by
* explicit <i>init</i> argument.
*
* ["a", "b", "c"].sum("") #=> "abc"
* [[1], [[2]], [3]].sum([]) #=> [1, [2], 3]
*
* However, Array#join and Array#flatten is faster than Array#sum for
* array of strings and array of arrays.
*
* ["a", "b", "c"].join #=> "abc"
* [[1], [[2]], [3]].flatten(1) #=> [1, [2], 3]
*
*
* Array#sum method may not respect method redefinition of "+" methods
* such as Integer#+.
* *
* Notes:
* - Array#join and Array#flatten may be faster than Array#sum
* for an \Array of Strings or an \Array of Arrays.
* - Array#sum method may not respect method redefinition of "+" methods such as Integer#+.
*/ */
static VALUE static VALUE

Просмотреть файл

@ -1,59 +1,56 @@
class Array class Array
# call-seq: # call-seq:
# ary.shuffle! -> ary # array.shuffle!(random: Random) -> array
# ary.shuffle!(random: rng) -> ary
# #
# Shuffles elements in +self+ in place. # Shuffles the elements of +self+ in place.
# # a = [1, 2, 3] #=> [1, 2, 3]
# a = [ 1, 2, 3 ] #=> [1, 2, 3] # a.shuffle! #=> [2, 3, 1]
# a.shuffle! #=> [2, 3, 1]
# a #=> [2, 3, 1]
#
# The optional +rng+ argument will be used as the random number generator.
# #
# The optional +random+ argument will be used as the random number generator:
# a.shuffle!(random: Random.new(1)) #=> [1, 3, 2] # a.shuffle!(random: Random.new(1)) #=> [1, 3, 2]
def shuffle!(random: Random) def shuffle!(random: Random)
Primitive.rb_ary_shuffle_bang(random) Primitive.rb_ary_shuffle_bang(random)
end end
# call-seq: # call-seq:
# ary.shuffle -> new_ary # array.shuffle(random: Random) -> new_ary
# ary.shuffle(random: rng) -> new_ary
# #
# Returns a new array with elements of +self+ shuffled. # 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 ] #=> [1, 2, 3] # The optional +random+ argument will be used as the random number generator:
# 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] # a.shuffle(random: Random.new(1)) #=> [1, 3, 2]
def shuffle(random: Random) def shuffle(random: Random)
Primitive.rb_ary_shuffle(random) Primitive.rb_ary_shuffle(random)
end end
# call-seq: # call-seq:
# ary.sample -> obj # array.sample(random: Random) -> object
# ary.sample(random: rng) -> obj # array.sample(n, random: Random) -> new_ary
# ary.sample(n) -> new_ary
# ary.sample(n, random: rng) -> new_ary
# #
# Choose a random element or +n+ random elements from the array. # Returns random elements from +self+.
# #
# The elements are chosen by using random and unique indices into the array # When no arguments are given, returns a random element from +self+:
# in order to ensure that an element doesn't repeat itself unless the array # a = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
# already contained duplicate elements. # a.sample # => 3
# a.sample # => 8
# If +self+ is empty, returns +nil+.
# #
# If the array is empty the first form returns +nil+ and the second form # When argument +n+ is given (but not keyword argument +random+),
# returns an empty array. # returns a new \Array containing +n+ random elements from +self+:
# # a.sample(3) # => [8, 9, 2]
# a = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ] # a.sample(6) # => [9, 6, 10, 3, 1, 4]
# a.sample #=> 7 # Returns no more than <tt>a.size</tt> elements
# a.sample(4) #=> [6, 4, 2, 5] # (because no new duplicates are introduced):
# # a.sample(a.size * 2) # => [6, 4, 1, 8, 5, 9, 10, 2, 3, 7]
# The optional +rng+ argument will be used as the random number generator. # 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(random: Random.new(1)) #=> 6
# a.sample(4, random: Random.new(1)) #=> [6, 10, 9, 2] # a.sample(4, random: Random.new(1)) #=> [6, 10, 9, 2]
def sample(n = (ary = false), random: Random) def sample(n = (ary = false), random: Random)