| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class CustomScoreProvider |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class CustomScoreProvider |
| | 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="queries/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.Queries.CustomScoreProvider"> |
| |
| |
| <h1 id="Lucene_Net_Queries_CustomScoreProvider" data-uid="Lucene.Net.Queries.CustomScoreProvider" class="text-break">Class CustomScoreProvider |
| </h1> |
| <div class="markdown level0 summary"><p>An instance of this subclass should be returned by |
| <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html#Lucene_Net_Queries_CustomScoreQuery_GetCustomScoreProvider_Lucene_Net_Index_AtomicReaderContext_">GetCustomScoreProvider(AtomicReaderContext)</a>, if you want |
| to modify the custom score calculation of a <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html">CustomScoreQuery</a>. |
| <p>Since Lucene 2.9, queries operate on each segment of an index separately, |
| so the protected <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_m_context">m_context</a> field can be used to resolve doc IDs, |
| as the supplied <code>doc</code> ID is per-segment and without knowledge |
| of the <span class="xref">Lucene.Net.Index.IndexReader</span> you cannot access the document or <span class="xref">Lucene.Net.Search.IFieldCache</span>.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p>@since 2.9.2</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">CustomScoreProvider</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.Queries.html">Lucene.Net.Queries</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Queries.dll</h6> |
| <h5 id="Lucene_Net_Queries_CustomScoreProvider_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class CustomScoreProvider</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_Queries_CustomScoreProvider__ctor_Lucene_Net_Index_AtomicReaderContext_.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider.%23ctor(Lucene.Net.Index.AtomicReaderContext)%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.Queries/CustomScoreProvider.cs/#L42">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_CustomScoreProvider__ctor_" data-uid="Lucene.Net.Queries.CustomScoreProvider.#ctor*"></a> |
| <h4 id="Lucene_Net_Queries_CustomScoreProvider__ctor_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Queries.CustomScoreProvider.#ctor(Lucene.Net.Index.AtomicReaderContext)">CustomScoreProvider(AtomicReaderContext)</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance of the provider class for the given <span class="xref">Lucene.Net.Index.IndexReader</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CustomScoreProvider(AtomicReaderContext context)</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.Index.AtomicReaderContext</span></td> |
| <td><span class="parametername">context</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreProvider_m_context.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider.m_context%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.Queries/CustomScoreProvider.cs/#L37">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Queries_CustomScoreProvider_m_context" data-uid="Lucene.Net.Queries.CustomScoreProvider.m_context">m_context</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">protected readonly AtomicReaderContext m_context</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.Index.AtomicReaderContext</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_Queries_CustomScoreProvider_CustomExplain_System_Int32_Lucene_Net_Search_Explanation_Lucene_Net_Search_Explanation_.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider.CustomExplain(System.Int32%2CLucene.Net.Search.Explanation%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.Queries/CustomScoreProvider.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_CustomScoreProvider_CustomExplain_" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomExplain*"></a> |
| <h4 id="Lucene_Net_Queries_CustomScoreProvider_CustomExplain_System_Int32_Lucene_Net_Search_Explanation_Lucene_Net_Search_Explanation_" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomExplain(System.Int32,Lucene.Net.Search.Explanation,Lucene.Net.Search.Explanation)">CustomExplain(Int32, Explanation, Explanation)</h4> |
| <div class="markdown level1 summary"><p>Explain the custom score. |
| Whenever overriding <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_">CustomScore(Int32, Single, Single)</a>, |
| this method should also be overridden to provide the correct explanation |
| for the part of the custom scoring.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Explanation CustomExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl)</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">doc</span></td> |
| <td><p>doc being explained. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Explanation</span></td> |
| <td><span class="parametername">subQueryExpl</span></td> |
| <td><p>explanation for the sub-query part. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Explanation</span></td> |
| <td><span class="parametername">valSrcExpl</span></td> |
| <td><p>explanation for the value source part. </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">Lucene.Net.Search.Explanation</span></td> |
| <td><p>an explanation for the custom score </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreProvider_CustomExplain_System_Int32_Lucene_Net_Search_Explanation_Lucene_Net_Search_Explanation___.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider.CustomExplain(System.Int32%2CLucene.Net.Search.Explanation%2CLucene.Net.Search.Explanation%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.Queries/CustomScoreProvider.cs/#L121">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_CustomScoreProvider_CustomExplain_" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomExplain*"></a> |
| <h4 id="Lucene_Net_Queries_CustomScoreProvider_CustomExplain_System_Int32_Lucene_Net_Search_Explanation_Lucene_Net_Search_Explanation___" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomExplain(System.Int32,Lucene.Net.Search.Explanation,Lucene.Net.Search.Explanation[])">CustomExplain(Int32, Explanation, Explanation[])</h4> |
| <div class="markdown level1 summary"><p>Explain the custom score. |
| Whenever overriding <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single___">CustomScore(Int32, Single, Single[])</a>, |
| this method should also be overridden to provide the correct explanation |
| for the part of the custom scoring.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Explanation CustomExplain(int doc, Explanation subQueryExpl, Explanation[] valSrcExpls)</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">doc</span></td> |
| <td><p>doc being explained. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Explanation</span></td> |
| <td><span class="parametername">subQueryExpl</span></td> |
| <td><p>explanation for the sub-query part. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Explanation</span>[]</td> |
| <td><span class="parametername">valSrcExpls</span></td> |
| <td><p>explanation for the value source part. </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">Lucene.Net.Search.Explanation</span></td> |
| <td><p>an explanation for the custom score </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider.CustomScore(System.Int32%2CSystem.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.Queries/CustomScoreProvider.cs/#L106">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_CustomScoreProvider_CustomScore_" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomScore*"></a> |
| <h4 id="Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomScore(System.Int32,System.Single,System.Single)">CustomScore(Int32, Single, Single)</h4> |
| <div class="markdown level1 summary"><p>Compute a custom score by the <code data-dev-comment-type="paramref" class="paramref">subQueryScore</code> and the <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a> score. |
| <p> |
| Subclasses can override this method to modify the custom score. |
| <p> |
| If your custom scoring is different than the default herein you |
| should override at least one of the two <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_">CustomScore(Int32, Single, Single)</a> methods. |
| If the number of <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a>s is always < 2 it is |
| sufficient to override this <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_">CustomScore(Int32, Single, Single)</a> method, which is simpler. |
| <p> |
| The default computation herein is a multiplication of the two scores:</p> |
| <pre><code> ModifiedScore = subQueryScore * valSrcScore</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual float CustomScore(int doc, float subQueryScore, float valSrcScore)</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">doc</span></td> |
| <td><p>id of scored doc. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">subQueryScore</span></td> |
| <td><p>score of that doc by the subQuery. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">valSrcScore</span></td> |
| <td><p>score of that doc by the <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</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.Single</span></td> |
| <td><p>custom score. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single___.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider.CustomScore(System.Int32%2CSystem.Single%2CSystem.Single%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.Queries/CustomScoreProvider.cs/#L69">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_CustomScoreProvider_CustomScore_" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomScore*"></a> |
| <h4 id="Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single___" data-uid="Lucene.Net.Queries.CustomScoreProvider.CustomScore(System.Int32,System.Single,System.Single[])">CustomScore(Int32, Single, Single[])</h4> |
| <div class="markdown level1 summary"><p>Compute a custom score by the subQuery score and a number of |
| <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a> scores. |
| <p> |
| Subclasses can override this method to modify the custom score.<br><p> |
| If your custom scoring is different than the default herein you |
| should override at least one of the two <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_">CustomScore(Int32, Single, Single)</a> methods. |
| If the number of <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a>s is always < 2 it is |
| sufficient to override the other |
| <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html#Lucene_Net_Queries_CustomScoreProvider_CustomScore_System_Int32_System_Single_System_Single_">CustomScore(Int32, Single, Single)</a> |
| method, which is simpler. |
| <p> |
| The default computation herein is a multiplication of given scores:</p> |
| <pre><code> ModifiedScore = valSrcScore * valSrcScores[0] * valSrcScores[1] * ...</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual float CustomScore(int doc, float subQueryScore, float[] valSrcScores)</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">doc</span></td> |
| <td><p>id of scored doc. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">subQueryScore</span></td> |
| <td><p>score of that doc by the subQuery. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span>[]</td> |
| <td><span class="parametername">valSrcScores</span></td> |
| <td><p>scores of that doc by the <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</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.Single</span></td> |
| <td><p>custom 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_Queries_CustomScoreProvider.md&value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreProvider%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.Queries/CustomScoreProvider.cs/#L35" 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> |
