blob: f9ff9731e2e5459f4c5bcb0cb778c669063afeb9 [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.Spatial.Util
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Spatial.Util
| 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="spatial/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.Spatial.Util">
<h1 id="Lucene_Net_Spatial_Util" data-uid="Lucene.Net.Spatial.Util" class="text-break">Namespace Lucene.Net.Spatial.Util
</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>Various spatial utilities.</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.Spatial.Util.CachingDoubleValueSource.html">CachingDoubleValueSource</a></h4>
<section><p>Caches the doubleVal of another value source in a HashMap
so that it is computed only once.</p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.html">DistanceToShapeValueSource</a></h4>
<section><p>The distance from a provided Point to a Point retrieved from a ValueSource via
<span class="xref">Lucene.Net.Queries.Function.FunctionValues.ObjectVal(System.Int32)</span>. The distance
is calculated via a <span class="xref">Spatial4n.Core.Distance.IDistanceCalculator</span>.</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.Spatial.Util.ShapeFieldCache-1.html">ShapeFieldCache&lt;T&gt;</a></h4>
<section><p>Bounded Cache of Shapes associated with docIds. Note, multiple Shapes can be
associated with a given docId
<p>
WARNING: This class holds the data in an extremely inefficient manner as all Points are in memory as objects and they
are stored in many Lists (one per document). So it works but doesn&apos;t scale. It will be replaced in the future.
<p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Spatial.Util.ShapeFieldCacheDistanceValueSource.html">ShapeFieldCacheDistanceValueSource</a></h4>
<section><p>An implementation of the Lucene ValueSource that returns the spatial distance
between an input point and a document&apos;s points in
<a class="xref" href="Lucene.Net.Spatial.Util.ShapeFieldCacheProvider-1.html">ShapeFieldCacheProvider&lt;T&gt;</a>. The shortest distance is returned if a
document has more than one point.</p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></section>
<h4><a class="xref" href="Lucene.Net.Spatial.Util.ShapeFieldCacheProvider-1.html">ShapeFieldCacheProvider&lt;T&gt;</a></h4>
<section><p>Provides access to a
<a class="xref" href="Lucene.Net.Spatial.Util.ShapeFieldCache-1.html">ShapeFieldCache&lt;T&gt;</a>
for a given
<span class="xref">Lucene.Net.Index.AtomicReader</span>.</p>
<p>If a Cache does not exist for the TextReader, then it is built by iterating over
the all terms for a given field, reconstructing the Shape from them, and adding
them to the Cache.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Spatial.Util.ShapePredicateValueSource.html">ShapePredicateValueSource</a></h4>
<section><p>A boolean <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> that compares a shape from a provided <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> with a given <span class="xref">Spatial4n.Core.Shapes.IShape</span> and sees
if it matches a given <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a> (the predicate).</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.Spatial.Util.ValueSourceFilter.html">ValueSourceFilter</a></h4>
<section><p><span class="xref">Lucene.Net.Search.Filter</span> that matches all documents where a <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> is
in between a range of <code>min</code> and <code>max</code> inclusive.</p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></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.Spatial/Util/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>