| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SpatialArgs |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SpatialArgs |
| | 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.Queries.SpatialArgs"> |
| |
| |
| <h1 id="Lucene_Net_Spatial_Queries_SpatialArgs" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs" class="text-break">Class SpatialArgs |
| </h1> |
| <div class="markdown level0 summary"><p>Principally holds the query <span class="xref">Spatial4n.Core.Shapes.IShape</span> and the <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a>. |
| It's used as an argument to some methods on <a class="xref" href="Lucene.Net.Spatial.SpatialStrategy.html">SpatialStrategy</a>.</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">SpatialArgs</span></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.Queries.html">Lucene.Net.Spatial.Queries</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Spatial.dll</h6> |
| <h5 id="Lucene_Net_Spatial_Queries_SpatialArgs_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SpatialArgs</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_Queries_SpatialArgs__ctor_Lucene_Net_Spatial_Queries_SpatialOperation_Spatial4n_Core_Shapes_IShape_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.%23ctor(Lucene.Net.Spatial.Queries.SpatialOperation%2CSpatial4n.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/Query/SpatialArgs.cs/#L39">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs__ctor_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.#ctor*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs__ctor_Lucene_Net_Spatial_Queries_SpatialOperation_Spatial4n_Core_Shapes_IShape_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.#ctor(Lucene.Net.Spatial.Queries.SpatialOperation,Spatial4n.Core.Shapes.IShape)">SpatialArgs(SpatialOperation, IShape)</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 SpatialArgs(SpatialOperation operation, 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><a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a></td> |
| <td><span class="parametername">operation</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Spatial4n.Core.Shapes.IShape</span></td> |
| <td><span class="parametername">shape</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_Queries_SpatialArgs_DEFAULT_DISTERRPCT.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.DEFAULT_DISTERRPCT%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/Query/SpatialArgs.cs/#L32">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_DEFAULT_DISTERRPCT" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.DEFAULT_DISTERRPCT">DEFAULT_DISTERRPCT</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 static readonly double DEFAULT_DISTERRPCT</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">System.Double</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_Queries_SpatialArgs_DistErr.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.DistErr%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/Query/SpatialArgs.cs/#L152">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_DistErr_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.DistErr*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_DistErr" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.DistErr">DistErr</h4> |
| <div class="markdown level1 summary"><p>The acceptable error of the shape. This effectively inflates the |
| size of the shape but should not shrink it.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual double? DistErr { get; set; }</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.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><blockquote><p>= 0</p> |
| </blockquote> |
| </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_Queries_SpatialArgs_DistErrPct.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.DistErrPct%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/Query/SpatialArgs.cs/#L135">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_DistErrPct_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.DistErrPct*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_DistErrPct" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.DistErrPct">DistErrPct</h4> |
| <div class="markdown level1 summary"><p>A measure of acceptable error of the shape as a fraction. This effectively |
| inflates the size of the shape but should not shrink it.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual double? DistErrPct { get; set; }</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.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><p>0 to 0.5</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_Queries_SpatialArgs_Operation.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.Operation%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/Query/SpatialArgs.cs/#L118">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_Operation_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.Operation*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_Operation" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.Operation">Operation</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 SpatialOperation Operation { get; set; }</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><a class="xref" href="Lucene.Net.Spatial.Queries.SpatialOperation.html">SpatialOperation</a></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_Queries_SpatialArgs_Shape.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.Shape%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/Query/SpatialArgs.cs/#L124">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_Shape_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.Shape*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_Shape" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.Shape">Shape</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 IShape Shape { get; set; }</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.Shapes.IShape</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_Queries_SpatialArgs_CalcDistanceFromErrPct_Spatial4n_Core_Shapes_IShape_System_Double_Spatial4n_Core_Context_SpatialContext_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.CalcDistanceFromErrPct(Spatial4n.Core.Shapes.IShape%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/Query/SpatialArgs.cs/#L56">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_CalcDistanceFromErrPct_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.CalcDistanceFromErrPct*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_CalcDistanceFromErrPct_Spatial4n_Core_Shapes_IShape_System_Double_Spatial4n_Core_Context_SpatialContext_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.CalcDistanceFromErrPct(Spatial4n.Core.Shapes.IShape,System.Double,Spatial4n.Core.Context.SpatialContext)">CalcDistanceFromErrPct(IShape, Double, SpatialContext)</h4> |
| <div class="markdown level1 summary"><p>Computes the distance given a shape and the <code data-dev-comment-type="paramref" class="paramref">distErrPct</code>. The |
| algorithm is the fraction of the distance from the center of the query |
| shape to its furthest bounding box corner.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static double CalcDistanceFromErrPct(IShape shape, double distErrPct, 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">Spatial4n.Core.Shapes.IShape</span></td> |
| <td><span class="parametername">shape</span></td> |
| <td><p>Mandatory.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">distErrPct</span></td> |
| <td><p>0 to 0.5</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Spatial4n.Core.Context.SpatialContext</span></td> |
| <td><span class="parametername">ctx</span></td> |
| <td><p>Mandatory</p> |
| </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.Double</span></td> |
| <td><p>A distance (in degrees).</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_Queries_SpatialArgs_ResolveDistErr_Spatial4n_Core_Context_SpatialContext_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.ResolveDistErr(Spatial4n.Core.Context.SpatialContext%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/Query/SpatialArgs.cs/#L85">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_ResolveDistErr_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.ResolveDistErr*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_ResolveDistErr_Spatial4n_Core_Context_SpatialContext_System_Double_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.ResolveDistErr(Spatial4n.Core.Context.SpatialContext,System.Double)">ResolveDistErr(SpatialContext, Double)</h4> |
| <div class="markdown level1 summary"><p>Gets the error distance that specifies how precise the query shape is. This |
| looks at <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialArgs.html#Lucene_Net_Spatial_Queries_SpatialArgs_DistErr">DistErr</a>, <a class="xref" href="Lucene.Net.Spatial.Queries.SpatialArgs.html#Lucene_Net_Spatial_Queries_SpatialArgs_DistErrPct">DistErrPct</a>, and |
| <code data-dev-comment-type="paramref" class="paramref">defaultDistErrPct</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual double ResolveDistErr(SpatialContext ctx, double defaultDistErrPct)</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.Double</span></td> |
| <td><span class="parametername">defaultDistErrPct</span></td> |
| <td><p>0 to 0.5</p> |
| </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.Double</span></td> |
| <td><blockquote><p>= 0</p> |
| </blockquote> |
| </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_Queries_SpatialArgs_ToString.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.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/Query/SpatialArgs.cs/#L109">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_ToString_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.ToString*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_ToString" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.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> |
| <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_Queries_SpatialArgs_Validate.md&value=---%0Auid%3A%20Lucene.Net.Spatial.Queries.SpatialArgs.Validate%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/Query/SpatialArgs.cs/#L96">View Source</a> |
| </span> |
| <a id="Lucene_Net_Spatial_Queries_SpatialArgs_Validate_" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.Validate*"></a> |
| <h4 id="Lucene_Net_Spatial_Queries_SpatialArgs_Validate" data-uid="Lucene.Net.Spatial.Queries.SpatialArgs.Validate">Validate()</h4> |
| <div class="markdown level1 summary"><p>Check if the arguments make sense -- throw an exception if not</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Validate()</code></pre> |
| </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_Queries_SpatialArgs.md&value=---%0Auid%3A%20Lucene.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" 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/Query/SpatialArgs.cs/#L30" 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> |