Class: Set
Overview
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.
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.
Set uses Hash as storage, so you must note the following points:
-
Equality of elements is determined according to Object#eql? and Object#hash.
-
Set assumes that the identity of each element does not change while it is stored. Modifying an element of a set will render the set to an unreliable state.
-
When a string is to be stored, a frozen copy of the string is stored instead unless the original string is already frozen.
Comparison
The comparison operators <, >, <= and >= are implemented as shorthand for the proper_,subset?,superset? methods. However, the <=> operator is intentionally left out because not every pair of sets is comparable. (x,y vs. x,z for example)
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: {1, 2, "foo", 6}>
s1.subset? s2 # -> false
s2.subset? s1 # -> true
Contact
- Akinori MUSHA <[email protected]> (current maintainer)
Direct Known Subclasses
Constant Summary collapse
- InspectKey =
:nodoc:
:__inspect_key__
Class Method Summary collapse
-
.[](*ary) ⇒ Object
Creates a new set containing the given objects.
Instance Method Summary collapse
-
#&(enum) ⇒ Object
(also: #intersection)
Returns a new set containing elements common to the set and the given enumerable object.
-
#-(enum) ⇒ Object
(also: #difference)
Returns a new set built by duplicating the set, removing every element that appears in the given enumerable object.
-
#==(other) ⇒ Object
Returns true if two sets are equal.
-
#^(enum) ⇒ Object
Returns a new set containing elements exclusive between the set and the given enumerable object.
-
#add(o) ⇒ Object
(also: #<<)
Adds the given object to the set and returns self.
-
#add?(o) ⇒ Boolean
Adds the given object to the set and returns self.
-
#classify ⇒ Object
Classifies the set by the return value of the given block and returns a hash of => set of elements pairs.
-
#clear ⇒ Object
Removes all elements and returns self.
-
#collect! ⇒ Object
(also: #map!)
Replaces the elements with ones returned by collect().
-
#delete(o) ⇒ Object
Deletes the given object from the set and returns self.
-
#delete?(o) ⇒ Boolean
Deletes the given object from the set and returns self.
-
#delete_if ⇒ Object
Deletes every element of the set for which block evaluates to true, and returns self.
-
#disjoint?(set) ⇒ Boolean
Returns true if the set and the given set have no element in common.
-
#divide(&func) ⇒ Object
Divides the set into a set of subsets according to the commonality defined by the given block.
-
#each(&block) ⇒ Object
Calls the given block once for each element in the set, passing the element as parameter.
-
#empty? ⇒ Boolean
Returns true if the set contains no elements.
-
#eql?(o) ⇒ Boolean
:nodoc:.
-
#flatten ⇒ Object
Returns a new set that is a copy of the set, flattening each containing set recursively.
-
#flatten! ⇒ Object
Equivalent to Set#flatten, but replaces the receiver with the result in place.
-
#freeze ⇒ Object
:nodoc:.
-
#hash ⇒ Object
:nodoc:.
-
#include?(o) ⇒ Boolean
(also: #member?)
Returns true if the set contains the given object.
-
#initialize(enum = nil, &block) ⇒ Set
constructor
Creates a new set containing the elements of the given enumerable object.
-
#initialize_clone(orig) ⇒ Object
Clone internal hash.
-
#initialize_dup(orig) ⇒ Object
Dup internal hash.
-
#inspect ⇒ Object
Returns a string containing a human-readable representation of the set.
-
#intersect?(set) ⇒ Boolean
Returns true if the set and the given set have at least one element in common.
-
#keep_if ⇒ Object
Deletes every element of the set for which block evaluates to false, and returns self.
-
#merge(enum) ⇒ Object
Merges the elements of the given enumerable object to the set and returns self.
-
#pretty_print(pp) ⇒ Object
:nodoc:.
-
#pretty_print_cycle(pp) ⇒ Object
:nodoc:.
-
#proper_subset?(set) ⇒ Boolean
(also: #<)
Returns true if the set is a proper subset of the given set.
-
#proper_superset?(set) ⇒ Boolean
(also: #>)
Returns true if the set is a proper superset of the given set.
-
#reject!(&block) ⇒ Object
Equivalent to Set#delete_if, but returns nil if no changes were made.
-
#replace(enum) ⇒ Object
Replaces the contents of the set with the contents of the given enumerable object and returns self.
-
#select!(&block) ⇒ Object
Equivalent to Set#keep_if, but returns nil if no changes were made.
-
#size ⇒ Object
(also: #length)
Returns the number of elements.
-
#subset?(set) ⇒ Boolean
(also: #<=)
Returns true if the set is a subset of the given set.
-
#subtract(enum) ⇒ Object
Deletes every element that appears in the given enumerable object and returns self.
-
#superset?(set) ⇒ Boolean
(also: #>=)
Returns true if the set is a superset of the given set.
-
#taint ⇒ Object
:nodoc:.
-
#to_a ⇒ Object
Converts the set to an array.
-
#to_set(klass = Set, *args, &block) ⇒ Object
Returns self if no arguments are given.
-
#untaint ⇒ Object
:nodoc:.
-
#|(enum) ⇒ Object
(also: #+, #union)
Returns a new set built by merging the set and the elements of the given enumerable object.
Constructor Details
#initialize(enum = nil, &block) ⇒ Set
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.
82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/set.rb', line 82 def initialize(enum = nil, &block) # :yields: o @hash ||= Hash.new(false) enum.nil? and return if block do_with_enum(enum) { |o| add(block[o]) } else merge(enum) end end |
Class Method Details
.[](*ary) ⇒ Object
Creates a new set containing the given objects.
73 74 75 |
# File 'lib/set.rb', line 73 def self.[](*ary) new(ary) end |
Instance Method Details
#&(enum) ⇒ Object Also known as: intersection
Returns a new set containing elements common to the set and the given enumerable object.
418 419 420 421 422 |
# File 'lib/set.rb', line 418 def &(enum) n = self.class.new do_with_enum(enum) { |o| n.add(o) if include?(o) } n end |
#-(enum) ⇒ Object Also known as: difference
Returns a new set built by duplicating the set, removing every element that appears in the given enumerable object.
411 412 413 |
# File 'lib/set.rb', line 411 def -(enum) dup.subtract(enum) end |
#==(other) ⇒ Object
Returns true if two sets are equal. The equality of each couple of elements is defined according to Object#eql?.
436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/set.rb', line 436 def ==(other) if self.equal?(other) true elsif other.instance_of?(self.class) @hash == other.instance_variable_get(:@hash) elsif other.is_a?(Set) && self.size == other.size other.all? { |o| @hash.include?(o) } else false end end |
#^(enum) ⇒ Object
Returns a new set containing elements exclusive between the set and the given enumerable object. (set ^ enum) is equivalent to ((set | enum) - (set & enum)).
428 429 430 431 432 |
# File 'lib/set.rb', line 428 def ^(enum) n = Set.new(enum) each { |o| n.add(o) unless n.delete?(o) } n end |
#add(o) ⇒ Object Also known as: <<
Adds the given object to the set and returns self. Use merge
to add many elements at once.
312 313 314 315 |
# File 'lib/set.rb', line 312 def add(o) @hash[o] = true self end |
#add?(o) ⇒ Boolean
Adds the given object to the set and returns self. If the object is already in the set, returns nil.
320 321 322 |
# File 'lib/set.rb', line 320 def add?(o) add(o) unless include?(o) end |
#classify ⇒ Object
Classifies the set by the return value of the given block and returns a hash of => 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"}>}
470 471 472 473 474 475 476 477 478 479 480 |
# File 'lib/set.rb', line 470 def classify # :yields: o block_given? or return enum_for(__method__) h = {} each { |i| (h[yield(i)] ||= self.class.new).add(i) } h end |
#clear ⇒ Object
Removes all elements and returns self.
144 145 146 147 |
# File 'lib/set.rb', line 144 def clear @hash.clear self end |
#collect! ⇒ Object Also known as: map!
Replaces the elements with ones returned by collect().
358 359 360 361 |
# File 'lib/set.rb', line 358 def collect! block_given? or return enum_for(__method__) replace(self.class.new(self) { |o| yield(o) }) end |
#delete(o) ⇒ Object
Deletes the given object from the set and returns self. Use subtract
to delete many items at once.
326 327 328 329 |
# File 'lib/set.rb', line 326 def delete(o) @hash.delete(o) self end |
#delete?(o) ⇒ Boolean
Deletes the given object from the set and returns self. If the object is not in the set, returns nil.
333 334 335 |
# File 'lib/set.rb', line 333 def delete?(o) delete(o) if include?(o) end |
#delete_if ⇒ Object
Deletes every element of the set for which block evaluates to true, and returns self.
339 340 341 342 343 344 345 |
# File 'lib/set.rb', line 339 def delete_if block_given? or return enum_for(__method__) # @hash.delete_if should be faster, but using it breaks the order # of enumeration in subclasses. select { |o| yield o }.each { |o| @hash.delete(o) } self end |
#disjoint?(set) ⇒ Boolean
297 298 299 |
# File 'lib/set.rb', line 297 def disjoint?(set) !intersect?(set) end |
#divide(&func) ⇒ Object
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}>}>
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 |
# File 'lib/set.rb', line 498 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 |
#each(&block) ⇒ Object
Calls the given block once for each element in the set, passing the element as parameter. Returns an enumerator if no block is given.
304 305 306 307 308 |
# File 'lib/set.rb', line 304 def each(&block) block or return enum_for(__method__) { size } @hash.each_key(&block) self end |
#empty? ⇒ Boolean
Returns true if the set contains no elements.
139 140 141 |
# File 'lib/set.rb', line 139 def empty? @hash.empty? end |
#eql?(o) ⇒ Boolean
:nodoc:
452 453 454 455 |
# File 'lib/set.rb', line 452 def eql?(o) # :nodoc: return false unless o.is_a?(Set) @hash.eql?(o.instance_variable_get(:@hash)) end |
#flatten ⇒ Object
Returns a new set that is a copy of the set, flattening each containing set recursively.
198 199 200 |
# File 'lib/set.rb', line 198 def flatten self.class.new.flatten_merge(self) end |
#flatten! ⇒ Object
Equivalent to Set#flatten, but replaces the receiver with the result in place. Returns nil if no modifications were made.
204 205 206 |
# File 'lib/set.rb', line 204 def flatten! replace(flatten()) if any? { |e| e.is_a?(Set) } end |
#freeze ⇒ Object
:nodoc:
117 118 119 120 |
# File 'lib/set.rb', line 117 def freeze # :nodoc: @hash.freeze super end |
#hash ⇒ Object
:nodoc:
448 449 450 |
# File 'lib/set.rb', line 448 def hash # :nodoc: @hash.hash end |
#include?(o) ⇒ Boolean Also known as: member?
Returns true if the set contains the given object.
Note that include?
and member?
do not test member equality using ==
as do other Enumerables.
See also Enumerable#include?
214 215 216 |
# File 'lib/set.rb', line 214 def include?(o) @hash[o] end |
#initialize_clone(orig) ⇒ Object
Clone internal hash.
112 113 114 115 |
# File 'lib/set.rb', line 112 def initialize_clone(orig) super @hash = orig.instance_variable_get(:@hash).clone end |
#initialize_dup(orig) ⇒ Object
Dup internal hash.
106 107 108 109 |
# File 'lib/set.rb', line 106 def initialize_dup(orig) super @hash = orig.instance_variable_get(:@hash).dup end |
#inspect ⇒ Object
Returns a string containing a human-readable representation of the set. (“#<Set: element2, …>”)
532 533 534 535 536 537 538 539 540 541 542 543 544 545 |
# File 'lib/set.rb', line 532 def inspect ids = (Thread.current[InspectKey] ||= []) if ids.include?(object_id) return sprintf('#<%s: {...}>', self.class.name) end ids << object_id begin return sprintf('#<%s: {%s}>', self.class, to_a.inspect[1..-2]) ensure ids.pop end end |
#intersect?(set) ⇒ Boolean
279 280 281 282 283 284 285 286 |
# File 'lib/set.rb', line 279 def intersect?(set) set.is_a?(Set) or raise ArgumentError, "value must be a set" if size < set.size any? { |o| set.include?(o) } else set.any? { |o| include?(o) } end end |
#keep_if ⇒ Object
Deletes every element of the set for which block evaluates to false, and returns self.
349 350 351 352 353 354 355 |
# File 'lib/set.rb', line 349 def keep_if block_given? or return enum_for(__method__) # @hash.keep_if should be faster, but using it breaks the order of # enumeration in subclasses. reject { |o| yield o }.each { |o| @hash.delete(o) } self end |
#merge(enum) ⇒ Object
Merges the elements of the given enumerable object to the set and returns self.
384 385 386 387 388 389 390 391 392 |
# File 'lib/set.rb', line 384 def merge(enum) if enum.instance_of?(self.class) @hash.update(enum.instance_variable_get(:@hash)) else do_with_enum(enum) { |o| add(o) } end self end |
#pretty_print(pp) ⇒ Object
:nodoc:
547 548 549 550 551 552 553 554 555 |
# File 'lib/set.rb', line 547 def pretty_print(pp) # :nodoc: pp.text sprintf('#<%s: {', self.class.name) pp.nest(1) { pp.seplist(self) { |o| pp.pp o } } pp.text "}>" end |
#pretty_print_cycle(pp) ⇒ Object
:nodoc:
557 558 559 |
# File 'lib/set.rb', line 557 def pretty_print_cycle(pp) # :nodoc: pp.text sprintf('#<%s: {%s}>', self.class.name, empty? ? '' : '...') end |
#proper_subset?(set) ⇒ Boolean Also known as: <
Returns true if the set is a proper subset of the given set.
259 260 261 262 263 264 265 266 267 268 |
# File 'lib/set.rb', line 259 def proper_subset?(set) case when set.instance_of?(self.class) @hash < set.instance_variable_get(:@hash) when set.is_a?(Set) size < set.size && all? { |o| set.include?(o) } else raise ArgumentError, "value must be a set" end end |
#proper_superset?(set) ⇒ Boolean Also known as: >
Returns true if the set is a proper superset of the given set.
233 234 235 236 237 238 239 240 241 242 |
# File 'lib/set.rb', line 233 def proper_superset?(set) case when set.instance_of?(self.class) @hash > set.instance_variable_get(:@hash) when set.is_a?(Set) size > set.size && set.all? { |o| include?(o) } else raise ArgumentError, "value must be a set" end end |
#reject!(&block) ⇒ Object
Equivalent to Set#delete_if, but returns nil if no changes were made.
366 367 368 369 370 371 |
# File 'lib/set.rb', line 366 def reject!(&block) block or return enum_for(__method__) n = size delete_if(&block) self if size != n end |
#replace(enum) ⇒ Object
Replaces the contents of the set with the contents of the given enumerable object and returns self.
151 152 153 154 155 156 157 158 159 160 |
# File 'lib/set.rb', line 151 def replace(enum) if enum.instance_of?(self.class) @hash.replace(enum.instance_variable_get(:@hash)) self else do_with_enum(enum) # make sure enum is enumerable before calling clear clear merge(enum) end end |
#select!(&block) ⇒ Object
Equivalent to Set#keep_if, but returns nil if no changes were made.
375 376 377 378 379 380 |
# File 'lib/set.rb', line 375 def select!(&block) block or return enum_for(__method__) n = size keep_if(&block) self if size != n end |
#size ⇒ Object Also known as: length
Returns the number of elements.
133 134 135 |
# File 'lib/set.rb', line 133 def size @hash.size end |
#subset?(set) ⇒ Boolean Also known as: <=
Returns true if the set is a subset of the given set.
246 247 248 249 250 251 252 253 254 255 |
# File 'lib/set.rb', line 246 def subset?(set) case when set.instance_of?(self.class) @hash <= set.instance_variable_get(:@hash) when set.is_a?(Set) size <= set.size && all? { |o| set.include?(o) } else raise ArgumentError, "value must be a set" end end |
#subtract(enum) ⇒ Object
Deletes every element that appears in the given enumerable object and returns self.
396 397 398 399 |
# File 'lib/set.rb', line 396 def subtract(enum) do_with_enum(enum) { |o| delete(o) } self end |
#superset?(set) ⇒ Boolean Also known as: >=
Returns true if the set is a superset of the given set.
220 221 222 223 224 225 226 227 228 229 |
# File 'lib/set.rb', line 220 def superset?(set) case when set.instance_of?(self.class) @hash >= set.instance_variable_get(:@hash) when set.is_a?(Set) size >= set.size && set.all? { |o| include?(o) } else raise ArgumentError, "value must be a set" end end |
#taint ⇒ Object
:nodoc:
122 123 124 125 |
# File 'lib/set.rb', line 122 def taint # :nodoc: @hash.taint super end |
#to_a ⇒ Object
Converts the set to an array. The order of elements is uncertain.
163 164 165 |
# File 'lib/set.rb', line 163 def to_a @hash.keys end |
#to_set(klass = Set, *args, &block) ⇒ Object
Returns self if no arguments are given. Otherwise, converts the set to another with klass.new(self, *args, &block).
In subclasses, returns klass.new(self, *args, &block) unless overridden.
172 173 174 175 |
# File 'lib/set.rb', line 172 def to_set(klass = Set, *args, &block) return self if instance_of?(Set) && klass == Set && block.nil? && args.empty? klass.new(self, *args, &block) end |
#untaint ⇒ Object
:nodoc:
127 128 129 130 |
# File 'lib/set.rb', line 127 def untaint # :nodoc: @hash.untaint super end |
#|(enum) ⇒ Object Also known as: +, union
Returns a new set built by merging the set and the elements of the given enumerable object.
403 404 405 |
# File 'lib/set.rb', line 403 def |(enum) dup.merge(enum) end |