blob: 2b6b9ca0ad593684afc2c50738b31740824c1905 [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 ReciprocalSingleFunction
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ReciprocalSingleFunction
| 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.Function.ValueSources.ReciprocalSingleFunction">
<h1 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction" class="text-break">Class ReciprocalSingleFunction
</h1>
<div class="markdown level0 summary"><p><a class="xref" href="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.html">ReciprocalSingleFunction</a> implements a reciprocal function <code>f(x) = a/(mx+b)</code>, based on
the <span class="xref">System.Single</span> value of a field or function as exported by <a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html">ValueSource</a>.
<p>
When a and b are equal, and <code>x&gt;=0</code>, this function has a maximum value of 1 that drops as x increases.
Increasing the value of a and b together results in a movement of the entire function to a flatter part of the curve.
<p>These properties make this an idea function for boosting more recent documents.
<p>Example:<code> recip(ms(NOW,mydatefield),3.16e-11,1,1)</code>
<p>A multiplier of 3.16e-11 changes the units from milliseconds to years (since there are about 3.16e10 milliseconds
per year). Thus, a very recent date will yield a value close to 1/(0+1) or 1,
a date a year in the past will get a multiplier of about 1/(1+1) or 1/2,
and date two years old will yield 1/(2+1) or 1/3.
<p>
NOTE: This was ReciprocalFloatFunction in Lucene</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"><a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html">ValueSource</a></div>
<div class="level2"><span class="xref">ReciprocalSingleFunction</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_ToString">ValueSource.ToString()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_NewContext_Lucene_Net_Search_IndexSearcher_">ValueSource.NewContext(IndexSearcher)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_GetSortField_System_Boolean_">ValueSource.GetSortField(Boolean)</a>
</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.Function.ValueSources.html">Lucene.Net.Queries.Function.ValueSources</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Queries.dll</h6>
<h5 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ReciprocalSingleFunction : ValueSource</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_Function_ValueSources_ReciprocalSingleFunction__ctor_Lucene_Net_Queries_Function_ValueSource_System_Single_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.%23ctor(Lucene.Net.Queries.Function.ValueSource%2CSystem.Single%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L53">View Source</a>
</span>
<a id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction__ctor_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.#ctor*"></a>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction__ctor_Lucene_Net_Queries_Function_ValueSource_System_Single_System_Single_System_Single_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.#ctor(Lucene.Net.Queries.Function.ValueSource,System.Single,System.Single,System.Single)">ReciprocalSingleFunction(ValueSource, Single, Single, Single)</h4>
<div class="markdown level1 summary"><p>f(source) = a/(m*float(source)+b)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ReciprocalSingleFunction(ValueSource source, float m, float a, float b)</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.Queries.Function.ValueSource.html">ValueSource</a></td>
<td><span class="parametername">source</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">m</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">a</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">b</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_Function_ValueSources_ReciprocalSingleFunction_m_a.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_a%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L47">View Source</a>
</span>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_m_a" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_a">m_a</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 float m_a</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.Single</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_Function_ValueSources_ReciprocalSingleFunction_m_b.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_b%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L48">View Source</a>
</span>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_m_b" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_b">m_b</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 float m_b</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.Single</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_Function_ValueSources_ReciprocalSingleFunction_m_m.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_m%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L46">View Source</a>
</span>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_m_m" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_m">m_m</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 float m_m</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.Single</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_Function_ValueSources_ReciprocalSingleFunction_m_source.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_source%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L45">View Source</a>
</span>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_m_source" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.m_source">m_source</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 ValueSource m_source</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html">ValueSource</a></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_Function_ValueSources_ReciprocalSingleFunction_CreateWeight_System_Collections_IDictionary_Lucene_Net_Search_IndexSearcher_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.CreateWeight(System.Collections.IDictionary%2CLucene.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/Function/ValueSources/ReciprocalFloatFunction.cs/#L98">View Source</a>
</span>
<a id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_CreateWeight_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.CreateWeight*"></a>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_CreateWeight_System_Collections_IDictionary_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.CreateWeight(System.Collections.IDictionary,Lucene.Net.Search.IndexSearcher)">CreateWeight(IDictionary, 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 void CreateWeight(IDictionary context, 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">System.Collections.IDictionary</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
<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="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_CreateWeight_System_Collections_IDictionary_Lucene_Net_Search_IndexSearcher_">ValueSource.CreateWeight(IDictionary, IndexSearcher)</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_Function_ValueSources_ReciprocalSingleFunction_Equals_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.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/Function/ValueSources/ReciprocalFloatFunction.cs/#L117">View Source</a>
</span>
<a id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_Equals_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.Equals*"></a>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_Equals_System_Object_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.Equals(System.Object)">Equals(Object)</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 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="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_Equals_System_Object_">ValueSource.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_Function_ValueSources_ReciprocalSingleFunction_GetDescription.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetDescription%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L103">View Source</a>
</span>
<a id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_GetDescription_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetDescription*"></a>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_GetDescription" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetDescription">GetDescription()</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 string GetDescription()</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_GetDescription">ValueSource.GetDescription()</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_Function_ValueSources_ReciprocalSingleFunction_GetHashCode.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.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/Function/ValueSources/ReciprocalFloatFunction.cs/#L110">View Source</a>
</span>
<a id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_GetHashCode_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetHashCode*"></a>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_GetHashCode" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetHashCode">GetHashCode()</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 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><a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_GetHashCode">ValueSource.GetHashCode()</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_Function_ValueSources_ReciprocalSingleFunction_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetValues(System.Collections.IDictionary%2CLucene.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/Function/ValueSources/ReciprocalFloatFunction.cs/#L61">View Source</a>
</span>
<a id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_GetValues_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetValues*"></a>
<h4 id="Lucene_Net_Queries_Function_ValueSources_ReciprocalSingleFunction_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction.GetValues(System.Collections.IDictionary,Lucene.Net.Index.AtomicReaderContext)">GetValues(IDictionary, AtomicReaderContext)</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 FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext)</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.IDictionary</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Index.AtomicReaderContext</span></td>
<td><span class="parametername">readerContext</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.Function.FunctionValues.html">FunctionValues</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Queries.Function.ValueSource.html#Lucene_Net_Queries_Function_ValueSource_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_">ValueSource.GetValues(IDictionary, AtomicReaderContext)</a></div>
<h3 id="seealso">See Also</h3>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Queries.Function.FunctionQuery.html">FunctionQuery</a></div>
</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_Function_ValueSources_ReciprocalSingleFunction.md&amp;value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.ReciprocalSingleFunction%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/Function/ValueSources/ReciprocalFloatFunction.cs/#L43" 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>