| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SweetSpotSimilarity |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SweetSpotSimilarity |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="misc/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Misc.SweetSpotSimilarity"> |
| |
| |
| <h1 id="Lucene_Net_Misc_SweetSpotSimilarity" data-uid="Lucene.Net.Misc.SweetSpotSimilarity" class="text-break">Class SweetSpotSimilarity |
| </h1> |
| <div class="markdown level0 summary"><p> |
| A similarity with a lengthNorm that provides for a "plateau" of |
| equally good lengths, and tf helper functions. |
| </p> |
| <p> |
| For lengthNorm, A min/max can be specified to define the |
| plateau of lengths that should all have a norm of 1.0. |
| Below the min, and above the max the lengthNorm drops off in a |
| sqrt function. |
| </p> |
| <p> |
| For tf, baselineTf and hyperbolicTf functions are provided, which |
| subclasses can choose between. |
| </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">Lucene.Net.Search.Similarities.Similarity</span></div> |
| <div class="level2"><span class="xref">Lucene.Net.Search.Similarities.TFIDFSimilarity</span></div> |
| <div class="level3"><span class="xref">Lucene.Net.Search.Similarities.DefaultSimilarity</span></div> |
| <div class="level4"><span class="xref">SweetSpotSimilarity</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_Coord_System_Int32_System_Int32_">DefaultSimilarity.Coord(Int32, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_QueryNorm_System_Single_">DefaultSimilarity.QueryNorm(Single)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_EncodeNormValue_System_Single_">DefaultSimilarity.EncodeNormValue(Single)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_DecodeNormValue_System_Int64_">DefaultSimilarity.DecodeNormValue(Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_SloppyFreq_System_Int32_">DefaultSimilarity.SloppyFreq(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_ScorePayload_System_Int32_System_Int32_System_Int32_Lucene_Net_Util_BytesRef_">DefaultSimilarity.ScorePayload(Int32, Int32, Int32, BytesRef)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_Idf_System_Int64_System_Int64_">DefaultSimilarity.Idf(Int64, Int64)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.DefaultSimilarity.m_discountOverlaps</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.DefaultSimilarity.DiscountOverlaps</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.DefaultSimilarity.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.TFIDFSimilarity.IdfExplain(Lucene.Net.Search.CollectionStatistics, Lucene.Net.Search.TermStatistics)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.TFIDFSimilarity.IdfExplain(Lucene.Net.Search.CollectionStatistics, Lucene.Net.Search.TermStatistics[])</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.TFIDFSimilarity.ComputeNorm(Lucene.Net.Index.FieldInvertState)</span> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.TFIDFSimilarity.html#Lucene_Net_Search_Similarities_TFIDFSimilarity_ComputeWeight_System_Single_Lucene_Net_Search_CollectionStatistics_Lucene_Net_Search_TermStatistics___">TFIDFSimilarity.ComputeWeight(Single, CollectionStatistics, TermStatistics[])</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Search.Similarities.TFIDFSimilarity.GetSimScorer(Lucene.Net.Search.Similarities.Similarity.SimWeight, Lucene.Net.Index.AtomicReaderContext)</span> |
| </div> |
| <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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Misc.html">Lucene.Net.Misc</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Misc.dll</h6> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SweetSpotSimilarity : DefaultSimilarity</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity__ctor.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L55">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity__ctor_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.#ctor*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity__ctor" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.#ctor">SweetSpotSimilarity()</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 SweetSpotSimilarity()</code></pre> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_BaselineTf_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.BaselineTf(System.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/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L172">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_BaselineTf_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.BaselineTf*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_BaselineTf_System_Single_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.BaselineTf(System.Single)">BaselineTf(Single)</h4> |
| <div class="markdown level1 summary"><p>Implemented as:</p> |
| <pre><code> (x <= min) ? base : Math.Sqrt(x+(base**2)-min)</code></pre> |
| <p>...but with a special case check for 0. |
| <p> |
| This degrates to <pre><code>Math.Sqrt(x)</code></pre> when min and base are both 0 |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual float BaselineTf(float freq)</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.Single</span></td> |
| <td><span class="parametername">freq</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.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_BaselineTf_System_Single__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_SetBaselineTfFactors_System_Single_System_Single_">SetBaselineTfFactors(Single, Single)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_ComputeLengthNorm_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.ComputeLengthNorm(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L142">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_ComputeLengthNorm_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.ComputeLengthNorm*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_ComputeLengthNorm_System_Int32_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.ComputeLengthNorm(System.Int32)">ComputeLengthNorm(Int32)</h4> |
| <div class="markdown level1 summary"><p>Implemented as:</p> |
| <pre><code>1/sqrt( steepness * (Math.Abs(x-min) + Math.Abs(x-max) - (max-min)) + 1 )</code></pre>. |
| |
| <p> |
| This degrades to <pre><code>1/Math.Sqrt(x)</code></pre> when min and max are both 1 and |
| steepness is 0.5 |
| </p> |
| |
| <p> |
| :TODO: potential optimization is to just flat out return 1.0f if numTerms |
| is between min and max. |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual float ComputeLengthNorm(int numTerms)</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">numTerms</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.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_ComputeLengthNorm_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_SetLengthNormFactors_System_Int32_System_Int32_System_Single_System_Boolean_">SetLengthNormFactors(Int32, Int32, Single, Boolean)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_HyperbolicTf_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.HyperbolicTf(System.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/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L196">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_HyperbolicTf_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.HyperbolicTf*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_HyperbolicTf_System_Single_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.HyperbolicTf(System.Single)">HyperbolicTf(Single)</h4> |
| <div class="markdown level1 summary"><p>Uses a hyperbolic tangent function that allows for a hard max...</p> |
| <pre><code>tf(x)=min+(max-min)/2*(((base**(x-xoffset)-base**-(x-xoffset))/(base**(x-xoffset)+base**-(x-xoffset)))+1)</code></pre> |
| |
| <p> |
| This code is provided as a convenience for subclasses that want |
| to use a hyperbolic tf function. |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual float HyperbolicTf(float freq)</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.Single</span></td> |
| <td><span class="parametername">freq</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.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_HyperbolicTf_System_Single__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_SetHyperbolicTfFactors_System_Single_System_Single_System_Double_System_Single_">SetHyperbolicTfFactors(Single, Single, Double, Single)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_LengthNorm_Lucene_Net_Index_FieldInvertState_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.LengthNorm(Lucene.Net.Index.FieldInvertState)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L108">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_LengthNorm_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.LengthNorm*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_LengthNorm_Lucene_Net_Index_FieldInvertState_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.LengthNorm(Lucene.Net.Index.FieldInvertState)">LengthNorm(FieldInvertState)</h4> |
| <div class="markdown level1 summary"><p>Implemented as |
| <code>state.Boost * ComputeLengthNorm(numTokens) </code> |
| where numTokens does not count overlap tokens if |
| discountOverlaps is true by default or true for this |
| specific field. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override float LengthNorm(FieldInvertState state)</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.FieldInvertState</span></td> |
| <td><span class="parametername">state</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.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.Similarities.DefaultSimilarity.LengthNorm(Lucene.Net.Index.FieldInvertState)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_SetBaselineTfFactors_System_Single_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.SetBaselineTfFactors(System.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/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L64">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_SetBaselineTfFactors_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.SetBaselineTfFactors*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_SetBaselineTfFactors_System_Single_System_Single_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.SetBaselineTfFactors(System.Single,System.Single)">SetBaselineTfFactors(Single, Single)</h4> |
| <div class="markdown level1 summary"><p>Sets the baseline and minimum function variables for baselineTf</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetBaselineTfFactors(float base, float min)</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.Single</span></td> |
| <td><span class="parametername">base</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">min</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_SetBaselineTfFactors_System_Single_System_Single__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_BaselineTf_System_Single_">BaselineTf(Single)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_SetHyperbolicTfFactors_System_Single_System_Single_System_Double_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.SetHyperbolicTfFactors(System.Single%2CSystem.Single%2CSystem.Double%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/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L78">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_SetHyperbolicTfFactors_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.SetHyperbolicTfFactors*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_SetHyperbolicTfFactors_System_Single_System_Single_System_Double_System_Single_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.SetHyperbolicTfFactors(System.Single,System.Single,System.Double,System.Single)">SetHyperbolicTfFactors(Single, Single, Double, Single)</h4> |
| <div class="markdown level1 summary"><p>Sets the function variables for the hyperbolicTf functions</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetHyperbolicTfFactors(float min, float max, double base, float xoffset)</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.Single</span></td> |
| <td><span class="parametername">min</span></td> |
| <td><p>the minimum tf value to ever be returned (default: 0.0) </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">max</span></td> |
| <td><p>the maximum tf value to ever be returned (default: 2.0) </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">base</span></td> |
| <td><p>the base value to be used in the exponential for the hyperbolic function (default: 1.3) </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">xoffset</span></td> |
| <td><p>the midpoint of the hyperbolic function (default: 10.0) </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_SetHyperbolicTfFactors_System_Single_System_Single_System_Double_System_Single__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_HyperbolicTf_System_Single_">HyperbolicTf(Single)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_SetLengthNormFactors_System_Int32_System_Int32_System_Single_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.SetLengthNormFactors(System.Int32%2CSystem.Int32%2CSystem.Single%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L91">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_SetLengthNormFactors_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.SetLengthNormFactors*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_SetLengthNormFactors_System_Int32_System_Int32_System_Single_System_Boolean_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.SetLengthNormFactors(System.Int32,System.Int32,System.Single,System.Boolean)">SetLengthNormFactors(Int32, Int32, Single, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Sets the default function variables used by lengthNorm when no field |
| specific variables have been set.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetLengthNormFactors(int min, int max, float steepness, bool discountOverlaps)</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">min</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">max</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">steepness</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">discountOverlaps</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_SetLengthNormFactors_System_Int32_System_Int32_System_Single_System_Boolean__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_ComputeLengthNorm_System_Int32_">ComputeLengthNorm(Int32)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity_Tf_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity.Tf(System.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/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Misc_SweetSpotSimilarity_Tf_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.Tf*"></a> |
| <h4 id="Lucene_Net_Misc_SweetSpotSimilarity_Tf_System_Single_" data-uid="Lucene.Net.Misc.SweetSpotSimilarity.Tf(System.Single)">Tf(Single)</h4> |
| <div class="markdown level1 summary"><p>Delegates to baselineTf</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override float Tf(float freq)</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.Single</span></td> |
| <td><span class="parametername">freq</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.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_Tf_System_Single_">DefaultSimilarity.Tf(Single)</a></div> |
| <h5 id="Lucene_Net_Misc_SweetSpotSimilarity_Tf_System_Single__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Misc.SweetSpotSimilarity.html#Lucene_Net_Misc_SweetSpotSimilarity_BaselineTf_System_Single_">BaselineTf(Single)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Misc_SweetSpotSimilarity.md&value=---%0Auid%3A%20Lucene.Net.Misc.SweetSpotSimilarity%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Misc/Misc/SweetSpotSimilarity.cs/#L41" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |