blob: 265ec1e37ade5b2e132c59132b1bfe6dffd63c82 [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>Class OfflineSorter
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class OfflineSorter
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="core/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</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="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/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">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</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.Util.OfflineSorter">
<h1 id="Lucene_Net_Util_OfflineSorter" data-uid="Lucene.Net.Util.OfflineSorter" class="text-break">Class OfflineSorter
</h1>
<div class="markdown level0 summary"><p>On-disk sorting of byte arrays. Each byte array (entry) is a composed of the following
fields:
<ul><li>(two bytes) length of the following byte array,</li><li>exactly the above count of bytes for the sequence to be sorted.</li></ul></p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">OfflineSorter</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Util.html">Lucene.Net.Util</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Util_OfflineSorter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class OfflineSorter</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter__ctor.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.%23ctor%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L208">View Source</a>
</span>
<a id="Lucene_Net_Util_OfflineSorter__ctor_" data-uid="Lucene.Net.Util.OfflineSorter.#ctor*"></a>
<h4 id="Lucene_Net_Util_OfflineSorter__ctor" data-uid="Lucene.Net.Util.OfflineSorter.#ctor">OfflineSorter()</h4>
<div class="markdown level1 summary"><p>Defaults constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OfflineSorter()</code></pre>
</div>
<h5 id="Lucene_Net_Util_OfflineSorter__ctor_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Util.OfflineSorter.html#Lucene_Net_Util_OfflineSorter_DefaultTempDir">DefaultTempDir()</a></div>
<div><a class="xref" href="Lucene.Net.Util.OfflineSorter.BufferSize.html#Lucene_Net_Util_OfflineSorter_BufferSize_Automatic">Automatic()</a></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter__ctor_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef__.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.%23ctor(System.Collections.Generic.IComparer%7BLucene.Net.Util.BytesRef%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L218">View Source</a>
</span>
<a id="Lucene_Net_Util_OfflineSorter__ctor_" data-uid="Lucene.Net.Util.OfflineSorter.#ctor*"></a>
<h4 id="Lucene_Net_Util_OfflineSorter__ctor_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef__" data-uid="Lucene.Net.Util.OfflineSorter.#ctor(System.Collections.Generic.IComparer{Lucene.Net.Util.BytesRef})">OfflineSorter(IComparer&lt;BytesRef&gt;)</h4>
<div class="markdown level1 summary"><p>Defaults constructor with a custom comparer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OfflineSorter(IComparer&lt;BytesRef&gt; comparer)</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.IComparer</span>&lt;<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>&gt;</td>
<td><span class="parametername">comparer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Util_OfflineSorter__ctor_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef___seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Util.OfflineSorter.html#Lucene_Net_Util_OfflineSorter_DefaultTempDir">DefaultTempDir()</a></div>
<div><a class="xref" href="Lucene.Net.Util.OfflineSorter.BufferSize.html#Lucene_Net_Util_OfflineSorter_BufferSize_Automatic">Automatic()</a></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter__ctor_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef__Lucene_Net_Util_OfflineSorter_BufferSize_System_IO_DirectoryInfo_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.%23ctor(System.Collections.Generic.IComparer%7BLucene.Net.Util.BytesRef%7D%2CLucene.Net.Util.OfflineSorter.BufferSize%2CSystem.IO.DirectoryInfo%2CSystem.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L226">View Source</a>
</span>
<a id="Lucene_Net_Util_OfflineSorter__ctor_" data-uid="Lucene.Net.Util.OfflineSorter.#ctor*"></a>
<h4 id="Lucene_Net_Util_OfflineSorter__ctor_System_Collections_Generic_IComparer_Lucene_Net_Util_BytesRef__Lucene_Net_Util_OfflineSorter_BufferSize_System_IO_DirectoryInfo_System_Int32_" data-uid="Lucene.Net.Util.OfflineSorter.#ctor(System.Collections.Generic.IComparer{Lucene.Net.Util.BytesRef},Lucene.Net.Util.OfflineSorter.BufferSize,System.IO.DirectoryInfo,System.Int32)">OfflineSorter(IComparer&lt;BytesRef&gt;, OfflineSorter.BufferSize, DirectoryInfo, Int32)</h4>
<div class="markdown level1 summary"><p>All-details constructor.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OfflineSorter(IComparer&lt;BytesRef&gt; comparer, OfflineSorter.BufferSize ramBufferSize, DirectoryInfo tempDirectory, int maxTempfiles)</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.IComparer</span>&lt;<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>&gt;</td>
<td><span class="parametername">comparer</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.OfflineSorter.BufferSize.html">OfflineSorter.BufferSize</a></td>
<td><span class="parametername">ramBufferSize</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IO.DirectoryInfo</span></td>
<td><span class="parametername">tempDirectory</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">maxTempfiles</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_ABSOLUTE_MIN_SORT_BUFFER_SIZE.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.ABSOLUTE_MIN_SORT_BUFFER_SIZE%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L59">View Source</a>
</span>
<h4 id="Lucene_Net_Util_OfflineSorter_ABSOLUTE_MIN_SORT_BUFFER_SIZE" data-uid="Lucene.Net.Util.OfflineSorter.ABSOLUTE_MIN_SORT_BUFFER_SIZE">ABSOLUTE_MIN_SORT_BUFFER_SIZE</h4>
<div class="markdown level1 summary"><p>Absolute minimum required buffer size for sorting.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly long ABSOLUTE_MIN_SORT_BUFFER_SIZE</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int64</span></td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_DEFAULT_COMPARER.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.DEFAULT_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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L201">View Source</a>
</span>
<h4 id="Lucene_Net_Util_OfflineSorter_DEFAULT_COMPARER" data-uid="Lucene.Net.Util.OfflineSorter.DEFAULT_COMPARER">DEFAULT_COMPARER</h4>
<div class="markdown level1 summary"><p>Default comparer: sorts in binary (codepoint) order </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly IComparer&lt;BytesRef&gt; DEFAULT_COMPARER</code></pre>
</div>
<h5 class="fieldValue">Field 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;<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>&gt;</td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_GB.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.GB%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L49">View Source</a>
</span>
<h4 id="Lucene_Net_Util_OfflineSorter_GB" data-uid="Lucene.Net.Util.OfflineSorter.GB">GB</h4>
<div class="markdown level1 summary"><p>Convenience constant for gigabytes </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly long GB</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int64</span></td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_MAX_TEMPFILES.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.MAX_TEMPFILES%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L65">View Source</a>
</span>
<h4 id="Lucene_Net_Util_OfflineSorter_MAX_TEMPFILES" data-uid="Lucene.Net.Util.OfflineSorter.MAX_TEMPFILES">MAX_TEMPFILES</h4>
<div class="markdown level1 summary"><p>Maximum number of temporary files before doing an intermediate merge.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly int MAX_TEMPFILES</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_MB.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.MB%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L46">View Source</a>
</span>
<h4 id="Lucene_Net_Util_OfflineSorter_MB" data-uid="Lucene.Net.Util.OfflineSorter.MB">MB</h4>
<div class="markdown level1 summary"><p>Convenience constant for megabytes </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly long MB</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int64</span></td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_MIN_BUFFER_SIZE_MB.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.MIN_BUFFER_SIZE_MB%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L54">View Source</a>
</span>
<h4 id="Lucene_Net_Util_OfflineSorter_MIN_BUFFER_SIZE_MB" data-uid="Lucene.Net.Util.OfflineSorter.MIN_BUFFER_SIZE_MB">MIN_BUFFER_SIZE_MB</h4>
<div class="markdown level1 summary"><p>Minimum recommended buffer size for sorting.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly long MIN_BUFFER_SIZE_MB</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int64</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_Comparer.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L673">View Source</a>
</span>
<a id="Lucene_Net_Util_OfflineSorter_Comparer_" data-uid="Lucene.Net.Util.OfflineSorter.Comparer*"></a>
<h4 id="Lucene_Net_Util_OfflineSorter_Comparer" data-uid="Lucene.Net.Util.OfflineSorter.Comparer">Comparer</h4>
<div class="markdown level1 summary"><p>Returns the comparer in use to sort entries </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IComparer&lt;BytesRef&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;<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>&gt;</td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_DefaultTempDir.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.DefaultTempDir%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L344">View Source</a>
</span>
<a id="Lucene_Net_Util_OfflineSorter_DefaultTempDir_" data-uid="Lucene.Net.Util.OfflineSorter.DefaultTempDir*"></a>
<h4 id="Lucene_Net_Util_OfflineSorter_DefaultTempDir" data-uid="Lucene.Net.Util.OfflineSorter.DefaultTempDir">DefaultTempDir()</h4>
<div class="markdown level1 summary"><p>Returns the default temporary directory. By default, the System&apos;s temp folder. If not accessible
or not available, an <span class="xref">System.IO.IOException</span> is thrown.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static DirectoryInfo DefaultTempDir()</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">System.IO.DirectoryInfo</span></td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter_Sort_System_IO_FileInfo_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter.Sort(System.IO.FileInfo%2CSystem.IO.FileInfo)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L248">View Source</a>
</span>
<a id="Lucene_Net_Util_OfflineSorter_Sort_" data-uid="Lucene.Net.Util.OfflineSorter.Sort*"></a>
<h4 id="Lucene_Net_Util_OfflineSorter_Sort_System_IO_FileInfo_System_IO_FileInfo_" data-uid="Lucene.Net.Util.OfflineSorter.Sort(System.IO.FileInfo,System.IO.FileInfo)">Sort(FileInfo, FileInfo)</h4>
<div class="markdown level1 summary"><p>Sort input to output, explicit hint for the buffer size. The amount of allocated
memory may deviate from the hint (may be smaller or larger).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public OfflineSorter.SortInfo Sort(FileInfo input, FileInfo output)</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.IO.FileInfo</span></td>
<td><span class="parametername">input</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.IO.FileInfo</span></td>
<td><span class="parametername">output</span></td>
<td></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.Util.OfflineSorter.SortInfo.html">OfflineSorter.SortInfo</a></td>
<td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_OfflineSorter.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.OfflineSorter%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/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/OfflineSorter.cs/#L37" 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="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>