Iterable

<p>An Iterable is an object that provides an <code>iter()</code> method,
which is expected to return an Iterator object. This class defines the
abstract class interface such that each class inheriting this class provides
an <code>iter()</code> method and must implement a private method <code>create_iter()</code>,
which must return an Iterator object.</p>

Extends the functionality of base 'R' lists and
provides specialized data structures 'deque',
'set', 'dict', and 'dict.table', the latter to extend the 'data.table'
package.

Roman Pahl

container

Extending Base 'R' Lists

Iterable function

Author


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Iterable%24new()?package=container&version=1.0.5" data-mini-rdoc="container::Iterable$new()"><code>Iterable$new()</code></a></p></li>
<li><p><a href="/link/Iterable%24iter()?package=container&version=1.0.5" data-mini-rdoc="container::Iterable$iter()"><code>Iterable$iter()</code></a></p></li>
<li><p><a href="/link/Iterable%24clone()?package=container&version=1.0.5" data-mini-rdoc="container::Iterable$clone()"><code>Iterable$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-Iterable-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p><code>Iterable</code> is an abstract class and thus cannot be instantiated.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Iterable$new()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-Iterable-iter"></a></p><div class="section" id="method-iter-">
<h3>Method <code>iter()</code></h3>
<p>Create iterator</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Iterable$iter()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>returns the <code>Iterator</code> object.</p>
</div></p><p></p><p><hr>
<a id="method-Iterable-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Iterable$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

Iterable abstract class interface — Iterable


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-Iterable-new'><code>Iterable$new()</code></a></p></li>
<li><p><a href='#method-Iterable-iter'><code>Iterable$iter()</code></a></p></li>
<li><p><a href='#method-Iterable-clone'><code>Iterable$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-Iterable-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p><code>Iterable</code> is an abstract class and thus cannot be instantiated.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Iterable$new()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-Iterable-iter"></a></p><div class='section' id='method-iter-'>
<h3>Method <code>iter()</code></h3>
<p>Create iterator</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Iterable$iter()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>returns the <code>Iterator</code> object.</p>
</div>

</div><p><hr>
<a id="method-Iterable-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Iterable$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


Iterable: Iterable abstract class interface

Description

Arguments

Author

Methods

Public methods

Method `new()`

Usage

Method `iter()`

Usage

Returns

Method `clone()`

Usage

Arguments

See Also

Description

Arguments

Author

Methods

Public methods

Method new()

Usage

Method iter()

Usage

Returns

Method clone()

Usage

Arguments

See Also

Method `new()`

Method `iter()`

Method `clone()`