1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

* lib/set.rb: [DOC] add documentation that Set#{delete_if,keep_if,collect!,reject!,select!,

Browse Source 
classify,divide} without block returns an enumerator.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@54904 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
ktsj 2016-05-04 09:07:01 +00:00
parent 80ccb8e86f
commit 60287eab74
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/set.rb
View File

@ -335,7 +335,8 @@ class Set
end end
# Deletes every element of the set for which block evaluates to # Deletes every element of the set for which block evaluates to
# true, and returns self. # true, and returns self. Returns an enumerator if no block is
# given.
def delete_if def delete_if
block_given? or return enum_for(__method__) { size } block_given? or return enum_for(__method__) { size }
# @hash.delete_if should be faster, but using it breaks the order # @hash.delete_if should be faster, but using it breaks the order
@ -345,7 +346,8 @@ class Set
end end
# Deletes every element of the set for which block evaluates to # Deletes every element of the set for which block evaluates to
# false, and returns self. # false, and returns self. Returns an enumerator if no block is
# given.
def keep_if def keep_if
block_given? or return enum_for(__method__) { size } block_given? or return enum_for(__method__) { size }
# @hash.keep_if should be faster, but using it breaks the order of # @hash.keep_if should be faster, but using it breaks the order of
@ -355,6 +357,7 @@ class Set
end end
# Replaces the elements with ones returned by collect(). # Replaces the elements with ones returned by collect().
# Returns an enumerator if no block is given.
def collect! def collect!
block_given? or return enum_for(__method__) { size } block_given? or return enum_for(__method__) { size }
replace(self.class.new(self) { |o| yield(o) }) replace(self.class.new(self) { |o| yield(o) })
@ -362,7 +365,7 @@ class Set
alias map! collect! alias map! collect!
# Equivalent to Set#delete_if, but returns nil if no changes were # Equivalent to Set#delete_if, but returns nil if no changes were
# made. # made. Returns an enumerator if no block is given.
def reject!(&block) def reject!(&block)
block or return enum_for(__method__) { size } block or return enum_for(__method__) { size }
n = size n = size
@ -371,7 +374,7 @@ class Set
end end
# Equivalent to Set#keep_if, but returns nil if no changes were # Equivalent to Set#keep_if, but returns nil if no changes were
# made. # made. Returns an enumerator if no block is given.
def select!(&block) def select!(&block)
block or return enum_for(__method__) { size } block or return enum_for(__method__) { size }
n = size n = size
@ -467,6 +470,8 @@ class Set
# p hash # => {2000=>#<Set: {"a.rb", "b.rb"}>, # p hash # => {2000=>#<Set: {"a.rb", "b.rb"}>,
# # 2001=>#<Set: {"c.rb", "d.rb", "e.rb"}>, # # 2001=>#<Set: {"c.rb", "d.rb", "e.rb"}>,
# # 2002=>#<Set: {"f.rb"}>} # # 2002=>#<Set: {"f.rb"}>}
#
# Returns an enumerator if no block is given.
def classify # :yields: o def classify # :yields: o
block_given? or return enum_for(__method__) { size } block_given? or return enum_for(__method__) { size }
@ -495,6 +500,8 @@ class Set
# # #<Set: {11, 9, 10}>, # # #<Set: {11, 9, 10}>,
# # #<Set: {3, 4}>, # # #<Set: {3, 4}>,
# # #<Set: {6}>}> # # #<Set: {6}>}>
#
# Returns an enumerator if no block is given.
def divide(&func) def divide(&func)
func or return enum_for(__method__) { size } func or return enum_for(__method__) { size }