blob: 6bd7003736a9869e350c88574ad28bda3c82d116 [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 MonotonicAppendingInt64Buffer
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class MonotonicAppendingInt64Buffer
| 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.Packed.MonotonicAppendingInt64Buffer">
<h1 id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer" class="text-break">Class MonotonicAppendingInt64Buffer
</h1>
<div class="markdown level0 summary"><p>Utility class to buffer signed longs in memory, which is optimized for the
case where the sequence is monotonic, although it can encode any sequence of
arbitrary longs. It only supports appending.
<p>
NOTE: This was MonotonicAppendingLongBuffer in Lucene.
<p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></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.Index.NumericDocValues.html">NumericDocValues</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Util.Int64Values.html">Int64Values</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html">AbstractAppendingInt64Buffer</a></div>
<div class="level4"><span class="xref">MonotonicAppendingInt64Buffer</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_PageSize">AbstractAppendingInt64Buffer.PageSize</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_Count">AbstractAppendingInt64Buffer.Count</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_Add_System_Int64_">AbstractAppendingInt64Buffer.Add(Int64)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_Get_System_Int64_">AbstractAppendingInt64Buffer.Get(Int64)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_Get_System_Int64_System_Int64___System_Int32_System_Int32_">AbstractAppendingInt64Buffer.Get(Int64, Int64[], Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_GetIterator">AbstractAppendingInt64Buffer.GetIterator()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_Freeze">AbstractAppendingInt64Buffer.Freeze()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Util.Int64Values.html#Lucene_Net_Util_Int64Values_Get_System_Int32_">Int64Values.Get(Int32)</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>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Util.Packed.html">Lucene.Net.Util.Packed</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class MonotonicAppendingInt64Buffer : AbstractAppendingInt64Buffer</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_Packed_MonotonicAppendingInt64Buffer__ctor.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.%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/Packed/MonotonicAppendingLongBuffer.cs/#L62">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor_" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.#ctor*"></a>
<h4 id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.#ctor">MonotonicAppendingInt64Buffer()</h4>
<div class="markdown level1 summary"><p>Create an <a class="xref" href="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.html">MonotonicAppendingInt64Buffer</a> with initialPageCount=16,
pageSize=1024 and acceptableOverheadRatio=<a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_DEFAULT">DEFAULT</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MonotonicAppendingInt64Buffer()</code></pre>
</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_Packed_MonotonicAppendingInt64Buffer__ctor_System_Int32_System_Int32_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.%23ctor(System.Int32%2CSystem.Int32%2CSystem.Single)%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/Packed/MonotonicAppendingLongBuffer.cs/#L51">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor_" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.#ctor*"></a>
<h4 id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor_System_Int32_System_Int32_System_Single_" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.#ctor(System.Int32,System.Int32,System.Single)">MonotonicAppendingInt64Buffer(Int32, Int32, Single)</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 MonotonicAppendingInt64Buffer(int initialPageCount, int pageSize, float acceptableOverheadRatio)</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.Int32</span></td>
<td><span class="parametername">initialPageCount</span></td>
<td><p>The initial number of pages. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">pageSize</span></td>
<td><p>The size of a single page. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">acceptableOverheadRatio</span></td>
<td><p>An acceptable overhead ratio per value. </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.%23ctor(System.Single)%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/Packed/MonotonicAppendingLongBuffer.cs/#L71">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor_" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.#ctor*"></a>
<h4 id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer__ctor_System_Single_" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.#ctor(System.Single)">MonotonicAppendingInt64Buffer(Single)</h4>
<div class="markdown level1 summary"><p>Create an <a class="xref" href="Lucene.Net.Util.Packed.AppendingDeltaPackedInt64Buffer.html">AppendingDeltaPackedInt64Buffer</a> with initialPageCount=16,
pageSize=1024.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public MonotonicAppendingInt64Buffer(float acceptableOverheadRatio)</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.Single</span></td>
<td><span class="parametername">acceptableOverheadRatio</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer_RamBytesUsed.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.RamBytesUsed%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/Packed/MonotonicAppendingLongBuffer.cs/#L183">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer_RamBytesUsed_" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.RamBytesUsed*"></a>
<h4 id="Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer_RamBytesUsed" data-uid="Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer.RamBytesUsed">RamBytesUsed()</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 override long RamBytesUsed()</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.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Util.Packed.AbstractAppendingInt64Buffer.html#Lucene_Net_Util_Packed_AbstractAppendingInt64Buffer_RamBytesUsed">AbstractAppendingInt64Buffer.RamBytesUsed()</a></div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_MonotonicAppendingInt64Buffer.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.MonotonicAppendingInt64Buffer%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/Packed/MonotonicAppendingLongBuffer.cs/#L33" 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>