Set implements a collection of unordered values with no duplicates. This is a hybrid of Array's intuitive inter-operation facilities and Hash's fast lookup.
The equality of each couple of elements is determined according to Object#eql? and Object#hash, since Set uses Hash as storage.
Set is easy to use with Enumerable objects (implementing
each). Most of the initializer methods and binary operators
accept generic Enumerable objects besides
sets and arrays. An Enumerable object can be
converted to Set using the to_set
method.
Example
require 'set'
s1 = Set.new [1, 2] # -> #<Set: {1, 2}>
s2 = [1, 2].to_set # -> #<Set: {1, 2}>
s1 == s2 # -> true
s1.add("foo") # -> #<Set: {1, 2, "foo"}>
s1.merge([2, 6]) # -> #<Set: {6, 1, 2, "foo"}>
s1.subset? s2 # -> false
s2.subset? s1 # -> true
Contact
- Akinori MUSHA <knu@iDaemons.org> (current maintainer)- #
- A
- C
- D
- E
- F
- I
- K
- L
- M
- N
- P
- R
- S
- T
- U
- #
| InspectKey | = | :__inspect_key__ |
Creates a new set containing the given objects.
Creates a new set containing the elements of the given enumerable object.
If a block is given, the elements of enum are preprocessed by the given block.
Returns a new set containing elements common to the set and the given enumerable object.
Returns a new set built by duplicating the set, removing every element that appears in the given enumerable object.
Returns true if two sets are equal. The equality of each couple of elements is defined according to Object#eql?.
Returns a new set containing elements exclusive between the set and the given enumerable object. (set ^ enum) is equivalent to ((set | enum) - (set & enum)).
Adds the given object to the set and returns self. Use merge
to add many elements at once.
Adds the given object to the set and returns self. If the object is already in the set, returns nil.
Classifies the set by the return value of the given block and returns a hash of {value => set of elements} pairs. The block is called once for each element of the set, passing the element as parameter.
e.g.:
require 'set'
files = Set.new(Dir.glob("*.rb"))
hash = files.classify { |f| File.mtime(f).year }
p hash # => {2000=>#<Set: {"a.rb", "b.rb"}>,
# 2001=>#<Set: {"c.rb", "d.rb", "e.rb"}>,
# 2002=>#<Set: {"f.rb"}>}
Removes all elements and returns self.
Deletes the given object from the set and returns self. Use
subtract to delete many items at once.
Deletes the given object from the set and returns self. If the object is not in the set, returns nil.
Deletes every element of the set for which block evaluates to true, and returns self.
Divides the set into a set of subsets according to the commonality defined by the given block.
If the arity of the block is 2, elements o1 and o2 are in common if block.call(o1, o2) is true. Otherwise, elements o1 and o2 are in common if block.call(o1) == block.call(o2).
e.g.:
require 'set'
numbers = Set[1, 3, 4, 6, 9, 10, 11]
set = numbers.divide { |i,j| (i - j).abs == 1 }
p set # => #<Set: {#<Set: {1}>,
# #<Set: {11, 9, 10}>,
# #<Set: {3, 4}>,
# #<Set: {6}>}>
# File ../ruby/lib/set.rb, line 421 def divide(&func) func or return enum_for(__method__) if func.arity == 2 require 'tsort' class << dig = {} # :nodoc: include TSort alias tsort_each_node each_key def tsort_each_child(node, &block) fetch(node).each(&block) end end each { |u| dig[u] = a = [] each{ |v| func.call(u, v) and a << v } } set = Set.new() dig.each_strongly_connected_component { |css| set.add(self.class.new(css)) } set else Set.new(classify(&func).values) end end
Calls the given block once for each element in the set, passing the element as parameter. Returns an enumerator if no block is given.
Returns true if the set contains no elements.
Returns a new set that is a copy of the set, flattening each containing set recursively.
Equivalent to #flatten, but replaces the receiver with the result in place. Returns nil if no modifications were made.
Copy internal hash.
Returns a string containing a human-readable representation of the set. (“#<Set: {element1, element2, …}>”)
# File ../ruby/lib/set.rb, line 455 def inspect ids = (Thread.current[InspectKey] ||= []) if ids.include?(object_id) return sprintf('#<%s: {...}>', self.class.name) end begin ids << object_id return sprintf('#<%s: {%s}>', self.class, to_a.inspect[1..-2]) ensure ids.pop end end
Deletes every element of the set for which block evaluates to false, and returns self.
Merges the elements of the given enumerable object to the set and returns self.
Returns true if the set is a proper subset of the given set.
Returns true if the set is a proper superset of the given set.
Equivalent to #delete_if, but returns nil if no changes were made.
Replaces the contents of the set with the contents of the given enumerable object and returns self.
Returns true if the set is a subset of the given set.
Deletes every element that appears in the given enumerable object and returns self.
Returns true if the set is a superset of the given set.
Converts the set to an array. The order of elements is uncertain.