| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class IDFValueSource |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class IDFValueSource |
| | 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.IDFValueSource"> |
| |
| |
| <h1 id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource" class="text-break">Class IDFValueSource |
| </h1> |
| <div class="markdown level0 summary"><p>Function that returns <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Similarities.TFIDFSimilarity.html#Lucene_Net_Search_Similarities_TFIDFSimilarity_Idf_System_Int64_System_Int64_">Idf(Int64, Int64)</a> |
| for every document. |
| <p> |
| Note that the configured Similarity for the field must be |
| a subclass of <span class="xref">Lucene.Net.Search.Similarities.TFIDFSimilarity</span></p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div><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"><a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html">DocFreqValueSource</a></div> |
| <div class="level3"><span class="xref">IDFValueSource</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_m_field">DocFreqValueSource.m_field</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_m_indexedField">DocFreqValueSource.m_indexedField</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_m_val">DocFreqValueSource.m_val</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_m_indexedBytes">DocFreqValueSource.m_indexedBytes</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_GetDescription">DocFreqValueSource.GetDescription()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_CreateWeight_System_Collections_IDictionary_Lucene_Net_Search_IndexSearcher_">DocFreqValueSource.CreateWeight(IDictionary, IndexSearcher)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_GetHashCode">DocFreqValueSource.GetHashCode()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_Equals_System_Object_">DocFreqValueSource.Equals(Object)</a> |
| </div> |
| <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_IDFValueSource_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class IDFValueSource : DocFreqValueSource</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_IDFValueSource__ctor_System_String_System_String_System_String_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.IDFValueSource.%23ctor(System.String%2CSystem.String%2CSystem.String%2CLucene.Net.Util.BytesRef)%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/IDFValueSource.cs/#L39">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource__ctor_" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource.#ctor*"></a> |
| <h4 id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource__ctor_System_String_System_String_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource.#ctor(System.String,System.String,System.String,Lucene.Net.Util.BytesRef)">IDFValueSource(String, String, String, BytesRef)</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 IDFValueSource(string field, string val, string indexedField, BytesRef indexedBytes)</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.String</span></td> |
| <td><span class="parametername">val</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">indexedField</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.BytesRef</span></td> |
| <td><span class="parametername">indexedBytes</span></td> |
| <td></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_Function_ValueSources_IDFValueSource_Name.md&value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.IDFValueSource.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/Function/ValueSources/IDFValueSource.cs/#L44">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource_Name_" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource.Name*"></a> |
| <h4 id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource_Name" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource.Name">Name</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 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Queries.Function.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_Name">DocFreqValueSource.Name</a></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Queries_Function_ValueSources_IDFValueSource_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_.md&value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.IDFValueSource.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/IDFValueSource.cs/#L46">View Source</a> |
| </span> |
| <a id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource_GetValues_" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource.GetValues*"></a> |
| <h4 id="Lucene_Net_Queries_Function_ValueSources_IDFValueSource_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Queries.Function.ValueSources.IDFValueSource.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.ValueSources.DocFreqValueSource.html#Lucene_Net_Queries_Function_ValueSources_DocFreqValueSource_GetValues_System_Collections_IDictionary_Lucene_Net_Index_AtomicReaderContext_">DocFreqValueSource.GetValues(IDictionary, AtomicReaderContext)</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_Function_ValueSources_IDFValueSource.md&value=---%0Auid%3A%20Lucene.Net.Queries.Function.ValueSources.IDFValueSource%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/IDFValueSource.cs/#L36" 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> |