| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class QualityStats |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class QualityStats |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.QualityStats"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_Quality_QualityStats" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats" class="text-break">Class QualityStats |
| </h1> |
| <div class="markdown level0 summary"><p>Results of quality benchmark run for a single query or for a set of queries.</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">QualityStats</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_QualityStats_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class QualityStats</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats__ctor_System_Double_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.%23ctor(System.Double%2CSystem.Int64)%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L73">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats__ctor_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats__ctor_System_Double_System_Int64_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.#ctor(System.Double,System.Int64)">QualityStats(Double, Int64)</h4> |
| <div class="markdown level1 summary"><p>Construct a QualityStats object with anticipated maximal number of relevant hits. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public QualityStats(double maxGoodPoints, long searchTime)</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.Double</span></td> |
| <td><span class="parametername">maxGoodPoints</span></td> |
| <td><p>maximal possible relevant hits.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">searchTime</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_MAX_POINTS.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.MAX_POINTS%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L34">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_MAX_POINTS" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.MAX_POINTS">MAX_POINTS</h4> |
| <div class="markdown level1 summary"><p>Number of points for which precision is computed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly int MAX_POINTS</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.Int32</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_DocNamesExtractTime.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.DocNamesExtractTime%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L267">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_DocNamesExtractTime_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.DocNamesExtractTime*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_DocNamesExtractTime" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.DocNamesExtractTime">DocNamesExtractTime</h4> |
| <div class="markdown level1 summary"><p>Returns the time it took to extract doc names for judging the measured query, in milliseconds.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual long DocNamesExtractTime { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int64</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_MaxGoodPoints.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.MaxGoodPoints%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L273">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_MaxGoodPoints_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.MaxGoodPoints*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_MaxGoodPoints" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.MaxGoodPoints">MaxGoodPoints</h4> |
| <div class="markdown level1 summary"><p>Returns the maximal number of good points. |
| This is the number of relevant docs known by the judge for the measured 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 double MaxGoodPoints { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_MRR.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.MRR%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L305">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_MRR_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.MRR*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_MRR" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.MRR">MRR</h4> |
| <div class="markdown level1 summary"><p>Returns the Mean reciprocal rank over the queries or RR for a single 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 double MRR { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Benchmarks_Quality_QualityStats_MRR_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Reciprocal rank is defined as <code>1/r</code> where <code>r</code> is the |
| rank of the first correct result, or <code>0</code> if there are no correct |
| results within the top 5 results. |
| <p> |
| This follows the definition in |
| <a href="http://www.cnlp.org/publications/02cnlptrec10.pdf"> |
| Question Answering - CNLP at the TREC-10 Question Answering Track</a>.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_NumGoodPoints.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.NumGoodPoints%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L278">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_NumGoodPoints_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.NumGoodPoints*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_NumGoodPoints" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.NumGoodPoints">NumGoodPoints</h4> |
| <div class="markdown level1 summary"><p>Returns the number of good points (only relevant points).</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 NumGoodPoints { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_NumPoints.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.NumPoints%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L283">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_NumPoints_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.NumPoints*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_NumPoints" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.NumPoints">NumPoints</h4> |
| <div class="markdown level1 summary"><p>Returns the number of points (both relevant and irrelevant points).</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 NumPoints { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_Recall.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.Recall%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L146">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_Recall_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.Recall*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_Recall" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.Recall">Recall</h4> |
| <div class="markdown level1 summary"><p>Return the recall: |{relevant hits found}| / |{relevant hits existing}|.</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 Recall { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_SearchTime.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.SearchTime%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L311">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_SearchTime_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.SearchTime*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_SearchTime" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.SearchTime">SearchTime</h4> |
| <div class="markdown level1 summary"><p>Returns the search time in milliseconds for the measured 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 long SearchTime { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int64</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_AddResult_System_Int32_System_Boolean_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.AddResult(System.Int32%2CSystem.Boolean%2CSystem.Int64)%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L87">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_AddResult_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.AddResult*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_AddResult_System_Int32_System_Boolean_System_Int64_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.AddResult(System.Int32,System.Boolean,System.Int64)">AddResult(Int32, Boolean, Int64)</h4> |
| <div class="markdown level1 summary"><p>Add a (possibly relevant) doc.</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 AddResult(int n, bool isRelevant, long docNameExtractTime)</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.Int32</span></td> |
| <td><span class="parametername">n</span></td> |
| <td><p>rank of the added doc (its ordinal position within the query results).</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">isRelevant</span></td> |
| <td><p><code>true</code> if the added doc is relevant, <code>false</code> otherwise.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">docNameExtractTime</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_Average_Lucene_Net_Benchmarks_Quality_QualityStats___.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.Average(Lucene.Net.Benchmarks.Quality.QualityStats%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L216">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_Average_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.Average*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_Average_Lucene_Net_Benchmarks_Quality_QualityStats___" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.Average(Lucene.Net.Benchmarks.Quality.QualityStats[])">Average(QualityStats[])</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.html">QualityStats</a> object that is the average of the input <a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.html">QualityStats</a> objects. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static QualityStats Average(QualityStats[] stats)</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.QualityStats.html">QualityStats</a>[]</td> |
| <td><span class="parametername">stats</span></td> |
| <td><p>array of input stats to be averaged.</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>an average over the input stats.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_GetAvp.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.GetAvp%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L138">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_GetAvp_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.GetAvp*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_GetAvp" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.GetAvp">GetAvp()</h4> |
| <div class="markdown level1 summary"><p>Return the average precision at recall points.</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 GetAvp()</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.Double</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_GetPrecisionAt_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.GetPrecisionAt(System.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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L122">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_GetPrecisionAt_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.GetPrecisionAt*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_GetPrecisionAt_System_Int32_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.GetPrecisionAt(System.Int32)">GetPrecisionAt(Int32)</h4> |
| <div class="markdown level1 summary"><p>Return the precision at rank n: |
| |{relevant hits within first <code>n</code> hits}| / <code>n</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 GetPrecisionAt(int n)</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.Int32</span></td> |
| <td><span class="parametername">n</span></td> |
| <td><p>requested precision point, must be at least 1 and at most <a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.html#Lucene_Net_Benchmarks_Quality_QualityStats_MAX_POINTS">MAX_POINTS</a>.</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></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_GetRecallPoints.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.GetRecallPoints%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L288">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_GetRecallPoints_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.GetRecallPoints*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_GetRecallPoints" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.GetRecallPoints">GetRecallPoints()</h4> |
| <div class="markdown level1 summary"><p>Returns the recallPoints.</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.RecallPoint[] GetRecallPoints()</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><a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.RecallPoint.html">QualityStats.RecallPoint</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats_Log_System_String_System_Int32_System_IO_TextWriter_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats.Log(System.String%2CSystem.Int32%2CSystem.IO.TextWriter%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_Quality_QualityStats_Log_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.Log*"></a> |
| <h4 id="Lucene_Net_Benchmarks_Quality_QualityStats_Log_System_String_System_Int32_System_IO_TextWriter_System_String_" data-uid="Lucene.Net.Benchmarks.Quality.QualityStats.Log(System.String,System.Int32,System.IO.TextWriter,System.String)">Log(String, Int32, TextWriter, String)</h4> |
| <div class="markdown level1 summary"><p>Log information on this <a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityStats.html">QualityStats</a> object.</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 Log(string title, int paddLines, TextWriter logger, string prefix)</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">title</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">paddLines</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextWriter</span></td> |
| <td><span class="parametername">logger</span></td> |
| <td><p>Logger.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">prefix</span></td> |
| <td><p>prefix before each log line.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_QualityStats.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.QualityStats%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/QualityStats.cs/#L31" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |
