blob: a604e31f65cebae7750c70a6914731436711ed46 [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>Class CustomScoreQuery
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CustomScoreQuery
| 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.CustomScoreQuery">
<h1 id="Lucene_Net_Queries_CustomScoreQuery" data-uid="Lucene.Net.Queries.CustomScoreQuery" class="text-break">Class CustomScoreQuery
</h1>
<div class="markdown level0 summary"><p>Query that sets document score as a programmatic function of several (sub) scores:
<ul><li>the score of its subQuery (any query)</li><li>(optional) the score of its <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a> (or queries).</li></ul>
Subclasses can modify the computation by overriding <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html#Lucene_Net_Queries_CustomScoreQuery_GetCustomScoreProvider_Lucene_Net_Index_AtomicReaderContext_">GetCustomScoreProvider(AtomicReaderContext)</a>.
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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">Lucene.Net.Search.Query</span></div>
<div class="level2"><span class="xref">CustomScoreQuery</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">Lucene.Net.Search.Query.Boost</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.Query.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</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>
<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_CustomScoreQuery_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CustomScoreQuery : Query</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_CustomScoreQuery__ctor_Lucene_Net_Search_Query_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.%23ctor(Lucene.Net.Search.Query)%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/CustomScoreQuery.cs/#L65">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery__ctor_" data-uid="Lucene.Net.Queries.CustomScoreQuery.#ctor*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery__ctor_Lucene_Net_Search_Query_" data-uid="Lucene.Net.Queries.CustomScoreQuery.#ctor(Lucene.Net.Search.Query)">CustomScoreQuery(Query)</h4>
<div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html">CustomScoreQuery</a> over input <code data-dev-comment-type="paramref" class="paramref">subQuery</code>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CustomScoreQuery(Query subQuery)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Query</span></td>
<td><span class="parametername">subQuery</span></td>
<td><p>the sub query whose scored is being customized. Must not be <code>null</code>. </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_CustomScoreQuery__ctor_Lucene_Net_Search_Query_Lucene_Net_Queries_Function_FunctionQuery_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.%23ctor(Lucene.Net.Search.Query%2CLucene.Net.Queries.Function.FunctionQuery)%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/CustomScoreQuery.cs/#L75">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery__ctor_" data-uid="Lucene.Net.Queries.CustomScoreQuery.#ctor*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery__ctor_Lucene_Net_Search_Query_Lucene_Net_Queries_Function_FunctionQuery_" data-uid="Lucene.Net.Queries.CustomScoreQuery.#ctor(Lucene.Net.Search.Query,Lucene.Net.Queries.Function.FunctionQuery)">CustomScoreQuery(Query, FunctionQuery)</h4>
<div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html">CustomScoreQuery</a> over input <code data-dev-comment-type="paramref" class="paramref">subQuery</code> and a <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CustomScoreQuery(Query subQuery, FunctionQuery scoringQuery)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Query</span></td>
<td><span class="parametername">subQuery</span></td>
<td><p>the sub query whose score is being customized. Must not be <code>null</code>. </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a></td>
<td><span class="parametername">scoringQuery</span></td>
<td><p>a value source query whose scores are used in the custom score
computation. This parameter is optional - it can be null. </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_CustomScoreQuery__ctor_Lucene_Net_Search_Query_Lucene_Net_Queries_Function_FunctionQuery___.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.%23ctor(Lucene.Net.Search.Query%2CLucene.Net.Queries.Function.FunctionQuery%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/CustomScoreQuery.cs/#L86">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery__ctor_" data-uid="Lucene.Net.Queries.CustomScoreQuery.#ctor*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery__ctor_Lucene_Net_Search_Query_Lucene_Net_Queries_Function_FunctionQuery___" data-uid="Lucene.Net.Queries.CustomScoreQuery.#ctor(Lucene.Net.Search.Query,Lucene.Net.Queries.Function.FunctionQuery[])">CustomScoreQuery(Query, FunctionQuery[])</h4>
<div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html">CustomScoreQuery</a> over input <code data-dev-comment-type="paramref" class="paramref">subQuery</code> and a <a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CustomScoreQuery(Query subQuery, params FunctionQuery[] scoringQueries)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Query</span></td>
<td><span class="parametername">subQuery</span></td>
<td><p>the sub query whose score is being customized. Must not be <code>null</code>. </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a>[]</td>
<td><span class="parametername">scoringQueries</span></td>
<td><p>value source queries whose scores are used in the custom score
computation. This parameter is optional - it can be null or even an empty array. </p>
</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_Queries_CustomScoreQuery_IsStrict.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.IsStrict%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/CustomScoreQuery.cs/#L427">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_IsStrict_" data-uid="Lucene.Net.Queries.CustomScoreQuery.IsStrict*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_IsStrict" data-uid="Lucene.Net.Queries.CustomScoreQuery.IsStrict">IsStrict</h4>
<div class="markdown level1 summary"><p>Checks if this is strict custom scoring.
In strict custom scoring, the <a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html">ValueSource</a> part does not participate in weight normalization.
This may be useful when one wants full control over how scores are modified, and does
not care about normalizing by the <a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html">ValueSource</a> part.
One particular case where this is useful if for testing this query.<br><p>
Note: only has effect when the <a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html">ValueSource</a> part is not <code>null</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 bool IsStrict { 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.Boolean</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_Queries_CustomScoreQuery_Name.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.Name%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/CustomScoreQuery.cs/#L447">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_Name_" data-uid="Lucene.Net.Queries.CustomScoreQuery.Name*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_Name" data-uid="Lucene.Net.Queries.CustomScoreQuery.Name">Name</h4>
<div class="markdown level1 summary"><p>A short name of this query, used in <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html#Lucene_Net_Queries_CustomScoreQuery_ToString_System_String_">ToString(String)</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual string Name { 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.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_Queries_CustomScoreQuery_ScoringQueries.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.ScoringQueries%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/CustomScoreQuery.cs/#L440">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_ScoringQueries_" data-uid="Lucene.Net.Queries.CustomScoreQuery.ScoringQueries*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_ScoringQueries" data-uid="Lucene.Net.Queries.CustomScoreQuery.ScoringQueries">ScoringQueries</h4>
<div class="markdown level1 summary"><p>The scoring queries that only affect the score of <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html">CustomScoreQuery</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Query[] ScoringQueries { 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">Lucene.Net.Search.Query</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_Queries_CustomScoreQuery_SubQuery.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.SubQuery%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/CustomScoreQuery.cs/#L436">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_SubQuery_" data-uid="Lucene.Net.Queries.CustomScoreQuery.SubQuery*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_SubQuery" data-uid="Lucene.Net.Queries.CustomScoreQuery.SubQuery">SubQuery</h4>
<div class="markdown level1 summary"><p>The sub-query that <a class="xref" href="Lucene.Net.Queries.CustomScoreQuery.html">CustomScoreQuery</a> wraps, affecting both the score and which documents match. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Query SubQuery { 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">Lucene.Net.Search.Query</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_CustomScoreQuery_Clone.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.Clone%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/CustomScoreQuery.cs/#L141">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_Clone_" data-uid="Lucene.Net.Queries.CustomScoreQuery.Clone*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_Clone" data-uid="Lucene.Net.Queries.CustomScoreQuery.Clone">Clone()</h4>
<div class="markdown level1 summary"><span class="xref">Lucene.Net.Search.Query.Clone()</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override object Clone()</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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Query.Clone()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreQuery_CreateWeight_Lucene_Net_Search_IndexSearcher_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.CreateWeight(Lucene.Net.Search.IndexSearcher)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Queries/CustomScoreQuery.cs/#L413">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_CreateWeight_" data-uid="Lucene.Net.Queries.CustomScoreQuery.CreateWeight*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_CreateWeight_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Queries.CustomScoreQuery.CreateWeight(Lucene.Net.Search.IndexSearcher)">CreateWeight(IndexSearcher)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Weight CreateWeight(IndexSearcher searcher)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td>
<td><span class="parametername">searcher</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Weight</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Query.CreateWeight(Lucene.Net.Search.IndexSearcher)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreQuery_Equals_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.Equals(System.Object)%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/CustomScoreQuery.cs/#L171">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_Equals_" data-uid="Lucene.Net.Queries.CustomScoreQuery.Equals*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_Equals_System_Object_" data-uid="Lucene.Net.Queries.CustomScoreQuery.Equals(System.Object)">Equals(Object)</h4>
<div class="markdown level1 summary"><p>Returns true if <code data-dev-comment-type="paramref" class="paramref">o</code> is equal to this. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object o)</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.Object</span></td>
<td><span class="parametername">o</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_Equals_System_Object_">Query.Equals(Object)</a></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreQuery_ExtractTerms_System_Collections_Generic_ISet_Lucene_Net_Index_Term__.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.ExtractTerms(System.Collections.Generic.ISet%7BLucene.Net.Index.Term%7D)%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/CustomScoreQuery.cs/#L129">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_ExtractTerms_" data-uid="Lucene.Net.Queries.CustomScoreQuery.ExtractTerms*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_ExtractTerms_System_Collections_Generic_ISet_Lucene_Net_Index_Term__" data-uid="Lucene.Net.Queries.CustomScoreQuery.ExtractTerms(System.Collections.Generic.ISet{Lucene.Net.Index.Term})">ExtractTerms(ISet&lt;Term&gt;)</h4>
<div class="markdown level1 summary"><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_ExtractTerms_System_Collections_Generic_ISet_Lucene_Net_Index_Term__">ExtractTerms(ISet&lt;Term&gt;)</a>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void ExtractTerms(ISet&lt;Term&gt; terms)</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.Collections.Generic.ISet</span>&lt;<span class="xref">Lucene.Net.Index.Term</span>&gt;</td>
<td><span class="parametername">terms</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_ExtractTerms_System_Collections_Generic_ISet_Lucene_Net_Index_Term__">Query.ExtractTerms(ISet&lt;Term&gt;)</a></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreQuery_GetCustomScoreProvider_Lucene_Net_Index_AtomicReaderContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.GetCustomScoreProvider(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/CustomScoreQuery.cs/#L208">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_GetCustomScoreProvider_" data-uid="Lucene.Net.Queries.CustomScoreQuery.GetCustomScoreProvider*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_GetCustomScoreProvider_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Queries.CustomScoreQuery.GetCustomScoreProvider(Lucene.Net.Index.AtomicReaderContext)">GetCustomScoreProvider(AtomicReaderContext)</h4>
<div class="markdown level1 summary"><p>Returns a <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html">CustomScoreProvider</a> that calculates the custom scores
for the given <span class="xref">Lucene.Net.Index.IndexReader</span>. The default implementation returns a default
implementation as specified in the docs of <a class="xref" href="Lucene.Net.Queries.CustomScoreProvider.html">CustomScoreProvider</a>.
@since 2.9.2</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual CustomScoreProvider GetCustomScoreProvider(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>
<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.Queries.CustomScoreProvider.html">CustomScoreProvider</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_Queries_CustomScoreQuery_GetHashCode.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.GetHashCode%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/CustomScoreQuery.cs/#L196">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_GetHashCode_" data-uid="Lucene.Net.Queries.CustomScoreQuery.GetHashCode*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_GetHashCode" data-uid="Lucene.Net.Queries.CustomScoreQuery.GetHashCode">GetHashCode()</h4>
<div class="markdown level1 summary"><p>Returns a hash code value for this object. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Query.GetHashCode()</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreQuery_Rewrite_Lucene_Net_Index_IndexReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.Rewrite(Lucene.Net.Index.IndexReader)%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/CustomScoreQuery.cs/#L99">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_Rewrite_" data-uid="Lucene.Net.Queries.CustomScoreQuery.Rewrite*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_Rewrite_Lucene_Net_Index_IndexReader_" data-uid="Lucene.Net.Queries.CustomScoreQuery.Rewrite(Lucene.Net.Index.IndexReader)">Rewrite(IndexReader)</h4>
<div class="markdown level1 summary"><span class="xref">Lucene.Net.Search.Query.Rewrite(Lucene.Net.Index.IndexReader)</span>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Query Rewrite(IndexReader reader)</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.IndexReader</span></td>
<td><span class="parametername">reader</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Query</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.Query.Rewrite(Lucene.Net.Index.IndexReader)</span></div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_CustomScoreQuery_ToString_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery.ToString(System.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.Queries/CustomScoreQuery.cs/#L156">View Source</a>
</span>
<a id="Lucene_Net_Queries_CustomScoreQuery_ToString_" data-uid="Lucene.Net.Queries.CustomScoreQuery.ToString*"></a>
<h4 id="Lucene_Net_Queries_CustomScoreQuery_ToString_System_String_" data-uid="Lucene.Net.Queries.CustomScoreQuery.ToString(System.String)">ToString(String)</h4>
<div class="markdown level1 summary"><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_ToString_System_String_">ToString(String)</a>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString(string field)</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">field</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_ToString_System_String_">Query.ToString(String)</a></div>
</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_CustomScoreQuery.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.CustomScoreQuery%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/CustomScoreQuery.cs/#L40" 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>