blob: 37c4381ebda07e18ff2b4f607fa7675e4c97670d [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 AlcoholicMergePolicy
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class AlcoholicMergePolicy
| 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.Index.AlcoholicMergePolicy">
<h1 id="Lucene_Net_Index_AlcoholicMergePolicy" data-uid="Lucene.Net.Index.AlcoholicMergePolicy" class="text-break">Class AlcoholicMergePolicy
</h1>
<div class="markdown level0 summary"><p>
Merge policy for testing, it is like an alcoholic.
It drinks (merges) at night, and randomly decides what to drink.
During the daytime it sleeps.
</p>
<p>
If tests pass with this, then they are likely to pass with any
bizarro merge policy users might write.
</p>
<p>
It is a fine bottle of champagne (Ordered by Martijn).
</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"><a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html">MergePolicy</a></div>
<div class="level2"><a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html">LogMergePolicy</a></div>
<div class="level3"><span class="xref">AlcoholicMergePolicy</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_LEVEL_LOG_SPAN">LogMergePolicy.LEVEL_LOG_SPAN</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_DEFAULT_MERGE_FACTOR">LogMergePolicy.DEFAULT_MERGE_FACTOR</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_DEFAULT_MAX_MERGE_DOCS">LogMergePolicy.DEFAULT_MAX_MERGE_DOCS</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_DEFAULT_NO_CFS_RATIO">LogMergePolicy.DEFAULT_NO_CFS_RATIO</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_m_mergeFactor">LogMergePolicy.m_mergeFactor</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_m_minMergeSize">LogMergePolicy.m_minMergeSize</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_m_maxMergeSize">LogMergePolicy.m_maxMergeSize</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_m_maxMergeSizeForForcedMerge">LogMergePolicy.m_maxMergeSizeForForcedMerge</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_m_maxMergeDocs">LogMergePolicy.m_maxMergeDocs</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_m_calibrateSizeByDeletes">LogMergePolicy.m_calibrateSizeByDeletes</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_IsVerbose">LogMergePolicy.IsVerbose</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_Message_System_String_">LogMergePolicy.Message(String)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_MergeFactor">LogMergePolicy.MergeFactor</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_CalibrateSizeByDeletes">LogMergePolicy.CalibrateSizeByDeletes</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_Dispose_System_Boolean_">LogMergePolicy.Dispose(Boolean)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_SizeDocs_Lucene_Net_Index_SegmentCommitInfo_">LogMergePolicy.SizeDocs(SegmentCommitInfo)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_SizeBytes_Lucene_Net_Index_SegmentCommitInfo_">LogMergePolicy.SizeBytes(SegmentCommitInfo)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_IsMerged_Lucene_Net_Index_SegmentInfos_System_Int32_System_Collections_Generic_IDictionary_Lucene_Net_Index_SegmentCommitInfo_System_Nullable_System_Boolean___">LogMergePolicy.IsMerged(SegmentInfos, Int32, IDictionary&lt;SegmentCommitInfo, Nullable&lt;Boolean&gt;&gt;)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_FindForcedMerges_Lucene_Net_Index_SegmentInfos_System_Int32_System_Collections_Generic_IDictionary_Lucene_Net_Index_SegmentCommitInfo_System_Nullable_System_Boolean___">LogMergePolicy.FindForcedMerges(SegmentInfos, Int32, IDictionary&lt;SegmentCommitInfo, Nullable&lt;Boolean&gt;&gt;)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_FindForcedDeletesMerges_Lucene_Net_Index_SegmentInfos_">LogMergePolicy.FindForcedDeletesMerges(SegmentInfos)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_FindMerges_Lucene_Net_Index_MergeTrigger_Lucene_Net_Index_SegmentInfos_">LogMergePolicy.FindMerges(MergeTrigger, SegmentInfos)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_MaxMergeDocs">LogMergePolicy.MaxMergeDocs</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.LogMergePolicy.html#Lucene_Net_Index_LogMergePolicy_ToString">LogMergePolicy.ToString()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_DEFAULT_MAX_CFS_SEGMENT_SIZE">MergePolicy.DEFAULT_MAX_CFS_SEGMENT_SIZE</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_m_writer">MergePolicy.m_writer</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_m_noCFSRatio">MergePolicy.m_noCFSRatio</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_m_maxCFSSegmentSize">MergePolicy.m_maxCFSSegmentSize</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_Clone">MergePolicy.Clone()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_SetIndexWriter_Lucene_Net_Index_IndexWriter_">MergePolicy.SetIndexWriter(IndexWriter)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_Dispose">MergePolicy.Dispose()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_UseCompoundFile_Lucene_Net_Index_SegmentInfos_Lucene_Net_Index_SegmentCommitInfo_">MergePolicy.UseCompoundFile(SegmentInfos, SegmentCommitInfo)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_IsMerged_Lucene_Net_Index_SegmentInfos_Lucene_Net_Index_SegmentCommitInfo_">MergePolicy.IsMerged(SegmentInfos, SegmentCommitInfo)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_NoCFSRatio">MergePolicy.NoCFSRatio</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_MaxCFSSegmentSizeMB">MergePolicy.MaxCFSSegmentSizeMB</a>
</div>
<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>
<h6><strong>Namespace</strong>: <a class="xref" href="../Lucene.Net.Misc/Lucene.Net.Index.html">Lucene.Net.Index</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.TestFramework.dll</h6>
<h5 id="Lucene_Net_Index_AlcoholicMergePolicy_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class AlcoholicMergePolicy : LogMergePolicy, IDisposable</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_AlcoholicMergePolicy__ctor_System_TimeZoneInfo_System_Random_.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.AlcoholicMergePolicy.%23ctor(System.TimeZoneInfo%2CSystem.Random)%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.TestFramework/Index/AlcoholicMergePolicy.cs/#L43">View Source</a>
</span>
<a id="Lucene_Net_Index_AlcoholicMergePolicy__ctor_" data-uid="Lucene.Net.Index.AlcoholicMergePolicy.#ctor*"></a>
<h4 id="Lucene_Net_Index_AlcoholicMergePolicy__ctor_System_TimeZoneInfo_System_Random_" data-uid="Lucene.Net.Index.AlcoholicMergePolicy.#ctor(System.TimeZoneInfo,System.Random)">AlcoholicMergePolicy(TimeZoneInfo, Random)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AlcoholicMergePolicy(TimeZoneInfo timeZone, Random random)</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.TimeZoneInfo</span></td>
<td><span class="parametername">timeZone</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Random</span></td>
<td><span class="parametername">random</span></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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_AlcoholicMergePolicy_Size_Lucene_Net_Index_SegmentCommitInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.AlcoholicMergePolicy.Size(Lucene.Net.Index.SegmentCommitInfo)%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.TestFramework/Index/AlcoholicMergePolicy.cs/#L53">View Source</a>
</span>
<a id="Lucene_Net_Index_AlcoholicMergePolicy_Size_" data-uid="Lucene.Net.Index.AlcoholicMergePolicy.Size*"></a>
<h4 id="Lucene_Net_Index_AlcoholicMergePolicy_Size_Lucene_Net_Index_SegmentCommitInfo_" data-uid="Lucene.Net.Index.AlcoholicMergePolicy.Size(Lucene.Net.Index.SegmentCommitInfo)">Size(SegmentCommitInfo)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override long Size(SegmentCommitInfo info)</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><a class="xref" href="../Lucene.Net/Lucene.Net.Index.SegmentCommitInfo.html">SegmentCommitInfo</a></td>
<td><span class="parametername">info</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><span class="xref">System.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="../Lucene.Net/Lucene.Net.Index.MergePolicy.html#Lucene_Net_Index_MergePolicy_Size_Lucene_Net_Index_SegmentCommitInfo_">MergePolicy.Size(SegmentCommitInfo)</a></div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</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_Index_AlcoholicMergePolicy.md&amp;value=---%0Auid%3A%20Lucene.Net.Index.AlcoholicMergePolicy%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.TestFramework/Index/AlcoholicMergePolicy.cs/#L38" 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>