| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SpatialStrategy |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SpatialStrategy |
| | 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.SpatialStrategy"> |
| |
| |
| <h1 id="Lucene_Net_Spatial_SpatialStrategy" data-uid="Lucene.Net.Spatial.SpatialStrategy" class="text-break">Class SpatialStrategy |
| </h1> |
| <div class="markdown level0 summary"><p>The <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html">SpatialStrategy</a> encapsulates an approach to indexing and searching based on shapes. |
| <p> |
| Different implementations will support different features. A strategy should |
| document these common elements: |
| <ul><li>Can it index more than one shape per field?</li><li>What types of shapes can be indexed?</li><li>What types of query shapes can be used?</li><li>What types of query operations are supported? This might vary per shape.</li><li>Does it use the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.FieldCache.html">FieldCache</a>, or some other type of cache? When?</li></ul> |
| If a strategy only supports certain shapes at index or query time, then in |
| general it will throw an exception if given an incompatible one. It will not |
| be coerced into compatibility. |
| <p> |
| Note that a SpatialStrategy is not involved with the Lucene stored field values of shapes, which is |
| immaterial to indexing and search. |
| <p> |
| Thread-safe.</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">SpatialStrategy</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Spatial.Prefix.PrefixTreeStrategy.html">PrefixTreeStrategy</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Spatial.Serialized.SerializedDVStrategy.html">SerializedDVStrategy</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Spatial.Vector.PointVectorStrategy.html">PointVectorStrategy</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <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.Spatial.html">Lucene.Net.Spatial</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Spatial.dll</h6> |
| <h5 id="Lucene_Net_Spatial_SpatialStrategy_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class SpatialStrategy</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_SpatialStrategy__ctor_Spatial4n_Core_Context_SpatialContext_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.%23ctor(Spatial4n.Core.Context.SpatialContext%2CSystem.String)%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/SpatialStrategy.cs/#L60">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy__ctor_" data-uid="Lucene.Net.Spatial.SpatialStrategy.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy__ctor_Spatial4n_Core_Context_SpatialContext_System_String_" data-uid="Lucene.Net.Spatial.SpatialStrategy.#ctor(Spatial4n.Core.Context.SpatialContext,System.String)">SpatialStrategy(SpatialContext, String)</h4> |
| <div class="markdown level1 summary"><p>Constructs the spatial strategy with its mandatory arguments.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected SpatialStrategy(SpatialContext ctx, string fieldName)</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">Spatial4n.Core.Context.SpatialContext</span></td> |
| <td><span class="parametername">ctx</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </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_SpatialStrategy_m_ctx.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.m_ctx%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/SpatialStrategy.cs/#L54">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_m_ctx" data-uid="Lucene.Net.Spatial.SpatialStrategy.m_ctx">m_ctx</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 readonly SpatialContext m_ctx</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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">Spatial4n.Core.Context.SpatialContext</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </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_SpatialStrategy_FieldName.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.FieldName%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/SpatialStrategy.cs/#L77">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_FieldName_" data-uid="Lucene.Net.Spatial.SpatialStrategy.FieldName*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_FieldName" data-uid="Lucene.Net.Spatial.SpatialStrategy.FieldName">FieldName</h4> |
| <div class="markdown level1 summary"><p>The name of the field or the prefix of them if there are multiple |
| fields needed internally.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string FieldName { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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><p>Not null.</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_Spatial_SpatialStrategy_SpatialContext.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.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/SpatialStrategy.cs/#L70">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_SpatialContext_" data-uid="Lucene.Net.Spatial.SpatialStrategy.SpatialContext*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_SpatialContext" data-uid="Lucene.Net.Spatial.SpatialStrategy.SpatialContext">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 virtual SpatialContext SpatialContext { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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">Spatial4n.Core.Context.SpatialContext</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_SpatialStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.CreateIndexableFields(Spatial4n.Core.Shapes.IShape)%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/SpatialStrategy.cs/#L95">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_CreateIndexableFields_" data-uid="Lucene.Net.Spatial.SpatialStrategy.CreateIndexableFields*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_CreateIndexableFields_Spatial4n_Core_Shapes_IShape_" data-uid="Lucene.Net.Spatial.SpatialStrategy.CreateIndexableFields(Spatial4n.Core.Shapes.IShape)">CreateIndexableFields(IShape)</h4> |
| <div class="markdown level1 summary"><p>Returns the IndexableField(s) from the <code data-dev-comment-type="paramref" class="paramref">shape</code> that are to be |
| added to the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Document.html">Document</a>. These fields |
| are expected to be marked as indexed and not stored. |
| <p> |
| Note: If you want to <em>store</em> the shape as a string for retrieval in search |
| results, you could add it like this:</p> |
| <pre><code> document.Add(new StoredField(fieldName, ctx.ToString(shape)));</code></pre> |
| <p>The particular string representation used doesn't matter to the Strategy since it |
| doesn't use it.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract Field[] CreateIndexableFields(IShape shape)</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">Spatial4n.Core.Shapes.IShape</span></td> |
| <td><span class="parametername">shape</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><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html">Field</a>[]</td> |
| <td><p>Not null nor will it have null elements.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>if given a shape incompatible with the strategy</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_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.MakeDistanceValueSource(Spatial4n.Core.Shapes.IPoint)%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/SpatialStrategy.cs/#L101">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeDistanceValueSource*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeDistanceValueSource(Spatial4n.Core.Shapes.IPoint)">MakeDistanceValueSource(IPoint)</h4> |
| <div class="markdown level1 summary"><p>See <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_">MakeDistanceValueSource(IPoint, Double)</a> called with |
| a multiplier of 1.0 (i.e. units of degrees).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ValueSource MakeDistanceValueSource(IPoint queryPoint)</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">Spatial4n.Core.Shapes.IPoint</span></td> |
| <td><span class="parametername">queryPoint</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.ValueSource</span></td> |
| <td></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_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.MakeDistanceValueSource(Spatial4n.Core.Shapes.IPoint%2CSystem.Double)%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/SpatialStrategy.cs/#L112">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeDistanceValueSource*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_System_Double_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeDistanceValueSource(Spatial4n.Core.Shapes.IPoint,System.Double)">MakeDistanceValueSource(IPoint, Double)</h4> |
| <div class="markdown level1 summary"><p>Make a ValueSource returning the distance between the center of the |
| indexed shape and <code data-dev-comment-type="paramref" class="paramref">queryPoint</code>. If there are multiple indexed shapes |
| then the closest one is chosen. The result is multiplied by <code data-dev-comment-type="paramref" class="paramref">multiplier</code>, which |
| conveniently is used to get the desired units.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract ValueSource MakeDistanceValueSource(IPoint queryPoint, double multiplier)</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">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> |
| </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.ValueSource</span></td> |
| <td></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_Spatial_SpatialStrategy_MakeFilter_Lucene_Net_Spatial_Queries_SpatialArgs_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.MakeFilter(Lucene.Net.Spatial.Queries.SpatialArgs)%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/SpatialStrategy.cs/#L138">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_MakeFilter_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeFilter*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_MakeFilter_Lucene_Net_Spatial_Queries_SpatialArgs_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeFilter(Lucene.Net.Spatial.Queries.SpatialArgs)">MakeFilter(SpatialArgs)</h4> |
| <div class="markdown level1 summary"><p>Make a Filter based principally on <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a> |
| and <span class="xref">Spatial4n.Core.Shapes.IShape</span> from the supplied <code data-dev-comment-type="paramref" class="paramref">args</code>. |
| <p> |
| If a subclasses implements |
| <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeQuery_Lucene_Net_Spatial_Queries_SpatialArgs_">MakeQuery(SpatialArgs)</a> |
| then this method could be simply:</p> |
| <pre><code>return new QueryWrapperFilter(MakeQuery(args).Query);</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract Filter MakeFilter(SpatialArgs args)</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.Spatial.Queries.SpatialArgs.html">SpatialArgs</a></td> |
| <td><span class="parametername">args</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.Search.Filter</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>If the strategy does not support the shape in <code data-dev-comment-type="paramref" class="paramref">args</code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Spatial.Queries.UnsupportedSpatialOperation.html">UnsupportedSpatialOperation</a></td> |
| <td><p>If the strategy does not support the <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a> in <code data-dev-comment-type="paramref" class="paramref">args</code>.</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_Spatial_SpatialStrategy_MakeQuery_Lucene_Net_Spatial_Queries_SpatialArgs_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.MakeQuery(Lucene.Net.Spatial.Queries.SpatialArgs)%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/SpatialStrategy.cs/#L122">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_MakeQuery_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeQuery*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_MakeQuery_Lucene_Net_Spatial_Queries_SpatialArgs_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeQuery(Lucene.Net.Spatial.Queries.SpatialArgs)">MakeQuery(SpatialArgs)</h4> |
| <div class="markdown level1 summary"><p>Make a Query based principally on <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a> |
| and <span class="xref">Spatial4n.Core.Shapes.IShape</span> from the supplied <code data-dev-comment-type="paramref" class="paramref">args</code>. |
| The default implementation is</p> |
| <pre><code>return new ConstantScoreQuery(MakeFilter(args));</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual ConstantScoreQuery MakeQuery(SpatialArgs args)</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.Spatial.Queries.SpatialArgs.html">SpatialArgs</a></td> |
| <td><span class="parametername">args</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.Search.ConstantScoreQuery</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>If the strategy does not support the shape in <code data-dev-comment-type="paramref" class="paramref">args</code>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Spatial.Queries.UnsupportedSpatialOperation.html">UnsupportedSpatialOperation</a></td> |
| <td><p>If the strategy does not support the <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a> in <code data-dev-comment-type="paramref" class="paramref">args</code>.</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_Spatial_SpatialStrategy_MakeRecipDistanceValueSource_Spatial4n_Core_Shapes_IShape_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.MakeRecipDistanceValueSource(Spatial4n.Core.Shapes.IShape)%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/SpatialStrategy.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_MakeRecipDistanceValueSource_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeRecipDistanceValueSource*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_MakeRecipDistanceValueSource_Spatial4n_Core_Shapes_IShape_" data-uid="Lucene.Net.Spatial.SpatialStrategy.MakeRecipDistanceValueSource(Spatial4n.Core.Shapes.IShape)">MakeRecipDistanceValueSource(IShape)</h4> |
| <div class="markdown level1 summary"><p>Returns a ValueSource with values ranging from 1 to 0, depending inversely |
| on the distance from <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html#Lucene_Net_Spatial_SpatialStrategy_MakeDistanceValueSource_Spatial4n_Core_Shapes_IPoint_">MakeDistanceValueSource(IPoint)</a>. |
| The formula is <code>c / (d + c)</code> where 'd' is the distance and 'c' is |
| one tenth the distance to the farthest edge from the center. Thus the |
| scores will be 1 for indexed points at the center of the query shape and as |
| low as ~0.1 at its furthest edges.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ValueSource MakeRecipDistanceValueSource(IShape queryShape)</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">Spatial4n.Core.Shapes.IShape</span></td> |
| <td><span class="parametername">queryShape</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.ValueSource</span></td> |
| <td></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_Spatial_SpatialStrategy_ToString.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy.ToString%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/SpatialStrategy.cs/#L158">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_SpatialStrategy_ToString_" data-uid="Lucene.Net.Spatial.SpatialStrategy.ToString*"></a> |
| <h4 id="Lucene_Net_Spatial_SpatialStrategy_ToString" data-uid="Lucene.Net.Spatial.SpatialStrategy.ToString">ToString()</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 ToString()</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">System.Object.ToString()</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_SpatialStrategy.md&value=---%0Auid%3A%20Lucene.Net.Spatial.SpatialStrategy%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/SpatialStrategy.cs/#L52" 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> |
