blob: 89add0bbb856abb6e0f4fadd275e7fde3cede544 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IJudge
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IJudge
| 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.IJudge">
<h1 id="Lucene_Net_Benchmarks_Quality_IJudge" data-uid="Lucene.Net.Benchmarks.Quality.IJudge" class="text-break">Interface IJudge
</h1>
<div class="markdown level0 summary"><p>Judge if a document is relevant for a quality query.</p>
</div>
<div class="markdown level0 conceptual"></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_IJudge_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IJudge</code></pre>
</div>
<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_IJudge_IsRelevant_System_String_Lucene_Net_Benchmarks_Quality_QualityQuery_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.IJudge.IsRelevant(System.String%2CLucene.Net.Benchmarks.Quality.QualityQuery)%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/Judge.cs/#L33">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_Quality_IJudge_IsRelevant_" data-uid="Lucene.Net.Benchmarks.Quality.IJudge.IsRelevant*"></a>
<h4 id="Lucene_Net_Benchmarks_Quality_IJudge_IsRelevant_System_String_Lucene_Net_Benchmarks_Quality_QualityQuery_" data-uid="Lucene.Net.Benchmarks.Quality.IJudge.IsRelevant(System.String,Lucene.Net.Benchmarks.Quality.QualityQuery)">IsRelevant(String, QualityQuery)</h4>
<div class="markdown level1 summary"><p>Judge if document <code data-dev-comment-type="paramref" class="paramref">docName</code> is relevant for the given quality query.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool IsRelevant(string docName, QualityQuery query)</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">docName</span></td>
<td><p>Name of doc tested for relevancy.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Benchmarks.Quality.QualityQuery.html">QualityQuery</a></td>
<td><span class="parametername">query</span></td>
<td><p>Tested quality 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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if relevant, <code>false</code> if not.</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_IJudge_MaxRecall_Lucene_Net_Benchmarks_Quality_QualityQuery_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.IJudge.MaxRecall(Lucene.Net.Benchmarks.Quality.QualityQuery)%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/Judge.cs/#L53">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_Quality_IJudge_MaxRecall_" data-uid="Lucene.Net.Benchmarks.Quality.IJudge.MaxRecall*"></a>
<h4 id="Lucene_Net_Benchmarks_Quality_IJudge_MaxRecall_Lucene_Net_Benchmarks_Quality_QualityQuery_" data-uid="Lucene.Net.Benchmarks.Quality.IJudge.MaxRecall(Lucene.Net.Benchmarks.Quality.QualityQuery)">MaxRecall(QualityQuery)</h4>
<div class="markdown level1 summary"><p>Return the maximal recall for the input quality query.
It is the number of relevant docs this <a class="xref" href="Lucene.Net.Benchmarks.Quality.IJudge.html">IJudge</a> &quot;knows&quot; for the query.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int MaxRecall(QualityQuery query)</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">query</span></td>
<td><p>The query whose maximal recall is needed.</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.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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_Quality_IJudge_ValidateData_Lucene_Net_Benchmarks_Quality_QualityQuery___System_IO_TextWriter_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.IJudge.ValidateData(Lucene.Net.Benchmarks.Quality.QualityQuery%5B%5D%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/fix/apidocs-layout/src/Lucene.Net.Benchmark/Quality/Judge.cs/#L45">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_Quality_IJudge_ValidateData_" data-uid="Lucene.Net.Benchmarks.Quality.IJudge.ValidateData*"></a>
<h4 id="Lucene_Net_Benchmarks_Quality_IJudge_ValidateData_Lucene_Net_Benchmarks_Quality_QualityQuery___System_IO_TextWriter_" data-uid="Lucene.Net.Benchmarks.Quality.IJudge.ValidateData(Lucene.Net.Benchmarks.Quality.QualityQuery[],System.IO.TextWriter)">ValidateData(QualityQuery[], TextWriter)</h4>
<div class="markdown level1 summary"><p>Validate that queries and this <a class="xref" href="Lucene.Net.Benchmarks.Quality.IJudge.html">IJudge</a> match each other.
To be perfectly valid, this Judge must have some data for each and every
input quality query, and must not have any data on any other quality query.
<strong>Note</strong>: the quality benchmark run would not fail in case of imperfect
validity, just a warning message would be logged. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool ValidateData(QualityQuery[] qq, TextWriter logger)</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">qq</span></td>
<td><p>Quality queries to be validated.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.TextWriter</span></td>
<td><span class="parametername">logger</span></td>
<td><p>If not <code>null</code>, validation issues are logged.</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.Boolean</span></td>
<td><p><code>true</code> if perfectly valid, <code>false</code> if not.</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_IJudge.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.Quality.IJudge%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/Judge.cs/#L25" 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>