blob: ff948c303b9f27fda99681ed94f2fce3600628a4 [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 DistanceToShapeValueSource
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DistanceToShapeValueSource
| 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.DistanceToShapeValueSource">
<h1 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource" class="text-break">Class DistanceToShapeValueSource
</h1>
<div class="markdown level0 summary"><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></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">Lucene.Net.Queries.Function.ValueSource</span></div>
<div class="level2"><span class="xref">DistanceToShapeValueSource</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">Lucene.Net.Queries.Function.ValueSource.ToString()</span>
</div>
<div>
<span class="xref">Lucene.Net.Queries.Function.ValueSource.NewContext(Lucene.Net.Search.IndexSearcher)</span>
</div>
<div>
<span class="xref">Lucene.Net.Queries.Function.ValueSource.GetSortField(System.Boolean)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</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.Spatial.Util.html">Lucene.Net.Spatial.Util</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Spatial.dll</h6>
<h5 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DistanceToShapeValueSource : ValueSource</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_Spatial_Util_DistanceToShapeValueSource__ctor_Lucene_Net_Queries_Function_ValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_Spatial4n_Core_Context_SpatialContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource.%23ctor(Lucene.Net.Queries.Function.ValueSource%2CSpatial4n.Core.Shapes.IPoint%2CSystem.Double%2CSpatial4n.Core.Context.SpatialContext)%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.Spatial/Util/DistanceToShapeValueSource.cs/#L46">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource__ctor_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.#ctor*"></a>
<h4 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource__ctor_Lucene_Net_Queries_Function_ValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_Spatial4n_Core_Context_SpatialContext_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.#ctor(Lucene.Net.Queries.Function.ValueSource,Spatial4n.Core.Shapes.IPoint,System.Double,Spatial4n.Core.Context.SpatialContext)">DistanceToShapeValueSource(ValueSource, IPoint, Double, SpatialContext)</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 DistanceToShapeValueSource(ValueSource shapeValueSource, IPoint queryPoint, double multiplier, SpatialContext ctx)</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">Lucene.Net.Queries.Function.ValueSource</span></td>
<td><span class="parametername">shapeValueSource</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Spatial4n.Core.Shapes.IPoint</span></td>
<td><span class="parametername">queryPoint</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Double</span></td>
<td><span class="parametername">multiplier</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Spatial4n.Core.Context.SpatialContext</span></td>
<td><span class="parametername">ctx</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_Spatial_Util_DistanceToShapeValueSource_CreateWeight_System_Collections_IDictionary_Lucene_Net_Search_IndexSearcher_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource.CreateWeight(System.Collections.IDictionary%2CLucene.Net.Search.IndexSearcher)%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.Spatial/Util/DistanceToShapeValueSource.cs/#L62">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_CreateWeight_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.CreateWeight*"></a>
<h4 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_CreateWeight_System_Collections_IDictionary_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.CreateWeight(System.Collections.IDictionary,Lucene.Net.Search.IndexSearcher)">CreateWeight(IDictionary, IndexSearcher)</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 void CreateWeight(IDictionary context, IndexSearcher searcher)</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.IDictionary</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td>
<td><span class="parametername">searcher</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Queries.Function.ValueSource.CreateWeight(System.Collections.IDictionary, Lucene.Net.Search.IndexSearcher)</span></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_Spatial_Util_DistanceToShapeValueSource_Equals_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource.Equals(System.Object)%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.Spatial/Util/DistanceToShapeValueSource.cs/#L103">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_Equals_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.Equals*"></a>
<h4 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_Equals_System_Object_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.Equals(System.Object)">Equals(Object)</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 bool Equals(object o)</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.Object</span></td>
<td><span class="parametername">o</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Queries.Function.ValueSource.Equals(System.Object)</span></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_Spatial_Util_DistanceToShapeValueSource_GetDescription.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetDescription%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.Spatial/Util/DistanceToShapeValueSource.cs/#L57">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_GetDescription_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetDescription*"></a>
<h4 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_GetDescription" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetDescription">GetDescription()</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 string GetDescription()</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Queries.Function.ValueSource.GetDescription()</span></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_Spatial_Util_DistanceToShapeValueSource_GetHashCode.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetHashCode%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.Spatial/Util/DistanceToShapeValueSource.cs/#L118">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_GetHashCode_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetHashCode*"></a>
<h4 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_GetHashCode" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetHashCode">GetHashCode()</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 int GetHashCode()</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Queries.Function.ValueSource.GetHashCode()</span></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_Spatial_Util_DistanceToShapeValueSource_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetValues(System.Collections.IDictionary%2CLucene.Net.Index.AtomicReaderContext)%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.Spatial/Util/DistanceToShapeValueSource.cs/#L67">View Source</a>
</span>
<a id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_GetValues_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetValues*"></a>
<h4 id="Lucene_Net_Spatial_Util_DistanceToShapeValueSource_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Spatial.Util.DistanceToShapeValueSource.GetValues(System.Collections.IDictionary,Lucene.Net.Index.AtomicReaderContext)">GetValues(IDictionary, AtomicReaderContext)</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 FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)</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.IDictionary</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Index.AtomicReaderContext</span></td>
<td><span class="parametername">readerContext</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">Lucene.Net.Queries.Function.FunctionValues</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Queries.Function.ValueSource.GetValues(System.Collections.IDictionary, Lucene.Net.Index.AtomicReaderContext)</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Spatial_Util_DistanceToShapeValueSource.md&amp;value=---%0Auid%3A%20Lucene.Net.Spatial.Util.DistanceToShapeValueSource%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.Spatial/Util/DistanceToShapeValueSource.cs/#L36" 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>