File: C:/Ruby27-x64/share/doc/ruby/html/Set.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Set - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#class-Set-label-Comparison">Comparison</a>
<li><a href="#class-Set-label-Example">Example</a>
<li><a href="#class-Set-label-Contact">Contact</a>
</ul>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Enumerable.html">Enumerable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-5B-5D">::[]</a>
<li ><a href="#method-c-json_create">::json_create</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-26">#&</a>
<li ><a href="#method-i-2B">#+</a>
<li ><a href="#method-i-2D">#-</a>
<li ><a href="#method-i-3C">#<</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-3C-3D">#<=</a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-3D-3D-3D">#===</a>
<li ><a href="#method-i-3E">#></a>
<li ><a href="#method-i-3E-3D">#>=</a>
<li ><a href="#method-i-5E">#^</a>
<li ><a href="#method-i-add">#add</a>
<li ><a href="#method-i-add-3F">#add?</a>
<li ><a href="#method-i-as_json">#as_json</a>
<li ><a href="#method-i-classify">#classify</a>
<li ><a href="#method-i-clear">#clear</a>
<li ><a href="#method-i-collect-21">#collect!</a>
<li ><a href="#method-i-compare_by_identity">#compare_by_identity</a>
<li ><a href="#method-i-compare_by_identity-3F">#compare_by_identity?</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-delete-3F">#delete?</a>
<li ><a href="#method-i-delete_if">#delete_if</a>
<li ><a href="#method-i-difference">#difference</a>
<li ><a href="#method-i-disjoint-3F">#disjoint?</a>
<li ><a href="#method-i-divide">#divide</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-filter-21">#filter!</a>
<li ><a href="#method-i-flatten">#flatten</a>
<li ><a href="#method-i-flatten-21">#flatten!</a>
<li ><a href="#method-i-include-3F">#include?</a>
<li class="calls-super" ><a href="#method-i-initialize_clone">#initialize_clone</a>
<li class="calls-super" ><a href="#method-i-initialize_dup">#initialize_dup</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-intersect-3F">#intersect?</a>
<li ><a href="#method-i-intersection">#intersection</a>
<li ><a href="#method-i-keep_if">#keep_if</a>
<li ><a href="#method-i-length">#length</a>
<li ><a href="#method-i-map-21">#map!</a>
<li ><a href="#method-i-member-3F">#member?</a>
<li ><a href="#method-i-merge">#merge</a>
<li ><a href="#method-i-proper_subset-3F">#proper_subset?</a>
<li ><a href="#method-i-proper_superset-3F">#proper_superset?</a>
<li ><a href="#method-i-reject-21">#reject!</a>
<li ><a href="#method-i-replace">#replace</a>
<li ><a href="#method-i-reset">#reset</a>
<li ><a href="#method-i-select-21">#select!</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-subset-3F">#subset?</a>
<li ><a href="#method-i-subtract">#subtract</a>
<li ><a href="#method-i-superset-3F">#superset?</a>
<li ><a href="#method-i-to_a">#to_a</a>
<li ><a href="#method-i-to_json">#to_json</a>
<li ><a href="#method-i-to_s">#to_s</a>
<li ><a href="#method-i-to_set">#to_set</a>
<li ><a href="#method-i-union">#union</a>
<li ><a href="#method-i-7C">#|</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Set">
<h1 id="class-Set" class="class">
class Set
</h1>
<section class="description">
<p><a href="Set.html"><code>Set</code></a> 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.</p>
<p><a href="Set.html"><code>Set</code></a> is easy to use with <a href="Enumerable.html"><code>Enumerable</code></a> objects (implementing <code>each</code>). Most of the initializer methods and binary operators accept generic <a href="Enumerable.html"><code>Enumerable</code></a> objects besides sets and arrays. An <a href="Enumerable.html"><code>Enumerable</code></a> object can be converted to <a href="Set.html"><code>Set</code></a> using the <code>to_set</code> method.</p>
<p><a href="Set.html"><code>Set</code></a> uses <a href="Hash.html"><code>Hash</code></a> as storage, so you must note the following points:</p>
<ul><li>
<p>Equality of elements is determined according to <a href="Object.html#method-i-eql-3F"><code>Object#eql?</code></a> and <a href="Object.html#method-i-hash"><code>Object#hash</code></a>. Use <a href="Set.html#method-i-compare_by_identity"><code>Set#compare_by_identity</code></a> to make a set compare its elements by their identity.</p>
</li><li>
<p><a href="Set.html"><code>Set</code></a> 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.</p>
</li><li>
<p>When a string is to be stored, a frozen copy of the string is stored instead unless the original string is already frozen.</p>
</li></ul>
<h2 id="class-Set-label-Comparison">Comparison<span><a href="#class-Set-label-Comparison">¶</a> <a href="#top">↑</a></span></h2>
<p>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).</p>
<h2 id="class-Set-label-Example">Example<span><a href="#class-Set-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'set'</span>
<span class="ruby-identifier">s1</span> = <span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>] <span class="ruby-comment">#=> #<Set: {1, 2}></span>
<span class="ruby-identifier">s2</span> = [<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">to_set</span> <span class="ruby-comment">#=> #<Set: {1, 2}></span>
<span class="ruby-identifier">s1</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">s2</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-identifier">s1</span>.<span class="ruby-identifier">add</span>(<span class="ruby-string">"foo"</span>) <span class="ruby-comment">#=> #<Set: {1, 2, "foo"}></span>
<span class="ruby-identifier">s1</span>.<span class="ruby-identifier">merge</span>([<span class="ruby-value">2</span>, <span class="ruby-value">6</span>]) <span class="ruby-comment">#=> #<Set: {1, 2, "foo", 6}></span>
<span class="ruby-identifier">s1</span>.<span class="ruby-identifier">subset?</span>(<span class="ruby-identifier">s2</span>) <span class="ruby-comment">#=> false</span>
<span class="ruby-identifier">s2</span>.<span class="ruby-identifier">subset?</span>(<span class="ruby-identifier">s1</span>) <span class="ruby-comment">#=> true</span>
</pre>
<h2 id="class-Set-label-Contact">Contact<span><a href="#class-Set-label-Contact">¶</a> <a href="#top">↑</a></span></h2>
<pre>- Akinori MUSHA <knu@iDaemons.org> (current maintainer)</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(*ary)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new set containing the given objects.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>] <span class="ruby-comment"># => #<Set: {1, 2}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">1</span>] <span class="ruby-comment"># => #<Set: {1, 2}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-string">'c'</span>, <span class="ruby-value">:s</span>] <span class="ruby-comment"># => #<Set: {1, "c", :s}></span>
</pre>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">ary</span>)
<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ary</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-json_create" class="method-detail ">
<div class="method-heading">
<span class="method-name">json_create</span><span
class="method-args">(object)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Import a <a href="JSON.html"><code>JSON</code></a> Marshalled object.</p>
<p>method used for <a href="JSON.html"><code>JSON</code></a> marshalling support.</p>
<div class="method-source-code" id="json_create-source">
<pre><span class="ruby-comment"># File ext/json/lib/json/add/set.rb, line 10</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">json_create</span>(<span class="ruby-identifier">object</span>)
<span class="ruby-identifier">new</span> <span class="ruby-identifier">object</span>[<span class="ruby-string">'a'</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(enum = nil) { |o| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new set containing the elements of the given enumerable object.</p>
<p>If a block is given, the elements of enum are preprocessed by the given block.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">1</span>, <span class="ruby-value">2</span>]) <span class="ruby-comment">#=> #<Set: {1, 2}></span>
<span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">1</span>]) <span class="ruby-comment">#=> #<Set: {1, 2}></span>
<span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">1</span>, <span class="ruby-string">'c'</span>, <span class="ruby-value">:s</span>]) <span class="ruby-comment">#=> #<Set: {1, "c", :s}></span>
<span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">5</span>) <span class="ruby-comment">#=> #<Set: {1, 2, 3, 4, 5}></span>
<span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>([<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>]) { <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span> <span class="ruby-operator">*</span> <span class="ruby-identifier">x</span> } <span class="ruby-comment">#=> #<Set: {1, 4, 9}></span>
</pre>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 93</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">enum</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-comment"># :yields: o</span>
<span class="ruby-ivar">@hash</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">false</span>)
<span class="ruby-identifier">enum</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">return</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">do_with_enum</span>(<span class="ruby-identifier">enum</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">block</span>[<span class="ruby-identifier">o</span>]) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-26" class="method-detail ">
<div class="method-heading">
<span class="method-name">&</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new set containing elements common to the set and the given enumerable object.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">3</span>, <span class="ruby-value">5</span>] <span class="ruby-operator">&</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">3</span>, <span class="ruby-value">2</span>, <span class="ruby-value">1</span>] <span class="ruby-comment">#=> #<Set: {3, 1}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-string">'a'</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'z'</span>] <span class="ruby-operator">&</span> [<span class="ruby-string">'a'</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'c'</span>] <span class="ruby-comment">#=> #<Set: {"a", "b"}></span>
</pre>
<div class="method-source-code" id="26-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 465</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">&</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-identifier">n</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">do_with_enum</span>(<span class="ruby-identifier">enum</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">o</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-intersection">intersection</a>
</div>
</div>
<div id="method-i-2B" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">+</span><span
class="method-args">(enum)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-7C">|</a>
</div>
</div>
<div id="method-i-2D" class="method-detail ">
<div class="method-heading">
<span class="method-name">-</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new set built by duplicating the set, removing every element that appears in the given enumerable object.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">3</span>, <span class="ruby-value">5</span>] <span class="ruby-operator">-</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">5</span>] <span class="ruby-comment">#=> #<Set: {3}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-string">'a'</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'z'</span>] <span class="ruby-operator">-</span> [<span class="ruby-string">'a'</span>, <span class="ruby-string">'c'</span>] <span class="ruby-comment">#=> #<Set: {"b", "z"}></span>
</pre>
<div class="method-source-code" id="2D-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 455</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">-</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">subtract</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-difference">difference</a>
</div>
</div>
<div id="method-i-3C" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name"><</span><span
class="method-args">(set)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-proper_subset-3F">proper_subset?</a>
</div>
</div>
<div id="method-i-3C-3C" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(o)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-add">add</a>
</div>
</div>
<div id="method-i-3C-3D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name"><=</span><span
class="method-args">(set)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-subset-3F">subset?</a>
</div>
</div>
<div id="method-i-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">==</span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if two sets are equal. The equality of each couple of elements is defined according to <a href="Object.html#method-i-eql-3F"><code>Object#eql?</code></a>.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">2</span>, <span class="ruby-value">1</span>] <span class="ruby-comment">#=> true</span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">3</span>, <span class="ruby-value">5</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">5</span>] <span class="ruby-comment">#=> false</span>
<span class="ruby-constant">Set</span>[<span class="ruby-string">'a'</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'c'</span>] <span class="ruby-operator">==</span> <span class="ruby-constant">Set</span>[<span class="ruby-string">'a'</span>, <span class="ruby-string">'c'</span>, <span class="ruby-string">'b'</span>] <span class="ruby-comment">#=> true</span>
<span class="ruby-constant">Set</span>[<span class="ruby-string">'a'</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'c'</span>] <span class="ruby-operator">==</span> [<span class="ruby-string">'a'</span>, <span class="ruby-string">'c'</span>, <span class="ruby-string">'b'</span>] <span class="ruby-comment">#=> false</span>
</pre>
<div class="method-source-code" id="3D-3D-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 491</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">equal?</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>)
<span class="ruby-ivar">@hash</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>) <span class="ruby-operator">&&</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">size</span>
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-3D-3D-3D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">===</span><span
class="method-args">(o)</span>
</div>
<div class="method-description">
<p>Returns true if the given object is a member of the set, and false otherwise.</p>
<p>Used in case statements:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'set'</span>
<span class="ruby-keyword">case</span> <span class="ruby-value">:apple</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">:potato</span>, <span class="ruby-value">:carrot</span>]
<span class="ruby-string">"vegetable"</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">:apple</span>, <span class="ruby-value">:banana</span>]
<span class="ruby-string">"fruit"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># => "fruit"</span>
</pre>
<p>Or by itself:</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>] <span class="ruby-operator">===</span> <span class="ruby-value">2</span> <span class="ruby-comment">#=> true</span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>] <span class="ruby-operator">===</span> <span class="ruby-value">4</span> <span class="ruby-comment">#=> false</span>
</pre>
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-include-3F">include?</a>
</div>
</div>
<div id="method-i-3E" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">></span><span
class="method-args">(set)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-proper_superset-3F">proper_superset?</a>
</div>
</div>
<div id="method-i-3E-3D" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">>=</span><span
class="method-args">(set)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-superset-3F">superset?</a>
</div>
</div>
<div id="method-i-5E" class="method-detail ">
<div class="method-heading">
<span class="method-name">^</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new set containing elements exclusive between the set and the given enumerable object. (set ^ enum) is equivalent to ((set | enum) - (set & enum)).</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>] <span class="ruby-operator">^</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">2</span>, <span class="ruby-value">3</span>] <span class="ruby-comment">#=> #<Set: {3, 1}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'c'</span>] <span class="ruby-operator">^</span> [<span class="ruby-string">'b'</span>, <span class="ruby-string">'d'</span>] <span class="ruby-comment">#=> #<Set: {"d", 1, "c"}></span>
</pre>
<div class="method-source-code" id="5E-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 478</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">^</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-identifier">n</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">o</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">delete?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add" class="method-detail ">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(o)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds the given object to the set and returns self. Use <code>merge</code> to add many elements at once.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">add</span>(<span class="ruby-value">3</span>) <span class="ruby-comment">#=> #<Set: {1, 2, 3}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">add</span>([<span class="ruby-value">3</span>, <span class="ruby-value">4</span>]) <span class="ruby-comment">#=> #<Set: {1, 2, [3, 4]}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">add</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=> #<Set: {1, 2}></span>
</pre>
<div class="method-source-code" id="add-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 338</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-ivar">@hash</span>[<span class="ruby-identifier">o</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-3C-3C"><<</a>
</div>
</div>
<div id="method-i-add-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">add?</span><span
class="method-args">(o)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds the given object to the set and returns self. If the object is already in the set, returns nil.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">add?</span>(<span class="ruby-value">3</span>) <span class="ruby-comment">#=> #<Set: {1, 2, 3}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">add?</span>([<span class="ruby-value">3</span>, <span class="ruby-value">4</span>]) <span class="ruby-comment">#=> #<Set: {1, 2, [3, 4]}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">add?</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=> nil</span>
</pre>
<div class="method-source-code" id="add-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 350</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add?</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-identifier">add</span>(<span class="ruby-identifier">o</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-as_json" class="method-detail ">
<div class="method-heading">
<span class="method-name">as_json</span><span
class="method-args">(*)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Marshal.html"><code>Marshal</code></a> the object to <a href="JSON.html"><code>JSON</code></a>.</p>
<p>method used for <a href="JSON.html"><code>JSON</code></a> marshalling support.</p>
<div class="method-source-code" id="as_json-source">
<pre><span class="ruby-comment"># File ext/json/lib/json/add/set.rb, line 17</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">as_json</span>(<span class="ruby-operator">*</span>)
{
<span class="ruby-constant">JSON</span>.<span class="ruby-identifier">create_id</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>,
<span class="ruby-string">'a'</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">to_a</span>,
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-classify" class="method-detail ">
<div class="method-heading">
<span class="method-name">classify</span><span
class="method-args">() { |o| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>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.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'set'</span>
<span class="ruby-identifier">files</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-string">"*.rb"</span>))
<span class="ruby-identifier">hash</span> = <span class="ruby-identifier">files</span>.<span class="ruby-identifier">classify</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">mtime</span>(<span class="ruby-identifier">f</span>).<span class="ruby-identifier">year</span> }
<span class="ruby-identifier">hash</span> <span class="ruby-comment">#=> {2000=>#<Set: {"a.rb", "b.rb"}>,</span>
<span class="ruby-comment"># 2001=>#<Set: {"c.rb", "d.rb", "e.rb"}>,</span>
<span class="ruby-comment"># 2002=>#<Set: {"f.rb"}>}</span>
</pre>
<p>Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="classify-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 560</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">classify</span> <span class="ruby-comment"># :yields: o</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-identifier">h</span> = {}
<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
(<span class="ruby-identifier">h</span>[<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">i</span>)] <span class="ruby-operator">||=</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>).<span class="ruby-identifier">add</span>(<span class="ruby-identifier">i</span>)
}
<span class="ruby-identifier">h</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-clear" class="method-detail ">
<div class="method-heading">
<span class="method-name">clear</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes all elements and returns self.</p>
<pre class="ruby"><span class="ruby-identifier">set</span> = <span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-string">'c'</span>, <span class="ruby-value">:s</span>] <span class="ruby-comment">#=> #<Set: {1, "c", :s}></span>
<span class="ruby-identifier">set</span>.<span class="ruby-identifier">clear</span> <span class="ruby-comment">#=> #<Set: {}></span>
<span class="ruby-identifier">set</span> <span class="ruby-comment">#=> #<Set: {}></span>
</pre>
<div class="method-source-code" id="clear-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 166</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear</span>
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-collect-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">collect!</span><span
class="method-args">() { |o| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Replaces the elements with ones returned by collect(). Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="collect-21-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 391</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">collect!</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-identifier">set</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">set</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-map-21">map!</a>
</div>
</div>
<div id="method-i-compare_by_identity" class="method-detail ">
<div class="method-heading">
<span class="method-name">compare_by_identity</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Makes the set compare its elements by their identity and returns self. This method may not be supported by all subclasses of <a href="Set.html"><code>Set</code></a>.</p>
<div class="method-source-code" id="compare_by_identity-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 107</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">compare_by_identity</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:compare_by_identity</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">compare_by_identity</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-node">"#{self.class.name}\##{__method__} is not implemented"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-compare_by_identity-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">compare_by_identity?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set will compare its elements by their identity. Also see <a href="Set.html#method-i-compare_by_identity"><code>Set#compare_by_identity</code></a>.</p>
<div class="method-source-code" id="compare_by_identity-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">compare_by_identity?</span>
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:compare_by_identity?</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">compare_by_identity?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(o)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes the given object from the set and returns self. Use <code>subtract</code> to delete many items at once.</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 356</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete?</span><span
class="method-args">(o)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes the given object from the set and returns self. If the object is not in the set, returns nil.</p>
<div class="method-source-code" id="delete-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 363</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete?</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">o</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete_if" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete_if</span><span
class="method-args">() { |o| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes every element of the set for which block evaluates to true, and returns self. Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="delete_if-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 370</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete_if</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-comment"># @hash.delete_if should be faster, but using it breaks the order</span>
<span class="ruby-comment"># of enumeration in subclasses.</span>
<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">o</span> }.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-difference" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">difference</span><span
class="method-args">(enum)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-2D">-</a>
</div>
</div>
<div id="method-i-disjoint-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">disjoint?</span><span
class="method-args">(set)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set and the given set have no element in common. This method is the opposite of <code>intersect?</code>.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>].<span class="ruby-identifier">disjoint?</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">3</span>, <span class="ruby-value">4</span>] <span class="ruby-comment">#=> false</span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>].<span class="ruby-identifier">disjoint?</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">4</span>, <span class="ruby-value">5</span>] <span class="ruby-comment">#=> true</span>
</pre>
<div class="method-source-code" id="disjoint-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 319</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">disjoint?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-operator">!</span><span class="ruby-identifier">intersect?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-divide" class="method-detail ">
<div class="method-heading">
<span class="method-name">divide</span><span
class="method-args">(&func)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Divides the set into a set of subsets according to the commonality defined by the given block.</p>
<p>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).</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'set'</span>
<span class="ruby-identifier">numbers</span> = <span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">3</span>, <span class="ruby-value">4</span>, <span class="ruby-value">6</span>, <span class="ruby-value">9</span>, <span class="ruby-value">10</span>, <span class="ruby-value">11</span>]
<span class="ruby-identifier">set</span> = <span class="ruby-identifier">numbers</span>.<span class="ruby-identifier">divide</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span>,<span class="ruby-identifier">j</span><span class="ruby-operator">|</span> (<span class="ruby-identifier">i</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">j</span>).<span class="ruby-identifier">abs</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> }
<span class="ruby-identifier">set</span> <span class="ruby-comment">#=> #<Set: {#<Set: {1}>,</span>
<span class="ruby-comment"># #<Set: {11, 9, 10}>,</span>
<span class="ruby-comment"># #<Set: {3, 4}>,</span>
<span class="ruby-comment"># #<Set: {6}>}></span>
</pre>
<p>Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="divide-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 588</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">divide</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">func</span>)
<span class="ruby-identifier">func</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-keyword">if</span> <span class="ruby-identifier">func</span>.<span class="ruby-identifier">arity</span> <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'tsort'</span>
<span class="ruby-keyword">class</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">dig</span> = {} <span class="ruby-comment"># :nodoc:</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">TSort</span>
<span class="ruby-keyword">alias</span> <span class="ruby-identifier">tsort_each_node</span> <span class="ruby-identifier">each_key</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tsort_each_child</span>(<span class="ruby-identifier">node</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">node</span>).<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">u</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">dig</span>[<span class="ruby-identifier">u</span>] = <span class="ruby-identifier">a</span> = []
<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">func</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">u</span>, <span class="ruby-identifier">v</span>) <span class="ruby-keyword">and</span> <span class="ruby-identifier">a</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">v</span> }
}
<span class="ruby-identifier">set</span> = <span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>()
<span class="ruby-identifier">dig</span>.<span class="ruby-identifier">each_strongly_connected_component</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">css</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">set</span>.<span class="ruby-identifier">add</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">css</span>))
}
<span class="ruby-identifier">set</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Set</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">classify</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">func</span>).<span class="ruby-identifier">values</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls the given block once for each element in the set, passing the element as parameter. Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 326</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">block</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">each_key</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set contains no elements.</p>
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 157</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-filter-21" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">filter!</span><span
class="method-args">(&block)</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="Set.html#method-i-select-21"><code>Set#select!</code></a></p>
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-select-21">select!</a>
</div>
</div>
<div id="method-i-flatten" class="method-detail ">
<div class="method-heading">
<span class="method-name">flatten</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new set that is a copy of the set, flattening each containing set recursively.</p>
<div class="method-source-code" id="flatten-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 227</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flatten</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">flatten_merge</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-flatten-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">flatten!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="Set.html#method-i-flatten"><code>Set#flatten</code></a>, but replaces the receiver with the result in place. Returns nil if no modifications were made.</p>
<div class="method-source-code" id="flatten-21-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 233</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flatten!</span>
<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">flatten</span>()) <span class="ruby-keyword">if</span> <span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>) }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-include-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">include?</span><span
class="method-args">(o)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set contains the given object.</p>
<p>Note that <code>include?</code> and <code>member?</code> do not test member equality using <code>==</code> as do other Enumerables.</p>
<p>See also <a href="Enumerable.html#method-i-include-3F"><code>Enumerable#include?</code></a></p>
<div class="method-source-code" id="include-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 243</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">include?</span>(<span class="ruby-identifier">o</span>)
<span class="ruby-ivar">@hash</span>[<span class="ruby-identifier">o</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-member-3F">member?</a>, <a href="Set.html#method-i-3D-3D-3D">===</a>
</div>
</div>
<div id="method-i-initialize_clone" class="method-detail ">
<div class="method-heading">
<span class="method-name">initialize_clone</span><span
class="method-args">(orig)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Clone internal hash.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="initialize_clone-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 140</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize_clone</span>(<span class="ruby-identifier">orig</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@hash</span> = <span class="ruby-identifier">orig</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>).<span class="ruby-identifier">clone</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-initialize_dup" class="method-detail ">
<div class="method-heading">
<span class="method-name">initialize_dup</span><span
class="method-args">(orig)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Dup internal hash.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="initialize_dup-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize_dup</span>(<span class="ruby-identifier">orig</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@hash</span> = <span class="ruby-identifier">orig</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>).<span class="ruby-identifier">dup</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a string containing a human-readable representation of the set (“#<Set: {element1, element2, …}>”).</p>
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 622</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>
<span class="ruby-identifier">ids</span> = (<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-constant">InspectKey</span>] <span class="ruby-operator">||=</span> [])
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ids</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">object_id</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-string">'#<%s: {...}>'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ids</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">object_id</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-string">'#<%s: {%s}>'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">inspect</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>])
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">ids</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-to_s">to_s</a>
</div>
</div>
<div id="method-i-intersect-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">intersect?</span><span
class="method-args">(set)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set and the given set have at least one element in common.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>].<span class="ruby-identifier">intersect?</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">4</span>, <span class="ruby-value">5</span>] <span class="ruby-comment">#=> false</span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>].<span class="ruby-identifier">intersect?</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">3</span>, <span class="ruby-value">4</span>] <span class="ruby-comment">#=> true</span>
</pre>
<div class="method-source-code" id="intersect-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 305</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">intersect?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-identifier">set</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>) <span class="ruby-keyword">or</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"value must be a set"</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">size</span>
<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">set</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-intersection" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">intersection</span><span
class="method-args">(enum)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-26">&</a>
</div>
</div>
<div id="method-i-keep_if" class="method-detail ">
<div class="method-heading">
<span class="method-name">keep_if</span><span
class="method-args">() { |o| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes every element of the set for which block evaluates to false, and returns self. Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="keep_if-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 381</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">keep_if</span>
<span class="ruby-identifier">block_given?</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-comment"># @hash.keep_if should be faster, but using it breaks the order of</span>
<span class="ruby-comment"># enumeration in subclasses.</span>
<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">o</span> }.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-length" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">length</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-size">size</a>
</div>
</div>
<div id="method-i-map-21" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">map!</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-collect-21">collect!</a>
</div>
</div>
<div id="method-i-member-3F" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">member?</span><span
class="method-args">(o)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-include-3F">include?</a>
</div>
</div>
<div id="method-i-merge" class="method-detail ">
<div class="method-heading">
<span class="method-name">merge</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Merges the elements of the given enumerable object to the set and returns self.</p>
<div class="method-source-code" id="merge-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 422</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">merge</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">enum</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>))
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">do_with_enum</span>(<span class="ruby-identifier">enum</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-proper_subset-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">proper_subset?</span><span
class="method-args">(set)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set is a proper subset of the given set.</p>
<div class="method-source-code" id="proper_subset-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 288</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">proper_subset?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-keyword">case</span>
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:<</span>)
<span class="ruby-ivar">@hash</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>)
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>)
<span class="ruby-identifier">size</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"value must be a set"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-3C"><</a>
</div>
</div>
<div id="method-i-proper_superset-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">proper_superset?</span><span
class="method-args">(set)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set is a proper superset of the given set.</p>
<div class="method-source-code" id="proper_superset-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 262</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">proper_superset?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-keyword">case</span>
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:></span>)
<span class="ruby-ivar">@hash</span> <span class="ruby-operator">></span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>)
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>)
<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"value must be a set"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-3E">></a>
</div>
</div>
<div id="method-i-reject-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">reject!</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="Set.html#method-i-delete_if"><code>Set#delete_if</code></a>, but returns nil if no changes were made. Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="reject-21-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 401</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reject!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">block</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-identifier">n</span> = <span class="ruby-identifier">size</span>
<span class="ruby-identifier">delete_if</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-replace" class="method-detail ">
<div class="method-heading">
<span class="method-name">replace</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Replaces the contents of the set with the contents of the given enumerable object and returns self.</p>
<pre class="ruby"><span class="ruby-identifier">set</span> = <span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-string">'c'</span>, <span class="ruby-value">:s</span>] <span class="ruby-comment">#=> #<Set: {1, "c", :s}></span>
<span class="ruby-identifier">set</span>.<span class="ruby-identifier">replace</span>([<span class="ruby-value">1</span>, <span class="ruby-value">2</span>]) <span class="ruby-comment">#=> #<Set: {1, 2}></span>
<span class="ruby-identifier">set</span> <span class="ruby-comment">#=> #<Set: {1, 2}></span>
</pre>
<div class="method-source-code" id="replace-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 177</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">replace</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">enum</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">enum</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>))
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">do_with_enum</span>(<span class="ruby-identifier">enum</span>) <span class="ruby-comment"># make sure enum is enumerable before calling clear</span>
<span class="ruby-identifier">clear</span>
<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reset" class="method-detail ">
<div class="method-heading">
<span class="method-name">reset</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Resets the internal state after modification to existing elements and returns self.</p>
<p>Elements will be reindexed and deduplicated.</p>
<div class="method-source-code" id="reset-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 516</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:rehash</span>)
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">rehash</span> <span class="ruby-comment"># This should perform frozenness check.</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FrozenError</span>, <span class="ruby-node">"can't modify frozen #{self.class.name}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">frozen?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-select-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">select!</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Equivalent to <a href="Set.html#method-i-keep_if"><code>Set#keep_if</code></a>, but returns nil if no changes were made. Returns an enumerator if no block is given.</p>
<div class="method-source-code" id="select-21-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 410</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">select!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">block</span> <span class="ruby-keyword">or</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-identifier">__method__</span>) { <span class="ruby-identifier">size</span> }
<span class="ruby-identifier">n</span> = <span class="ruby-identifier">size</span>
<span class="ruby-identifier">keep_if</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">n</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-filter-21">filter!</a>
</div>
</div>
<div id="method-i-size" class="method-detail ">
<div class="method-heading">
<span class="method-name">size</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the number of elements.</p>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 151</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">size</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-length">length</a>
</div>
</div>
<div id="method-i-subset-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">subset?</span><span
class="method-args">(set)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set is a subset of the given set.</p>
<div class="method-source-code" id="subset-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 275</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subset?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-keyword">case</span>
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:<=</span>)
<span class="ruby-ivar">@hash</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>)
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>)
<span class="ruby-identifier">size</span> <span class="ruby-operator"><=</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"value must be a set"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-3C-3D"><=</a>
</div>
</div>
<div id="method-i-subtract" class="method-detail ">
<div class="method-heading">
<span class="method-name">subtract</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes every element that appears in the given enumerable object and returns self.</p>
<div class="method-source-code" id="subtract-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 434</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subtract</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-identifier">do_with_enum</span>(<span class="ruby-identifier">enum</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-superset-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">superset?</span><span
class="method-args">(set)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the set is a superset of the given set.</p>
<div class="method-source-code" id="superset-3F-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 249</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">superset?</span>(<span class="ruby-identifier">set</span>)
<span class="ruby-keyword">case</span>
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:>=</span>)
<span class="ruby-ivar">@hash</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-value">:@hash</span>)
<span class="ruby-keyword">when</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Set</span>)
<span class="ruby-identifier">size</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">set</span>.<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">o</span>) }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"value must be a set"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-3E-3D">>=</a>
</div>
</div>
<div id="method-i-to_a" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_a</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Converts the set to an array. The order of elements is uncertain.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>].<span class="ruby-identifier">to_a</span> <span class="ruby-comment">#=> [1, 2]</span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-string">'c'</span>, <span class="ruby-value">:s</span>].<span class="ruby-identifier">to_a</span> <span class="ruby-comment">#=> [1, "c", :s]</span>
</pre>
<div class="method-source-code" id="to_a-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 192</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_a</span>
<span class="ruby-ivar">@hash</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_json" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_json</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>return the <a href="JSON.html"><code>JSON</code></a> value</p>
<div class="method-source-code" id="to_json-source">
<pre><span class="ruby-comment"># File ext/json/lib/json/add/set.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">as_json</span>.<span class="ruby-identifier">to_json</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_s" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">to_s</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-inspect">inspect</a>
</div>
</div>
<div id="method-i-to_set" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_set</span><span
class="method-args">(klass = Set, *args, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns self if no arguments are given. Otherwise, converts the set to another with klass.new(self, *args, &block).</p>
<p>In subclasses, returns klass.new(self, *args, &block) unless overridden.</p>
<div class="method-source-code" id="to_set-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 201</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_set</span>(<span class="ruby-identifier">klass</span> = <span class="ruby-constant">Set</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">Set</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Set</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-union" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">union</span><span
class="method-args">(enum)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Set.html#method-i-7C">|</a>
</div>
</div>
<div id="method-i-7C" class="method-detail ">
<div class="method-heading">
<span class="method-name">|</span><span
class="method-args">(enum)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a new set built by merging the set and the elements of the given enumerable object.</p>
<pre class="ruby"><span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">2</span>, <span class="ruby-value">3</span>] <span class="ruby-operator">|</span> <span class="ruby-constant">Set</span>[<span class="ruby-value">2</span>, <span class="ruby-value">4</span>, <span class="ruby-value">5</span>] <span class="ruby-comment">#=> #<Set: {1, 2, 3, 4, 5}></span>
<span class="ruby-constant">Set</span>[<span class="ruby-value">1</span>, <span class="ruby-value">5</span>, <span class="ruby-string">'z'</span>] <span class="ruby-operator">|</span> (<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">6</span>) <span class="ruby-comment">#=> #<Set: {1, 5, "z", 2, 3, 4, 6}></span>
</pre>
<div class="method-source-code" id="7C-source">
<pre><span class="ruby-comment"># File lib/set.rb, line 444</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">|</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">enum</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Set.html#method-i-2B">+</a>, <a href="Set.html#method-i-union">union</a>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>