Google Git
Sign in
apache / lucenenet-site / ab0b8c474ef206f3216b45d3fb65d5c1cccf3be6 / . / docs / 4.8.0-beta00007 / api / Lucene.Net / Lucene.Net.Support.C5.ISorted-1.html
blob: 15e4a9303adabf87dc146565c87d8d90788b3efc [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 ISorted&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface ISorted&lt;T&gt;
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.50.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.ISorted`1">
<h1 id="Lucene_Net_Support_C5_ISorted_1" data-uid="Lucene.Net.Support.C5.ISorted`1" class="text-break">Interface ISorted&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>A sorted collection, i.e. a collection where items are maintained and can be searched for in sorted order.
Thus the sequence order is given as a sorting order.</p>
<p>The sorting order is defined by a comparer, an object of type IComparer&lt;T&gt;
(<span class="xref">C5.IComparer`1</span>). Implementors of this interface will normally let the user
define the comparer as an argument to a constructor.
Usually there will also be constructors without a comparer argument, in which case the
comparer should be the defalt comparer for the item type, <span class="xref">C5.Comparer`1.Default</span>.</p>
<p>The comparer of the sorted collection is available as the <pre><code>System.Collections.Generic.Comparer</code></pre> property
(<span class="xref">C5.ISorted`1.Comparer</span>).</p>
<p>The methods are grouped according to
</p>
<p>Since this interface extends ISequenced&lt;T&gt;, sorted collections will also have an
item equalityComparer (<span class="xref">C5.IExtensible`1.EqualityComparer</span>). This equalityComparer will not be used in connection with
the inner workings of the sorted collection, but will be used if the sorted collection is used as
an item in a collection of unsequenced or sequenced collections,
(<span class="xref">C5.ICollection`1</span> and <span class="xref">C5.ISequenced`1</span>)</p>
<p>Note that code may check if two sorted collections has the same sorting order
by checking if the Comparer properties are equal. This is done a few places in this library
for optimization purposes.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ISequenced-1.html#Lucene_Net_Support_C5_ISequenced_1_GetSequencedHashCode">ISequenced&lt;T&gt;.GetSequencedHashCode()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ISequenced-1.html#Lucene_Net_Support_C5_ISequenced_1_SequencedEquals_Lucene_Net_Support_C5_ISequenced__0__">ISequenced&lt;T&gt;.SequencedEquals(ISequenced&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_ContainsSpeed">ICollection&lt;T&gt;.ContainsSpeed</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Count">ICollection&lt;T&gt;.Count</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_IsReadOnly">ICollection&lt;T&gt;.IsReadOnly</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Add__0_">ICollection&lt;T&gt;.Add(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_CopyTo__0___System_Int32_">ICollection&lt;T&gt;.CopyTo(T[], Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_GetUnsequencedHashCode">ICollection&lt;T&gt;.GetUnsequencedHashCode()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_UnsequencedEquals_Lucene_Net_Support_C5_ICollection__0__">ICollection&lt;T&gt;.UnsequencedEquals(ICollection&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Contains__0_">ICollection&lt;T&gt;.Contains(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_ContainsCount__0_">ICollection&lt;T&gt;.ContainsCount(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_UniqueItems">ICollection&lt;T&gt;.UniqueItems()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_ItemMultiplicities">ICollection&lt;T&gt;.ItemMultiplicities()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_ContainsAll_System_Collections_Generic_IEnumerable__0__">ICollection&lt;T&gt;.ContainsAll(System.Collections.Generic.IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Find__0__">ICollection&lt;T&gt;.Find(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_FindOrAdd__0__">ICollection&lt;T&gt;.FindOrAdd(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Update__0_">ICollection&lt;T&gt;.Update(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Update__0__0__">ICollection&lt;T&gt;.Update(T, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_UpdateOrAdd__0_">ICollection&lt;T&gt;.UpdateOrAdd(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_UpdateOrAdd__0__0__">ICollection&lt;T&gt;.UpdateOrAdd(T, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Remove__0_">ICollection&lt;T&gt;.Remove(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Remove__0__0__">ICollection&lt;T&gt;.Remove(T, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_RemoveAllCopies__0_">ICollection&lt;T&gt;.RemoveAllCopies(T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_RemoveAll_System_Collections_Generic_IEnumerable__0__">ICollection&lt;T&gt;.RemoveAll(System.Collections.Generic.IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_Clear">ICollection&lt;T&gt;.Clear()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollection-1.html#Lucene_Net_Support_C5_ICollection_1_RetainAll_System_Collections_Generic_IEnumerable__0__">ICollection&lt;T&gt;.RetainAll(System.Collections.Generic.IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IExtensible-1.html#Lucene_Net_Support_C5_IExtensible_1_AllowsDuplicates">IExtensible&lt;T&gt;.AllowsDuplicates</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IExtensible-1.html#Lucene_Net_Support_C5_IExtensible_1_EqualityComparer">IExtensible&lt;T&gt;.EqualityComparer</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IExtensible-1.html#Lucene_Net_Support_C5_IExtensible_1_DuplicatesByCounting">IExtensible&lt;T&gt;.DuplicatesByCounting</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IExtensible-1.html#Lucene_Net_Support_C5_IExtensible_1_AddAll_System_Collections_Generic_IEnumerable__0__">IExtensible&lt;T&gt;.AddAll(System.Collections.Generic.IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IExtensible-1.html#Lucene_Net_Support_C5_IExtensible_1_Check">IExtensible&lt;T&gt;.Check()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IDirectedCollectionValue-1.html#Lucene_Net_Support_C5_IDirectedCollectionValue_1_Backwards">IDirectedCollectionValue&lt;T&gt;.Backwards()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IDirectedCollectionValue-1.html#Lucene_Net_Support_C5_IDirectedCollectionValue_1_FindLast_Func__0_System_Boolean___0__">IDirectedCollectionValue&lt;T&gt;.FindLast(Func&lt;T, Boolean&gt;, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ListenableEvents">ICollectionValue&lt;T&gt;.ListenableEvents</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ActiveEvents">ICollectionValue&lt;T&gt;.ActiveEvents</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CollectionChanged">ICollectionValue&lt;T&gt;.CollectionChanged</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CollectionCleared">ICollectionValue&lt;T&gt;.CollectionCleared</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemsAdded">ICollectionValue&lt;T&gt;.ItemsAdded</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemInserted">ICollectionValue&lt;T&gt;.ItemInserted</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemsRemoved">ICollectionValue&lt;T&gt;.ItemsRemoved</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ItemRemovedAt">ICollectionValue&lt;T&gt;.ItemRemovedAt</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_IsEmpty">ICollectionValue&lt;T&gt;.IsEmpty</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_CountSpeed">ICollectionValue&lt;T&gt;.CountSpeed</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_ToArray">ICollectionValue&lt;T&gt;.ToArray()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Apply_Action__0__">ICollectionValue&lt;T&gt;.Apply(Action&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Exists_Func__0_System_Boolean__">ICollectionValue&lt;T&gt;.Exists(Func&lt;T, Boolean&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Find_Func__0_System_Boolean___0__">ICollectionValue&lt;T&gt;.Find(Func&lt;T, Boolean&gt;, T)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_All_Func__0_System_Boolean__">ICollectionValue&lt;T&gt;.All(Func&lt;T, Boolean&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Choose">ICollectionValue&lt;T&gt;.Choose()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.ICollectionValue-1.html#Lucene_Net_Support_C5_ICollectionValue_1_Filter_Func__0_System_Boolean__">ICollectionValue&lt;T&gt;.Filter(Func&lt;T, Boolean&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IShowable.html#Lucene_Net_Support_C5_IShowable_Show_System_Text_StringBuilder_System_Int32__IFormatProvider_">IShowable.Show(System.Text.StringBuilder, Int32, IFormatProvider)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Support.C5.IDirectedEnumerable-1.html#Lucene_Net_Support_C5_IDirectedEnumerable_1_Direction">IDirectedEnumerable&lt;T&gt;.Direction</a>
</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_ISorted_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface ISorted&lt;T&gt; : ISequenced&lt;T&gt;, ICollection&lt;T&gt;, IExtensible&lt;T&gt;, System.Collections.Generic.ICollection&lt;T&gt;, IDirectedCollectionValue&lt;T&gt;, ICollectionValue&lt;T&gt;, IShowable, IFormattable, IDirectedEnumerable&lt;T&gt;, System.Collections.Generic.IEnumerable&lt;T&gt;</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_ISorted_1_Comparer.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.Comparer%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/#L6087">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_Comparer_" data-uid="Lucene.Net.Support.C5.ISorted`1.Comparer*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_Comparer" data-uid="Lucene.Net.Support.C5.ISorted`1.Comparer">Comparer</h4>
<div class="markdown level1 summary"><p>The comparer object supplied at creation time for this sorted collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">System.Collections.Generic.IComparer&lt;T&gt; Comparer { 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><span class="xref">System.Collections.Generic.IComparer</span>&lt;T&gt;</td>
<td><p>The comparer</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_ISorted_1_AddSorted_System_Collections_Generic_IEnumerable__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.AddSorted(System.Collections.Generic.IEnumerable%7B%600%7D)%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/#L6265">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_AddSorted_" data-uid="Lucene.Net.Support.C5.ISorted`1.AddSorted*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_AddSorted_System_Collections_Generic_IEnumerable__0__" data-uid="Lucene.Net.Support.C5.ISorted`1.AddSorted(System.Collections.Generic.IEnumerable{`0})">AddSorted(System.Collections.Generic.IEnumerable&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>Add all the items from another collection with an enumeration order that
is increasing in the items.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void AddSorted(System.Collections.Generic.IEnumerable&lt;T&gt; items)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;T&gt;</td>
<td><span class="parametername">items</span></td>
<td><p>The collection to add.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_Cut_IComparable__0___0__System_Boolean___0__System_Boolean__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.Cut(IComparable%7B%600%7D%2C%600%40%2CSystem.Boolean%40%2C%600%40%2CSystem.Boolean%40)%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/#L6210">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_Cut_" data-uid="Lucene.Net.Support.C5.ISorted`1.Cut*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_Cut_IComparable__0___0__System_Boolean___0__System_Boolean__" data-uid="Lucene.Net.Support.C5.ISorted`1.Cut(IComparable{`0},`0@,System.Boolean@,`0@,System.Boolean@)">Cut(IComparable&lt;T&gt;, out T, out Boolean, out T, out Boolean)</h4>
<div class="markdown level1 summary"><p>Given a &quot;cut&quot; function from the items of the sorted collection to <pre><code>int</code></pre>
whose only sign changes when going through items in increasing order
can be </p>
<p>The &quot;cut&quot; function is supplied as the <pre><code>CompareTo</code></pre> method
of an object <pre><code>c</code></pre> implementing </p>
<pre><code>IComparable&lt;T></code></pre>.
<p>A typical example is the case where <pre><code>T</code></pre> is comparable and </p>
<pre><code>cutFunction</code></pre> is itself of type <pre><code>T</code></pre>.
<p>This method performs a search in the sorted collection for the ranges in which the
&quot;cut&quot; function is negative, zero respectively positive. If <pre><code>T</code></pre> is comparable
and <pre><code>c</code></pre> is of type <pre><code>T</code></pre>, this is a safe way (no exceptions thrown)
to find predecessor and successor of <pre><code>c</code></pre>.
</p>
<p> If the supplied cut function does not satisfy the sign-change condition,
the result of this call is undefined.
</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool Cut(IComparable&lt;T&gt; cutFunction, out T low, out bool lowIsValid, out T high, out bool highIsValid)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">IComparable</span>&lt;T&gt;</td>
<td><span class="parametername">cutFunction</span></td>
<td><p>The cut function <pre><code>T</code></pre> to <pre><code>int</code></pre>, given
by the <pre><code>CompareTo</code></pre> method of an object implementing </p>
<pre><code>IComparable&lt;T></code></pre>.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">low</span></td>
<td><p>Returns the largest item in the collection, where the
cut function is positive (if any).</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">lowIsValid</span></td>
<td><p>Returns true if the cut function is positive somewhere
on this collection.</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">high</span></td>
<td><p>Returns the least item in the collection, where the
cut function is negative (if any).</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">highIsValid</span></td>
<td><p>Returns true if the cut function is negative somewhere
on this collection.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">System.Boolean</span></td>
<td><p>True if the cut function is zero somewhere
on this collection.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_DeleteMax.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.DeleteMax%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/#L6081">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_DeleteMax_" data-uid="Lucene.Net.Support.C5.ISorted`1.DeleteMax*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_DeleteMax" data-uid="Lucene.Net.Support.C5.ISorted`1.DeleteMax">DeleteMax()</h4>
<div class="markdown level1 summary"><p>Remove the largest item from this sorted collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T DeleteMax()</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><span class="xref">T</span></td>
<td><p>The removed item.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if the collection is empty.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_DeleteMin.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.DeleteMin%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/#L6065">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_DeleteMin_" data-uid="Lucene.Net.Support.C5.ISorted`1.DeleteMin*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_DeleteMin" data-uid="Lucene.Net.Support.C5.ISorted`1.DeleteMin">DeleteMin()</h4>
<div class="markdown level1 summary"><p>Remove the least item from this sorted collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T DeleteMin()</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><span class="xref">T</span></td>
<td><p>The removed item.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if the collection is empty.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_FindMax.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.FindMax%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/#L6073">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_FindMax_" data-uid="Lucene.Net.Support.C5.ISorted`1.FindMax*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_FindMax" data-uid="Lucene.Net.Support.C5.ISorted`1.FindMax">FindMax()</h4>
<div class="markdown level1 summary"><p>Find the current largest item of this sorted collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T FindMax()</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><span class="xref">T</span></td>
<td><p>The largest item.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if the collection is empty.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_FindMin.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.FindMin%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/#L6057">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_FindMin_" data-uid="Lucene.Net.Support.C5.ISorted`1.FindMin*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_FindMin" data-uid="Lucene.Net.Support.C5.ISorted`1.FindMin">FindMin()</h4>
<div class="markdown level1 summary"><p>Find the current least item of this sorted collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T FindMin()</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><span class="xref">T</span></td>
<td><p>The least item.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if the collection is empty.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_Predecessor__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.Predecessor(%600)%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/#L6137">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_Predecessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.Predecessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_Predecessor__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.Predecessor(`0)">Predecessor(T)</h4>
<div class="markdown level1 summary"><p>Find the strict predecessor in the sorted collection of a particular value,
that is, the largest item in the collection less than the supplied value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T Predecessor(T item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the predecessor for.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">T</span></td>
<td><p>The predecessor.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if no such element exists (the
supplied value is less than or equal to the minimum of this collection.)</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RangeAll.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RangeAll%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/#L6254">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RangeAll_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeAll*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RangeAll" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeAll">RangeAll()</h4>
<div class="markdown level1 summary"><p>Create a directed collection with the same items as this collection.
<p>The returned collection is not a copy but a view into the collection.</p>
<p>The view is fragile in the sense that changes to the underlying collection will
invalidate the view so that further operations on the view throws InvalidView exceptions.</p></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IDirectedCollectionValue&lt;T&gt; RangeAll()</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.IDirectedCollectionValue-1.html">IDirectedCollectionValue</a>&lt;T&gt;</td>
<td><p>The result directed collection.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RangeFrom__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RangeFrom(%600)%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/#L6221">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RangeFrom_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeFrom*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RangeFrom__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeFrom(`0)">RangeFrom(T)</h4>
<div class="markdown level1 summary"><p>Query this sorted collection for items greater than or equal to a supplied value.
<p>The returned collection is not a copy but a view into the collection.</p>
<p>The view is fragile in the sense that changes to the underlying collection will
invalidate the view so that further operations on the view throws InvalidView exceptions.</p></p>
</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; RangeFrom(T bot)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">bot</span></td>
<td><p>The lower bound (inclusive).</p>
</td>
</tr>
</tbody>
</table>
<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 result directed collection.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RangeFromTo__0__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RangeFromTo(%600%2C%600)%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/#L6233">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RangeFromTo_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeFromTo*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RangeFromTo__0__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeFromTo(`0,`0)">RangeFromTo(T, T)</h4>
<div class="markdown level1 summary"><p>Query this sorted collection for items between two supplied values.
<p>The returned collection is not a copy but a view into the collection.</p>
<p>The view is fragile in the sense that changes to the underlying collection will
invalidate the view so that further operations on the view throws InvalidView exceptions.</p></p>
</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; RangeFromTo(T bot, T top)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">bot</span></td>
<td><p>The lower bound (inclusive).</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">top</span></td>
<td><p>The upper bound (exclusive).</p>
</td>
</tr>
</tbody>
</table>
<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 result directed collection.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RangeTo__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RangeTo(%600)%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/#L6244">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RangeTo_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeTo*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RangeTo__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.RangeTo(`0)">RangeTo(T)</h4>
<div class="markdown level1 summary"><p>Query this sorted collection for items less than a supplied value.
<p>The returned collection is not a copy but a view into the collection.</p>
<p>The view is fragile in the sense that changes to the underlying collection will
invalidate the view so that further operations on the view throws InvalidView exceptions.</p></p>
</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; RangeTo(T top)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">top</span></td>
<td><p>The upper bound (exclusive).</p>
</td>
</tr>
</tbody>
</table>
<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 result directed collection.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RemoveRangeFrom__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RemoveRangeFrom(%600)%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/#L6272">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RemoveRangeFrom_" data-uid="Lucene.Net.Support.C5.ISorted`1.RemoveRangeFrom*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RemoveRangeFrom__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.RemoveRangeFrom(`0)">RemoveRangeFrom(T)</h4>
<div class="markdown level1 summary"><p>Remove all items of this collection above or at a supplied threshold.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void RemoveRangeFrom(T low)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">low</span></td>
<td><p>The lower threshold (inclusive).</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RemoveRangeFromTo__0__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RemoveRangeFromTo(%600%2C%600)%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/#L6280">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RemoveRangeFromTo_" data-uid="Lucene.Net.Support.C5.ISorted`1.RemoveRangeFromTo*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RemoveRangeFromTo__0__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.RemoveRangeFromTo(`0,`0)">RemoveRangeFromTo(T, T)</h4>
<div class="markdown level1 summary"><p>Remove all items of this collection between two supplied thresholds.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void RemoveRangeFromTo(T low, T hi)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">low</span></td>
<td><p>The lower threshold (inclusive).</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">hi</span></td>
<td><p>The upper threshold (exclusive).</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_RemoveRangeTo__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.RemoveRangeTo(%600)%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/#L6287">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_RemoveRangeTo_" data-uid="Lucene.Net.Support.C5.ISorted`1.RemoveRangeTo*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_RemoveRangeTo__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.RemoveRangeTo(`0)">RemoveRangeTo(T)</h4>
<div class="markdown level1 summary"><p>Remove all items of this collection below a supplied threshold.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void RemoveRangeTo(T hi)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">hi</span></td>
<td><p>The upper threshold (exclusive).</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_Successor__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.Successor(%600)%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/#L6148">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_Successor_" data-uid="Lucene.Net.Support.C5.ISorted`1.Successor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_Successor__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.Successor(`0)">Successor(T)</h4>
<div class="markdown level1 summary"><p>Find the strict successor in the sorted collection of a particular value,
that is, the least item in the collection greater than the supplied value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T Successor(T item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the successor for.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">T</span></td>
<td><p>The successor.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if no such element exists (the
supplied value is greater than or equal to the maximum of this collection.)</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_TryPredecessor__0__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.TryPredecessor(%600%2C%600%40)%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/#L6096">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_TryPredecessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.TryPredecessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_TryPredecessor__0__0__" data-uid="Lucene.Net.Support.C5.ISorted`1.TryPredecessor(`0,`0@)">TryPredecessor(T, out T)</h4>
<div class="markdown level1 summary"><p>Find the strict predecessor of item in the sorted collection,
that is, the greatest item in the collection smaller than the item.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool TryPredecessor(T item, out T res)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the predecessor for.</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">res</span></td>
<td><p>The predecessor, if any; otherwise the default value for T.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">System.Boolean</span></td>
<td><p>True if item has a predecessor; otherwise false.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_TrySuccessor__0__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.TrySuccessor(%600%2C%600%40)%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/#L6106">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_TrySuccessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.TrySuccessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_TrySuccessor__0__0__" data-uid="Lucene.Net.Support.C5.ISorted`1.TrySuccessor(`0,`0@)">TrySuccessor(T, out T)</h4>
<div class="markdown level1 summary"><p>Find the strict successor of item in the sorted collection,
that is, the least item in the collection greater than the supplied value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool TrySuccessor(T item, out T res)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the successor for.</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">res</span></td>
<td><p>The successor, if any; otherwise the default value for T.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">System.Boolean</span></td>
<td><p>True if item has a successor; otherwise false.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_TryWeakPredecessor__0__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.TryWeakPredecessor(%600%2C%600%40)%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/#L6116">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_TryWeakPredecessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.TryWeakPredecessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_TryWeakPredecessor__0__0__" data-uid="Lucene.Net.Support.C5.ISorted`1.TryWeakPredecessor(`0,`0@)">TryWeakPredecessor(T, out T)</h4>
<div class="markdown level1 summary"><p>Find the weak predecessor of item in the sorted collection,
that is, the greatest item in the collection smaller than or equal to the item.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool TryWeakPredecessor(T item, out T res)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the weak predecessor for.</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">res</span></td>
<td><p>The weak predecessor, if any; otherwise the default value for T.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">System.Boolean</span></td>
<td><p>True if item has a weak predecessor; otherwise false.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_TryWeakSuccessor__0__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.TryWeakSuccessor(%600%2C%600%40)%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/#L6126">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_TryWeakSuccessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.TryWeakSuccessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_TryWeakSuccessor__0__0__" data-uid="Lucene.Net.Support.C5.ISorted`1.TryWeakSuccessor(`0,`0@)">TryWeakSuccessor(T, out T)</h4>
<div class="markdown level1 summary"><p>Find the weak successor of item in the sorted collection,
that is, the least item in the collection greater than or equal to the supplied value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool TryWeakSuccessor(T item, out T res)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the weak successor for.</p>
</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">res</span></td>
<td><p>The weak successor, if any; otherwise the default value for T.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">System.Boolean</span></td>
<td><p>True if item has a weak successor; otherwise false.</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_WeakPredecessor__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.WeakPredecessor(%600)%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/#L6159">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_WeakPredecessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.WeakPredecessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_WeakPredecessor__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.WeakPredecessor(`0)">WeakPredecessor(T)</h4>
<div class="markdown level1 summary"><p>Find the weak predecessor in the sorted collection of a particular value,
that is, the largest item in the collection less than or equal to the supplied value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T WeakPredecessor(T item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the weak predecessor for.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">T</span></td>
<td><p>The weak predecessor.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if no such element exists (the
supplied value is less than the minimum of this collection.)</p>
</td>
</tr>
</tbody>
</table>
<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_ISorted_1_WeakSuccessor__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%601.WeakSuccessor(%600)%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/#L6170">View Source</a>
</span>
<a id="Lucene_Net_Support_C5_ISorted_1_WeakSuccessor_" data-uid="Lucene.Net.Support.C5.ISorted`1.WeakSuccessor*"></a>
<h4 id="Lucene_Net_Support_C5_ISorted_1_WeakSuccessor__0_" data-uid="Lucene.Net.Support.C5.ISorted`1.WeakSuccessor(`0)">WeakSuccessor(T)</h4>
<div class="markdown level1 summary"><p>Find the weak successor in the sorted collection of a particular value,
that is, the least item in the collection greater than or equal to the supplied value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">T WeakSuccessor(T item)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">item</span></td>
<td><p>The item to find the weak successor for.</p>
</td>
</tr>
</tbody>
</table>
<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><span class="xref">T</span></td>
<td><p>The weak successor.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Support.C5.NoSuchItemException.html">NoSuchItemException</a></td>
<td><p>if no such element exists (the
supplied value is greater than the maximum of this collection.)</p>
</td>
</tr>
</tbody>
</table>
</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_ISorted_1.md&amp;value=---%0Auid%3A%20Lucene.Net.Support.C5.ISorted%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/#L6050" 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>