blob: 7ebcea9f189971a60df00a632de94859fb12c96c [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IDirectedEnumerable&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IDirectedEnumerable&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Support.C5.IDirectedEnumerable`1">
<h1 id="Lucene_Net_Support_C5_IDirectedEnumerable_1" data-uid="Lucene.Net.Support.C5.IDirectedEnumerable`1" class="text-break">Interface IDirectedEnumerable&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>A generic collection, that can be enumerated backwards.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Collections.Generic.IEnumerable&lt;T&gt;.GetEnumerator()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Support.C5.html">Lucene.Net.Support.C5</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Support_C5_IDirectedEnumerable_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IDirectedEnumerable&lt;T&gt; : IEnumerable&lt;T&gt;, IEnumerable</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_IDirectedEnumerable_1_Direction.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IDirectedEnumerable%601.Direction%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L5830">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_IDirectedEnumerable_1_Direction_" data-uid="Lucene.Net.Support.C5.IDirectedEnumerable`1.Direction*"></a>
<h4 id="Lucene_Net_Support_C5_IDirectedEnumerable_1_Direction" data-uid="Lucene.Net.Support.C5.IDirectedEnumerable`1.Direction">Direction</h4>
<div class="markdown level1 summary"><pre><code>Forwards</code></pre> if same, else <pre><code>Backwards</code></pre>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">EnumerationDirection Direction { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.EnumerationDirection.html">EnumerationDirection</a></td>
<td><p>The enumeration direction relative to the original collection.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_IDirectedEnumerable_1_Backwards.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IDirectedEnumerable%601.Backwards%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L5824">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_IDirectedEnumerable_1_Backwards_" data-uid="Lucene.Net.Support.C5.IDirectedEnumerable`1.Backwards*"></a>
<h4 id="Lucene_Net_Support_C5_IDirectedEnumerable_1_Backwards" data-uid="Lucene.Net.Support.C5.IDirectedEnumerable`1.Backwards">Backwards()</h4>
<div class="markdown level1 summary"><p>Create a collection containing the same items as this collection, but
whose enumerator will enumerate the items backwards. The new collection
will become invalid if the original is modified. Method typically used as in</p>
<pre><code>foreach (T x in coll.Backwards()) {...}</code></pre>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IDirectedEnumerable&lt;T&gt; Backwards()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.IDirectedEnumerable-1.html">IDirectedEnumerable</a>&lt;T&gt;</td>
<td><p>The backwards collection.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="Lucene.Net.Support.EnumerableExtensions.html#Lucene_Net_Support_EnumerableExtensions_InPairs__2_System_Collections_Generic_IEnumerable___0__System_Func___0___0___1__">EnumerableExtensions.InPairs&lt;T, TOut&gt;(IEnumerable&lt;T&gt;, Func&lt;T, T, TOut&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.EnumerableExtensions.html#Lucene_Net_Support_EnumerableExtensions_TakeAllButLast__1_System_Collections_Generic_IEnumerable___0__">EnumerableExtensions.TakeAllButLast&lt;T&gt;(IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.EnumerableExtensions.html#Lucene_Net_Support_EnumerableExtensions_TakeAllButLast__1_System_Collections_Generic_IEnumerable___0__System_Int32_">EnumerableExtensions.TakeAllButLast&lt;T&gt;(IEnumerable&lt;T&gt;, Int32)</a>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Support_C5_IDirectedEnumerable_1.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.IDirectedEnumerable%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net/Support/C5.Support.cs/#L5815" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>