File: C:/Ruby27-x64/share/doc/ruby/html/Prime/PseudoPrimeGenerator.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Prime::PseudoPrimeGenerator - 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 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-new">::new</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-next">#next</a>
<li ><a href="#method-i-rewind">#rewind</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-succ">#succ</a>
<li ><a href="#method-i-upper_bound">#upper_bound</a>
<li ><a href="#method-i-upper_bound-3D">#upper_bound=</a>
<li ><a href="#method-i-with_index">#with_index</a>
<li ><a href="#method-i-with_object">#with_object</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Prime::PseudoPrimeGenerator">
<h1 id="class-Prime::PseudoPrimeGenerator" class="class">
class Prime::PseudoPrimeGenerator
</h1>
<section class="description">
<p>An abstract class for enumerating pseudo-prime numbers.</p>
<p>Concrete subclasses should override succ, next, rewind.</p>
</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(ubound = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 237</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">ubound</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@ubound</span> = <span class="ruby-identifier">ubound</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-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">() { |prime| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterates the given block for each prime number.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 269</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">dup</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@ubound</span>
<span class="ruby-identifier">last_value</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">prime</span> = <span class="ruby-identifier">succ</span>
<span class="ruby-keyword">break</span> <span class="ruby-identifier">last_value</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">prime</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@ubound</span>
<span class="ruby-identifier">last_value</span> = <span class="ruby-keyword">yield</span> <span class="ruby-identifier">prime</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">succ</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-next" class="method-detail ">
<div class="method-heading">
<span class="method-name">next</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>alias of <code>succ</code>.</p>
<div class="method-source-code" id="next-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 257</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">next</span>
<span class="ruby-identifier ruby-title">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-string">"need to define `next'"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-rewind" class="method-detail ">
<div class="method-heading">
<span class="method-name">rewind</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Rewinds the internal position for enumeration.</p>
<p>See <code>Enumerator</code>#rewind.</p>
<div class="method-source-code" id="rewind-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 264</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rewind</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-string">"need to define `rewind'"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</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">
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 304</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-constant">Float</span><span class="ruby-operator">::</span><span class="ruby-constant">INFINITY</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-succ" class="method-detail ">
<div class="method-heading">
<span class="method-name">succ</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>returns the next pseudo-prime number, and move the internal position forward.</p>
<p><code>PseudoPrimeGenerator</code>#succ raises <code>NotImplementedError</code>.</p>
<div class="method-source-code" id="succ-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 252</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">succ</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-string">"need to define `succ'"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-upper_bound" class="method-detail ">
<div class="method-heading">
<span class="method-name">upper_bound</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="upper_bound-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 244</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">upper_bound</span>
<span class="ruby-ivar">@ubound</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-upper_bound-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">upper_bound=</span><span
class="method-args">(ubound)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="upper_bound-3D-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 241</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">upper_bound=</span>(<span class="ruby-identifier">ubound</span>)
<span class="ruby-ivar">@ubound</span> = <span class="ruby-identifier">ubound</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-with_index" class="method-detail ">
<div class="method-heading">
<span class="method-name">with_index</span><span
class="method-args">(offset = 0) { |prime, offset| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>see <code>Enumerator</code>#with_index.</p>
<div class="method-source-code" id="with_index-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 286</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_index</span>(<span class="ruby-identifier">offset</span> = <span class="ruby-value">0</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-value">:with_index</span>, <span class="ruby-identifier">offset</span>) { <span class="ruby-constant">Float</span><span class="ruby-operator">::</span><span class="ruby-constant">INFINITY</span> } <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">each_with_index</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">offset</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prime</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">prime</span>, <span class="ruby-identifier">offset</span>
<span class="ruby-identifier">offset</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-with_object" class="method-detail ">
<div class="method-heading">
<span class="method-name">with_object</span><span
class="method-args">(obj) { |prime, obj| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>see <code>Enumerator</code>#with_object.</p>
<div class="method-source-code" id="with_object-source">
<pre><span class="ruby-comment"># File lib/prime.rb, line 297</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_object</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">enum_for</span>(<span class="ruby-value">:with_object</span>, <span class="ruby-identifier">obj</span>) { <span class="ruby-constant">Float</span><span class="ruby-operator">::</span><span class="ruby-constant">INFINITY</span> } <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">prime</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">prime</span>, <span class="ruby-identifier">obj</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</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>