| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class QualityBenchmark |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class QualityBenchmark |
| | 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="benchmark/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.Benchmarks.Quality.QualityBenchmark"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark" class="text-break">Class QualityBenchmark |
| </h1> |
| <div class="markdown level0 summary"><p>Main entry point for running a quality benchmark. |
| <p> |
| There are two main configurations for running a quality benchmark: |
| <ul><li>Against existing judgements.</li><li>For submission (e.g. for a contest).</li></ul> |
| The first configuration requires a non null <a class="xref" href="Lucene.Net.Benchmarks.Quality.IJudge.html">IJudge</a>. |
| The second configuration requires a non null <a class="xref" href="Lucene.Net.Benchmarks.Quality.Utils.SubmissionReport.html">SubmissionReport</a>.</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">QualityBenchmark</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.Benchmarks.Quality.html">Lucene.Net.Benchmarks.Quality</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class QualityBenchmark</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_Benchmarks_Quality_QualityBenchmark__ctor_Lucene_Net_Benchmarks_Quality_QualityQuery___Lucene_Net_Benchmarks_Quality_IQualityQueryParser_Lucene_Net_Search_IndexSearcher_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.%23ctor(Lucene.Net.Benchmarks.Quality.QualityQuery%5B%5D%2CLucene.Net.Benchmarks.Quality.IQualityQueryParser%2CLucene.Net.Search.IndexSearcher%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.Benchmark/Quality/QualityBenchmark.cs/#L67">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityBenchmark__ctor_" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark__ctor_Lucene_Net_Benchmarks_Quality_QualityQuery___Lucene_Net_Benchmarks_Quality_IQualityQueryParser_Lucene_Net_Search_IndexSearcher_System_String_" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.#ctor(Lucene.Net.Benchmarks.Quality.QualityQuery[],Lucene.Net.Benchmarks.Quality.IQualityQueryParser,Lucene.Net.Search.IndexSearcher,System.String)">QualityBenchmark(QualityQuery[], IQualityQueryParser, IndexSearcher, String)</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityBenchmark.html">QualityBenchmark</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public QualityBenchmark(QualityQuery[] qqs, IQualityQueryParser qqParser, IndexSearcher searcher, string docNameField)</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.Benchmarks.Quality.QualityQuery.html">QualityQuery</a>[]</td> |
| <td><span class="parametername">qqs</span></td> |
| <td><p>Quality queries to run.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Benchmarks.Quality.IQualityQueryParser.html">IQualityQueryParser</a></td> |
| <td><span class="parametername">qqParser</span></td> |
| <td><p>Parser for turning QualityQueries into Lucene Queries.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td><p>Index to be searched.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">docNameField</span></td> |
| <td><p>Name of field containing the document name. |
| This allows to extract the doc name for search results, |
| and is important for judging the results.</p> |
| </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_Benchmarks_Quality_QualityBenchmark_m_docNameField.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_docNameField%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.Benchmark/Quality/QualityBenchmark.cs/#L48">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_m_docNameField" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_docNameField">m_docNameField</h4> |
| <div class="markdown level1 summary"><p>index field to extract doc name for each search result; used for judging the results.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected string m_docNameField</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.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_Benchmarks_Quality_QualityBenchmark_m_qqParser.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_qqParser%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.Benchmark/Quality/QualityBenchmark.cs/#L42">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_m_qqParser" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_qqParser">m_qqParser</h4> |
| <div class="markdown level1 summary"><p>Parser for turning QualityQueries into Lucene Queries.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected IQualityQueryParser m_qqParser</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><a class="xref" href="Lucene.Net.Benchmarks.Quality.IQualityQueryParser.html">IQualityQueryParser</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_Benchmarks_Quality_QualityBenchmark_m_qualityQueries.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_qualityQueries%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.Benchmark/Quality/QualityBenchmark.cs/#L39">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_m_qualityQueries" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_qualityQueries">m_qualityQueries</h4> |
| <div class="markdown level1 summary"><p>Quality Queries that this quality benchmark would execute.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected QualityQuery[] m_qualityQueries</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><a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityQuery.html">QualityQuery</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_Benchmarks_Quality_QualityBenchmark_m_searcher.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_searcher%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.Benchmark/Quality/QualityBenchmark.cs/#L45">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_m_searcher" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.m_searcher">m_searcher</h4> |
| <div class="markdown level1 summary"><p>Index to be searched.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected IndexSearcher m_searcher</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">Lucene.Net.Search.IndexSearcher</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_Benchmarks_Quality_QualityBenchmark_MaxQueries.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.MaxQueries%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.Benchmark/Quality/QualityBenchmark.cs/#L144">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_MaxQueries_" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.MaxQueries*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_MaxQueries" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.MaxQueries">MaxQueries</h4> |
| <div class="markdown level1 summary"><p>The maximum number of quality queries to run. Useful at debugging.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxQueries { 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.Int32</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_Benchmarks_Quality_QualityBenchmark_MaxResults.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.MaxResults%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.Benchmark/Quality/QualityBenchmark.cs/#L153">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_MaxResults_" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.MaxResults*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_MaxResults" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.MaxResults">MaxResults</h4> |
| <div class="markdown level1 summary"><p>The maximum number of results to collect for each quality query.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxResults { 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.Int32</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_Benchmarks_Quality_QualityBenchmark_Execute_Lucene_Net_Benchmarks_Quality_IJudge_Lucene_Net_Benchmarks_Quality_Utils_SubmissionReport_System_IO_TextWriter_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark.Execute(Lucene.Net.Benchmarks.Quality.IJudge%2CLucene.Net.Benchmarks.Quality.Utils.SubmissionReport%2CSystem.IO.TextWriter)%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.Benchmark/Quality/QualityBenchmark.cs/#L87">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_Execute_" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.Execute*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityBenchmark_Execute_Lucene_Net_Benchmarks_Quality_IJudge_Lucene_Net_Benchmarks_Quality_Utils_SubmissionReport_System_IO_TextWriter_" data-uid="Lucene.Net.Benchmarks.Quality.QualityBenchmark.Execute(Lucene.Net.Benchmarks.Quality.IJudge,Lucene.Net.Benchmarks.Quality.Utils.SubmissionReport,System.IO.TextWriter)">Execute(IJudge, SubmissionReport, TextWriter)</h4> |
| <div class="markdown level1 summary"><p>Run the quality benchmark.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual QualityStats[] Execute(IJudge judge, SubmissionReport submitRep, TextWriter qualityLog)</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.Benchmarks.Quality.IJudge.html">IJudge</a></td> |
| <td><span class="parametername">judge</span></td> |
| <td><p>The judge that can tell if a certain result doc is relevant for a certain quality query. |
| If null, no judgements would be made. Usually null for a submission run.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Benchmarks.Quality.Utils.SubmissionReport.html">SubmissionReport</a></td> |
| <td><span class="parametername">submitRep</span></td> |
| <td><p>Submission report is created if non null.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextWriter</span></td> |
| <td><span class="parametername">qualityLog</span></td> |
| <td><p>If not null, quality run data would be printed for each query.</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><a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.html">QualityStats</a>[]</td> |
| <td><p><a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.html">QualityStats</a> of each quality query that was executed.</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.Exception</span></td> |
| <td><p>If quality benchmark failed to run.</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_Benchmarks_Quality_QualityBenchmark.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityBenchmark%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.Benchmark/Quality/QualityBenchmark.cs/#L36" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
