| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class CheckHits |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class CheckHits |
| | 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="test-framework/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.Search.CheckHits"> |
| |
| |
| <h1 id="Lucene_Net_Search_CheckHits" data-uid="Lucene.Net.Search.CheckHits" class="text-break">Class CheckHits |
| </h1> |
| <div class="markdown level0 summary"><p>Utility class for asserting expected hits in tests.</p> |
| </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">CheckHits</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> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.TestFramework.dll</h6> |
| <h5 id="Lucene_Net_Search_CheckHits_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static class CheckHits</code></pre> |
| </div> |
| <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_Search_CheckHits_EXPLAIN_SCORE_TOLERANCE_DELTA.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.EXPLAIN_SCORE_TOLERANCE_DELTA%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.TestFramework/Search/CheckHits.cs/#L41">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_CheckHits_EXPLAIN_SCORE_TOLERANCE_DELTA" data-uid="Lucene.Net.Search.CheckHits.EXPLAIN_SCORE_TOLERANCE_DELTA">EXPLAIN_SCORE_TOLERANCE_DELTA</h4> |
| <div class="markdown level1 summary"><p>Some explains methods calculate their values though a slightly |
| different order of operations from the actual scoring method ... |
| this allows for a small amount of relative variation</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float EXPLAIN_SCORE_TOLERANCE_DELTA</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.Single</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_Search_CheckHits_EXPLAIN_SCORE_TOLERANCE_MINIMUM.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.EXPLAIN_SCORE_TOLERANCE_MINIMUM%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.TestFramework/Search/CheckHits.cs/#L49">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_CheckHits_EXPLAIN_SCORE_TOLERANCE_MINIMUM" data-uid="Lucene.Net.Search.CheckHits.EXPLAIN_SCORE_TOLERANCE_MINIMUM">EXPLAIN_SCORE_TOLERANCE_MINIMUM</h4> |
| <div class="markdown level1 summary"><p>In general we use a relative epsilon, but some tests do crazy things |
| like boost documents with 0, creating tiny tiny scores where the |
| relative difference is large but the absolute difference is tiny. |
| we ensure the the epsilon is always at least this big.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float EXPLAIN_SCORE_TOLERANCE_MINIMUM</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.Single</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_Search_CheckHits_CheckDocIds_System_String_System_Int32___Lucene_Net_Search_ScoreDoc___.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckDocIds(System.String%2CSystem.Int32%5B%5D%2CLucene.Net.Search.ScoreDoc%5B%5D)%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.TestFramework/Search/CheckHits.cs/#L207">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckDocIds_" data-uid="Lucene.Net.Search.CheckHits.CheckDocIds*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckDocIds_System_String_System_Int32___Lucene_Net_Search_ScoreDoc___" data-uid="Lucene.Net.Search.CheckHits.CheckDocIds(System.String,System.Int32[],Lucene.Net.Search.ScoreDoc[])">CheckDocIds(String, Int32[], ScoreDoc[])</h4> |
| <div class="markdown level1 summary"><p>Tests that a Hits has an expected order of documents. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CheckDocIds(string mes, int[] results, ScoreDoc[] hits)</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.String</span></td> |
| <td><span class="parametername">mes</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span>[]</td> |
| <td><span class="parametername">results</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits</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_Search_CheckHits_CheckEqual_Lucene_Net_Search_Query_Lucene_Net_Search_ScoreDoc___Lucene_Net_Search_ScoreDoc___.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckEqual(Lucene.Net.Search.Query%2CLucene.Net.Search.ScoreDoc%5B%5D%2CLucene.Net.Search.ScoreDoc%5B%5D)%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.TestFramework/Search/CheckHits.cs/#L227">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckEqual_" data-uid="Lucene.Net.Search.CheckHits.CheckEqual*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckEqual_Lucene_Net_Search_Query_Lucene_Net_Search_ScoreDoc___Lucene_Net_Search_ScoreDoc___" data-uid="Lucene.Net.Search.CheckHits.CheckEqual(Lucene.Net.Search.Query,Lucene.Net.Search.ScoreDoc[],Lucene.Net.Search.ScoreDoc[])">CheckEqual(Query, ScoreDoc[], ScoreDoc[])</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 void CheckEqual(Query query, ScoreDoc[] hits1, ScoreDoc[] hits2)</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.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits1</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits2</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_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckExplanations(Lucene.Net.Search.Query%2CSystem.String%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.TestFramework/Search/CheckHits.cs/#L319">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckExplanations_" data-uid="Lucene.Net.Search.CheckHits.CheckExplanations*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Search.CheckHits.CheckExplanations(Lucene.Net.Search.Query,System.String,Lucene.Net.Search.IndexSearcher)">CheckExplanations(Query, String, IndexSearcher)</h4> |
| <div class="markdown level1 summary"><p>Asserts that the explanation value for every document matching a |
| query corresponds with the true score. |
| <p> |
| See <a class="xref" href="Lucene.Net.Search.CheckHits.html#Lucene_Net_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Boolean_">CheckExplanations(Query, String, IndexSearcher, Boolean)</a> for a |
| "deep" testing of the explanation details.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CheckExplanations(Query query, string defaultFieldName, 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">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to test. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">defaultFieldName</span></td> |
| <td><p>Used for displaing the query in assertion messages. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The searcher to test the query against. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.ExplanationAsserter.html">ExplanationAsserter</a></div> |
| <div><a class="xref" href="Lucene.Net.Search.CheckHits.html#Lucene_Net_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Boolean_">CheckExplanations(Query, String, IndexSearcher, Boolean)</a></div> |
| </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_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckExplanations(Lucene.Net.Search.Query%2CSystem.String%2CLucene.Net.Search.IndexSearcher%2CSystem.Boolean)%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.TestFramework/Search/CheckHits.cs/#L334">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckExplanations_" data-uid="Lucene.Net.Search.CheckHits.CheckExplanations*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Boolean_" data-uid="Lucene.Net.Search.CheckHits.CheckExplanations(Lucene.Net.Search.Query,System.String,Lucene.Net.Search.IndexSearcher,System.Boolean)">CheckExplanations(Query, String, IndexSearcher, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Asserts that the explanation value for every document matching a |
| query corresponds with the true score. Optionally does "deep" |
| testing of the explanation details.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CheckExplanations(Query query, string defaultFieldName, IndexSearcher searcher, bool deep)</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.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to test. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">defaultFieldName</span></td> |
| <td><p>Used for displaing the query in assertion messages. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The searcher to test the query against. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">deep</span></td> |
| <td><p>Indicates whether a deep comparison of sub-Explanation details should be executed. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Search_CheckHits_CheckExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Boolean__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.ExplanationAsserter.html">ExplanationAsserter</a></div> |
| </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_Search_CheckHits_CheckHitCollector_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckHitCollector(System.Random%2CLucene.Net.Search.Query%2CSystem.String%2CLucene.Net.Search.IndexSearcher%2CSystem.Int32%5B%5D)%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.TestFramework/Search/CheckHits.cs/#L93">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckHitCollector_" data-uid="Lucene.Net.Search.CheckHits.CheckHitCollector*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckHitCollector_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___" data-uid="Lucene.Net.Search.CheckHits.CheckHitCollector(System.Random,Lucene.Net.Search.Query,System.String,Lucene.Net.Search.IndexSearcher,System.Int32[])">CheckHitCollector(Random, Query, String, IndexSearcher, Int32[])</h4> |
| <div class="markdown level1 summary"><p>Tests that a query matches the an expected set of documents using a |
| HitCollector. |
| <p> |
| Note that when using the HitCollector API, documents will be collected |
| if they "match" regardless of what their score is. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CheckHitCollector(Random random, Query query, string defaultFieldName, IndexSearcher searcher, int[] results)</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.Random</span></td> |
| <td><span class="parametername">random</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>The query to test. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">defaultFieldName</span></td> |
| <td><p>Used for displaying the query in assertion messages. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>The searcher to test the query against. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span>[]</td> |
| <td><span class="parametername">results</span></td> |
| <td><p>A list of documentIds that must match the query. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Search_CheckHits_CheckHitCollector_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32____seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.CheckHits.html#Lucene_Net_Search_CheckHits_DoCheckHits_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___">DoCheckHits(Random, Query, String, IndexSearcher, Int32[])</a></div> |
| </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_Search_CheckHits_CheckHitsQuery_Lucene_Net_Search_Query_Lucene_Net_Search_ScoreDoc___Lucene_Net_Search_ScoreDoc___System_Int32___.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckHitsQuery(Lucene.Net.Search.Query%2CLucene.Net.Search.ScoreDoc%5B%5D%2CLucene.Net.Search.ScoreDoc%5B%5D%2CSystem.Int32%5B%5D)%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.TestFramework/Search/CheckHits.cs/#L220">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckHitsQuery_" data-uid="Lucene.Net.Search.CheckHits.CheckHitsQuery*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckHitsQuery_Lucene_Net_Search_Query_Lucene_Net_Search_ScoreDoc___Lucene_Net_Search_ScoreDoc___System_Int32___" data-uid="Lucene.Net.Search.CheckHits.CheckHitsQuery(Lucene.Net.Search.Query,Lucene.Net.Search.ScoreDoc[],Lucene.Net.Search.ScoreDoc[],System.Int32[])">CheckHitsQuery(Query, ScoreDoc[], ScoreDoc[], Int32[])</h4> |
| <div class="markdown level1 summary"><p>Tests that two queries have an expected order of documents, |
| and that the two queries have the same score values.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CheckHitsQuery(Query query, ScoreDoc[] hits1, ScoreDoc[] hits2, int[] results)</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.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits1</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits2</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span>[]</td> |
| <td><span class="parametername">results</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_Search_CheckHits_CheckNoMatchExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.CheckNoMatchExplanations(Lucene.Net.Search.Query%2CSystem.String%2CLucene.Net.Search.IndexSearcher%2CSystem.Int32%5B%5D)%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.TestFramework/Search/CheckHits.cs/#L56">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_CheckNoMatchExplanations_" data-uid="Lucene.Net.Search.CheckHits.CheckNoMatchExplanations*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_CheckNoMatchExplanations_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___" data-uid="Lucene.Net.Search.CheckHits.CheckNoMatchExplanations(Lucene.Net.Search.Query,System.String,Lucene.Net.Search.IndexSearcher,System.Int32[])">CheckNoMatchExplanations(Query, String, IndexSearcher, Int32[])</h4> |
| <div class="markdown level1 summary"><p>Tests that all documents up to maxDoc which are <em>not</em> in the |
| expected result set, have an explanation which indicates that |
| the document does not match</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CheckNoMatchExplanations(Query q, string defaultFieldName, IndexSearcher searcher, int[] results)</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.Search.Query</span></td> |
| <td><span class="parametername">q</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">defaultFieldName</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> |
| <tr> |
| <td><span class="xref">System.Int32</span>[]</td> |
| <td><span class="parametername">results</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_Search_CheckHits_DoCheckHits_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.DoCheckHits(System.Random%2CLucene.Net.Search.Query%2CSystem.String%2CLucene.Net.Search.IndexSearcher%2CSystem.Int32%5B%5D)%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.TestFramework/Search/CheckHits.cs/#L162">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_DoCheckHits_" data-uid="Lucene.Net.Search.CheckHits.DoCheckHits*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_DoCheckHits_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___" data-uid="Lucene.Net.Search.CheckHits.DoCheckHits(System.Random,Lucene.Net.Search.Query,System.String,Lucene.Net.Search.IndexSearcher,System.Int32[])">DoCheckHits(Random, Query, String, IndexSearcher, Int32[])</h4> |
| <div class="markdown level1 summary"><p>Tests that a query matches the an expected set of documents using Hits.</p> |
| <p>Note that when using the Hits API, documents will only be returned |
| if they have a positive normalized score. |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void DoCheckHits(Random random, Query query, string defaultFieldName, IndexSearcher searcher, int[] results)</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.Random</span></td> |
| <td><span class="parametername">random</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>the query to test </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">defaultFieldName</span></td> |
| <td><p>used for displaing the query in assertion messages </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>the searcher to test the query against </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span>[]</td> |
| <td><span class="parametername">results</span></td> |
| <td><p>a list of documentIds that must match the query </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Search_CheckHits_DoCheckHits_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32____seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.CheckHits.html#Lucene_Net_Search_CheckHits_CheckHitCollector_System_Random_Lucene_Net_Search_Query_System_String_Lucene_Net_Search_IndexSearcher_System_Int32___">CheckHitCollector(Random, Query, String, IndexSearcher, Int32[])</a></div> |
| </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_Search_CheckHits_ExplainToleranceDelta_System_Single_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.ExplainToleranceDelta(System.Single%2CSystem.Single)%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.TestFramework/Search/CheckHits.cs/#L343">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_ExplainToleranceDelta_" data-uid="Lucene.Net.Search.CheckHits.ExplainToleranceDelta*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_ExplainToleranceDelta_System_Single_System_Single_" data-uid="Lucene.Net.Search.CheckHits.ExplainToleranceDelta(System.Single,System.Single)">ExplainToleranceDelta(Single, Single)</h4> |
| <div class="markdown level1 summary"><p>Returns a reasonable epsilon for comparing two floats, |
| where minor differences are acceptable such as score vs. explain.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float ExplainToleranceDelta(float f1, float f2)</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.Single</span></td> |
| <td><span class="parametername">f1</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">f2</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.Single</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_Search_CheckHits_Hits2str_Lucene_Net_Search_ScoreDoc___Lucene_Net_Search_ScoreDoc___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.Hits2str(Lucene.Net.Search.ScoreDoc%5B%5D%2CLucene.Net.Search.ScoreDoc%5B%5D%2CSystem.Int32%2CSystem.Int32)%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.TestFramework/Search/CheckHits.cs/#L248">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_Hits2str_" data-uid="Lucene.Net.Search.CheckHits.Hits2str*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_Hits2str_Lucene_Net_Search_ScoreDoc___Lucene_Net_Search_ScoreDoc___System_Int32_System_Int32_" data-uid="Lucene.Net.Search.CheckHits.Hits2str(Lucene.Net.Search.ScoreDoc[],Lucene.Net.Search.ScoreDoc[],System.Int32,System.Int32)">Hits2str(ScoreDoc[], ScoreDoc[], Int32, Int32)</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 string Hits2str(ScoreDoc[] hits1, ScoreDoc[] hits2, int start, int end)</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.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits1</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ScoreDoc</span>[]</td> |
| <td><span class="parametername">hits2</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">start</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">end</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.String</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_Search_CheckHits_TopDocsString_Lucene_Net_Search_TopDocs_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.TopDocsString(Lucene.Net.Search.TopDocs%2CSystem.Int32%2CSystem.Int32)%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.TestFramework/Search/CheckHits.cs/#L282">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_TopDocsString_" data-uid="Lucene.Net.Search.CheckHits.TopDocsString*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_TopDocsString_Lucene_Net_Search_TopDocs_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.CheckHits.TopDocsString(Lucene.Net.Search.TopDocs,System.Int32,System.Int32)">TopDocsString(TopDocs, Int32, Int32)</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 string TopDocsString(TopDocs docs, int start, int end)</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.Search.TopDocs</span></td> |
| <td><span class="parametername">docs</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">start</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">end</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.String</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_Search_CheckHits_VerifyExplanation_System_String_System_Int32_System_Single_System_Boolean_Lucene_Net_Search_Explanation_.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits.VerifyExplanation(System.String%2CSystem.Int32%2CSystem.Single%2CSystem.Boolean%2CLucene.Net.Search.Explanation)%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.TestFramework/Search/CheckHits.cs/#L357">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_CheckHits_VerifyExplanation_" data-uid="Lucene.Net.Search.CheckHits.VerifyExplanation*"></a> |
| <h4 id="Lucene_Net_Search_CheckHits_VerifyExplanation_System_String_System_Int32_System_Single_System_Boolean_Lucene_Net_Search_Explanation_" data-uid="Lucene.Net.Search.CheckHits.VerifyExplanation(System.String,System.Int32,System.Single,System.Boolean,Lucene.Net.Search.Explanation)">VerifyExplanation(String, Int32, Single, Boolean, Explanation)</h4> |
| <div class="markdown level1 summary"><p>Assert that an explanation has the expected score, and optionally that its |
| sub-details max/sum/factor match to that score.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void VerifyExplanation(string q, int doc, float score, bool deep, Explanation expl)</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.String</span></td> |
| <td><span class="parametername">q</span></td> |
| <td><p>String representation of the query for assertion messages. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">doc</span></td> |
| <td><p>Document ID for assertion messages. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">score</span></td> |
| <td><p>Real score value of doc with query <code data-dev-comment-type="paramref" class="paramref">q</code>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">deep</span></td> |
| <td><p>Indicates whether a deep comparison of sub-Explanation details should be executed. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Explanation</span></td> |
| <td><span class="parametername">expl</span></td> |
| <td><p>The <span class="xref">Lucene.Net.Search.Explanation</span> to match against score. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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_Search_CheckHits.md&value=---%0Auid%3A%20Lucene.Net.Search.CheckHits%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.TestFramework/Search/CheckHits.cs/#L34" 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> |
