blob: 135cbf3afb48b8801c310920a4c5825b79c21905 [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 LMSimilarity
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class LMSimilarity
| 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="core/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.Search.Similarities.LMSimilarity">
<h1 id="Lucene_Net_Search_Similarities_LMSimilarity" data-uid="Lucene.Net.Search.Similarities.LMSimilarity" class="text-break">Class LMSimilarity
</h1>
<div class="markdown level0 summary"><p>Abstract superclass for language modeling Similarities. The following inner
types are introduced:
<ul><li><a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.LMStats.html">LMSimilarity.LMStats</a>, which defines a new statistic, the probability that
the collection language model generates the current term;</li><li><a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.ICollectionModel.html">LMSimilarity.ICollectionModel</a>, which is a strategy interface for object that
compute the collection language model <code>p(w|C)</code>;</li><li><a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.DefaultCollectionModel.html">LMSimilarity.DefaultCollectionModel</a>, an implementation of the former, that
computes the term probability as the number of occurrences of the term in the
collection, divided by the total number of tokens.</li></ul>
<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"><a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html">Similarity</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html">SimilarityBase</a></div>
<div class="level3"><span class="xref">LMSimilarity</span></div>
<div class="level4"><a class="xref" href="Lucene.Net.Search.Similarities.LMDirichletSimilarity.html">LMDirichletSimilarity</a></div>
<div class="level4"><a class="xref" href="Lucene.Net.Search.Similarities.LMJelinekMercerSimilarity.html">LMJelinekMercerSimilarity</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_DiscountOverlaps">SimilarityBase.DiscountOverlaps</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_ComputeWeight_System_Single_Lucene_Net_Search_CollectionStatistics_Lucene_Net_Search_TermStatistics___">SimilarityBase.ComputeWeight(Single, CollectionStatistics, TermStatistics[])</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_Score_Lucene_Net_Search_Similarities_BasicStats_System_Single_System_Single_">SimilarityBase.Score(BasicStats, Single, Single)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_Explain_Lucene_Net_Search_Similarities_BasicStats_System_Int32_Lucene_Net_Search_Explanation_System_Single_">SimilarityBase.Explain(BasicStats, Int32, Explanation, Single)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_GetSimScorer_Lucene_Net_Search_Similarities_Similarity_SimWeight_Lucene_Net_Index_AtomicReaderContext_">SimilarityBase.GetSimScorer(Similarity.SimWeight, AtomicReaderContext)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_ComputeNorm_Lucene_Net_Index_FieldInvertState_">SimilarityBase.ComputeNorm(FieldInvertState)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_DecodeNormValue_System_Byte_">SimilarityBase.DecodeNormValue(Byte)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_EncodeNormValue_System_Single_System_Single_">SimilarityBase.EncodeNormValue(Single, Single)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_Log2_System_Double_">SimilarityBase.Log2(Double)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html#Lucene_Net_Search_Similarities_Similarity_Coord_System_Int32_System_Int32_">Similarity.Coord(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html#Lucene_Net_Search_Similarities_Similarity_QueryNorm_System_Single_">Similarity.QueryNorm(Single)</a>
</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.Search.Similarities.html">Lucene.Net.Search.Similarities</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Search_Similarities_LMSimilarity_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class LMSimilarity : SimilarityBase</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_Search_Similarities_LMSimilarity__ctor.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.%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/Search/Similarities/LMSimilarity.cs/#L52">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity__ctor_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.#ctor*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity__ctor" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.#ctor">LMSimilarity()</h4>
<div class="markdown level1 summary"><p>Creates a new instance with the default collection language model. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected LMSimilarity()</code></pre>
</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_Search_Similarities_LMSimilarity__ctor_Lucene_Net_Search_Similarities_LMSimilarity_ICollectionModel_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.%23ctor(Lucene.Net.Search.Similarities.LMSimilarity.ICollectionModel)%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/Search/Similarities/LMSimilarity.cs/#L45">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity__ctor_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.#ctor*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity__ctor_Lucene_Net_Search_Similarities_LMSimilarity_ICollectionModel_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.#ctor(Lucene.Net.Search.Similarities.LMSimilarity.ICollectionModel)">LMSimilarity(LMSimilarity.ICollectionModel)</h4>
<div class="markdown level1 summary"><p>Creates a new instance with the specified collection language model. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected LMSimilarity(LMSimilarity.ICollectionModel collectionModel)</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.Search.Similarities.LMSimilarity.ICollectionModel.html">LMSimilarity.ICollectionModel</a></td>
<td><span class="parametername">collectionModel</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Similarities_LMSimilarity_m_collectionModel.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.m_collectionModel%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/Search/Similarities/LMSimilarity.cs/#L41">View Source</a>
</span>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity_m_collectionModel" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.m_collectionModel">m_collectionModel</h4>
<div class="markdown level1 summary"><p>The collection model. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected readonly LMSimilarity.ICollectionModel m_collectionModel</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.Search.Similarities.LMSimilarity.ICollectionModel.html">LMSimilarity.ICollectionModel</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Similarities_LMSimilarity_Explain_Lucene_Net_Search_Explanation_Lucene_Net_Search_Similarities_BasicStats_System_Int32_System_Single_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.Explain(Lucene.Net.Search.Explanation%2CLucene.Net.Search.Similarities.BasicStats%2CSystem.Int32%2CSystem.Single%2CSystem.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Search/Similarities/LMSimilarity.cs/#L73">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity_Explain_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.Explain*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity_Explain_Lucene_Net_Search_Explanation_Lucene_Net_Search_Similarities_BasicStats_System_Int32_System_Single_System_Single_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.Explain(Lucene.Net.Search.Explanation,Lucene.Net.Search.Similarities.BasicStats,System.Int32,System.Single,System.Single)">Explain(Explanation, BasicStats, Int32, Single, Single)</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 override void Explain(Explanation expl, BasicStats stats, int doc, float freq, float docLen)</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.Search.Explanation.html">Explanation</a></td>
<td><span class="parametername">expl</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.Similarities.BasicStats.html">BasicStats</a></td>
<td><span class="parametername">stats</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">doc</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">freq</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">docLen</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_Explain_Lucene_Net_Search_Explanation_Lucene_Net_Search_Similarities_BasicStats_System_Int32_System_Single_System_Single_">SimilarityBase.Explain(Explanation, BasicStats, Int32, Single, Single)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Similarities_LMSimilarity_FillBasicStats_Lucene_Net_Search_Similarities_BasicStats_Lucene_Net_Search_CollectionStatistics_Lucene_Net_Search_TermStatistics_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.FillBasicStats(Lucene.Net.Search.Similarities.BasicStats%2CLucene.Net.Search.CollectionStatistics%2CLucene.Net.Search.TermStatistics)%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/Search/Similarities/LMSimilarity.cs/#L66">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity_FillBasicStats_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.FillBasicStats*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity_FillBasicStats_Lucene_Net_Search_Similarities_BasicStats_Lucene_Net_Search_CollectionStatistics_Lucene_Net_Search_TermStatistics_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.FillBasicStats(Lucene.Net.Search.Similarities.BasicStats,Lucene.Net.Search.CollectionStatistics,Lucene.Net.Search.TermStatistics)">FillBasicStats(BasicStats, CollectionStatistics, TermStatistics)</h4>
<div class="markdown level1 summary"><p>Computes the collection probability of the current term in addition to the
usual statistics.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override void FillBasicStats(BasicStats stats, CollectionStatistics collectionStats, TermStatistics termStats)</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.Search.Similarities.BasicStats.html">BasicStats</a></td>
<td><span class="parametername">stats</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.CollectionStatistics.html">CollectionStatistics</a></td>
<td><span class="parametername">collectionStats</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.TermStatistics.html">TermStatistics</a></td>
<td><span class="parametername">termStats</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_FillBasicStats_Lucene_Net_Search_Similarities_BasicStats_Lucene_Net_Search_CollectionStatistics_Lucene_Net_Search_TermStatistics_">SimilarityBase.FillBasicStats(BasicStats, CollectionStatistics, TermStatistics)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Similarities_LMSimilarity_GetName.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.GetName%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/Search/Similarities/LMSimilarity.cs/#L83">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity_GetName_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.GetName*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity_GetName" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.GetName">GetName()</h4>
<div class="markdown level1 summary"><p>Returns the name of the LM method. The values of the parameters should be
included as well.
<p>Used in <a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.html#Lucene_Net_Search_Similarities_LMSimilarity_ToString">ToString()</a></p>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract string GetName()</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>
<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_Search_Similarities_LMSimilarity_NewStats_System_String_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.NewStats(System.String%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/Search/Similarities/LMSimilarity.cs/#L57">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity_NewStats_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.NewStats*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity_NewStats_System_String_System_Single_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.NewStats(System.String,System.Single)">NewStats(String, Single)</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 override BasicStats NewStats(string field, float queryBoost)</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>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">queryBoost</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.Search.Similarities.BasicStats.html">BasicStats</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_NewStats_System_String_System_Single_">SimilarityBase.NewStats(String, Single)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Similarities_LMSimilarity_ToString.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity.ToString%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/Search/Similarities/LMSimilarity.cs/#L91">View Source</a>
</span>
<a id="Lucene_Net_Search_Similarities_LMSimilarity_ToString_" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.ToString*"></a>
<h4 id="Lucene_Net_Search_Similarities_LMSimilarity_ToString" data-uid="Lucene.Net.Search.Similarities.LMSimilarity.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Returns the name of the LM method. If a custom collection model strategy is
used, its name is included as well. </p>
</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()</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.Search.Similarities.SimilarityBase.html#Lucene_Net_Search_Similarities_SimilarityBase_ToString">SimilarityBase.ToString()</a></div>
<h5 id="Lucene_Net_Search_Similarities_LMSimilarity_ToString_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.html#Lucene_Net_Search_Similarities_LMSimilarity_GetName">GetName()</a></div>
<div><a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.ICollectionModel.html#Lucene_Net_Search_Similarities_LMSimilarity_ICollectionModel_GetName">GetName</a>()</div>
<div><a class="xref" href="Lucene.Net.Search.Similarities.LMSimilarity.DefaultCollectionModel.html">LMSimilarity.DefaultCollectionModel</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_Search_Similarities_LMSimilarity.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Similarities.LMSimilarity%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/Search/Similarities/LMSimilarity.cs/#L37" 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>