blob: c241bb53696bec2286ec9e6749a817799b5b7514 [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>Namespace Lucene.Net.Codecs.IntBlock
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Codecs.IntBlock
| 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="codecs/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.Codecs.IntBlock">
<h1 id="Lucene_Net_Codecs_IntBlock" data-uid="Lucene.Net.Codecs.IntBlock" class="text-break">Namespace Lucene.Net.Codecs.IntBlock
</h1>
<div class="markdown level0 summary"><!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<p>Intblock: base support for fixed or variable length block integer encoders</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.Codecs.IntBlock.FixedInt32BlockIndexInput.html">FixedInt32BlockIndexInput</a></h4>
<section><p>Abstract base class that reads fixed-size blocks of ints
from an <span class="xref">Lucene.Net.Store.IndexInput</span>. While this is a simple approach, a
more performant approach would directly create an impl
of <a class="xref" href="Lucene.Net.Codecs.Sep.Int32IndexInput.html">Int32IndexInput</a> inside <span class="xref">Lucene.Net.Store.Directory</span>. Wrapping a generic
<span class="xref">Lucene.Net.Store.IndexInput</span> will likely cost performance.
<p>
NOTE: This was FixedIntBlockIndexInput in Lucene
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Codecs.IntBlock.FixedInt32BlockIndexOutput.html">FixedInt32BlockIndexOutput</a></h4>
<section><p>Abstract base class that writes fixed-size blocks of ints
to an <span class="xref">Lucene.Net.Store.IndexOutput</span>. While this is a simple approach, a
more performant approach would directly create an impl
of <a class="xref" href="Lucene.Net.Codecs.Sep.Int32IndexOutput.html">Int32IndexOutput</a> inside <span class="xref">Lucene.Net.Store.Directory</span>. Wrapping a generic
<span class="xref">Lucene.Net.Store.IndexOutput</span> will likely cost performance.
<p>
NOTE: This was FixedIntBlockIndexOutput in Lucene
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Codecs.IntBlock.VariableInt32BlockIndexInput.html">VariableInt32BlockIndexInput</a></h4>
<section><p>Abstract base class that reads variable-size blocks of ints
from an <span class="xref">Lucene.Net.Store.IndexInput</span>. While this is a simple approach, a
more performant approach would directly create an impl
of <a class="xref" href="Lucene.Net.Codecs.Sep.Int32IndexInput.html">Int32IndexInput</a> inside <span class="xref">Lucene.Net.Store.Directory</span>. Wrapping a generic
<span class="xref">Lucene.Net.Store.IndexInput</span> will likely cost performance.
<p>
NOTE: This was VariableIntBlockIndexInput in Lucene
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Codecs.IntBlock.VariableInt32BlockIndexOutput.html">VariableInt32BlockIndexOutput</a></h4>
<section><p>Abstract base class that writes variable-size blocks of ints
to an <span class="xref">Lucene.Net.Store.IndexOutput</span>. While this is a simple approach, a
more performant approach would directly create an impl
of <a class="xref" href="Lucene.Net.Codecs.Sep.Int32IndexOutput.html">Int32IndexOutput</a> inside <span class="xref">Lucene.Net.Store.Directory</span>. Wrapping a generic
<span class="xref">Lucene.Net.Store.IndexOutput</span> will likely cost performance.
<p>
NOTE: This was VariableIntBlockIndexOutput in Lucene
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="Lucene.Net.Codecs.IntBlock.FixedInt32BlockIndexInput.IBlockReader.html">FixedInt32BlockIndexInput.IBlockReader</a></h4>
<section><p>Interface for fixed-size block decoders.
<p>
Implementations should decode into the buffer in <a class="xref" href="Lucene.Net.Codecs.IntBlock.FixedInt32BlockIndexInput.IBlockReader.html#Lucene_Net_Codecs_IntBlock_FixedInt32BlockIndexInput_IBlockReader_ReadBlock">ReadBlock()</a>.
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Codecs.IntBlock.VariableInt32BlockIndexInput.IBlockReader.html">VariableInt32BlockIndexInput.IBlockReader</a></h4>
<section><p>Interface for variable-size block decoders.
<p>
Implementations should decode into the buffer in <a class="xref" href="Lucene.Net.Codecs.IntBlock.VariableInt32BlockIndexInput.IBlockReader.html#Lucene_Net_Codecs_IntBlock_VariableInt32BlockIndexInput_IBlockReader_ReadBlock">ReadBlock()</a>.
</p></p>
</section>
</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/blob/docs/4.8.0-beta00010/src/Lucene.Net.Codecs/IntBlock/package.md/#L2" class="contribution-link">Improve this Doc</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>