blob: 43fe82a51407a9e02778fb032f3f9b3f15884c00 [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 SearchTravRetVectorHighlightTask
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SearchTravRetVectorHighlightTask
| 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="benchmark/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.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask">
<h1 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask" class="text-break">Class SearchTravRetVectorHighlightTask
</h1>
<div class="markdown level0 summary"><p>Search and Traverse and Retrieve docs task. Highlight the fields in the retrieved documents by using <span class="xref">Lucene.Net.Search.VectorHighlight.FastVectorHighlighter</span>.</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.Benchmarks.ByTask.Tasks.PerfTask.html">PerfTask</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html">ReadTask</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html">SearchTravTask</a></div>
<div class="level4"><span class="xref">SearchTravRetVectorHighlightTask</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_m_traversalSize">SearchTravTask.m_traversalSize</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_WithSearch">SearchTravTask.WithSearch</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_WithTraverse">SearchTravTask.WithTraverse</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_WithWarm">SearchTravTask.WithWarm</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_GetQueryMaker">SearchTravTask.GetQueryMaker()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_TraversalSize">SearchTravTask.TraversalSize</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_SupportsParams">SearchTravTask.SupportsParams</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_DoLogic">ReadTask.DoLogic()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_CreateCollector">ReadTask.CreateCollector()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_RetrieveDoc_Lucene_Net_Index_IndexReader_System_Int32_">ReadTask.RetrieveDoc(IndexReader, Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithCollector">ReadTask.WithCollector</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithScore">ReadTask.WithScore</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithMaxScore">ReadTask.WithMaxScore</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumHits">ReadTask.NumHits</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_Sort">ReadTask.Sort</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_logStep">PerfTask.m_logStep</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_params">PerfTask.m_params</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_NEW_LINE">PerfTask.NEW_LINE</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetRunInBackground_System_Int32_">PerfTask.SetRunInBackground(Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunInBackground">PerfTask.RunInBackground</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_BackgroundDeltaPriority">PerfTask.BackgroundDeltaPriority</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Stop">PerfTask.Stop</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_StopNow">PerfTask.StopNow()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Clone">PerfTask.Clone()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose">PerfTask.Dispose()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_System_Boolean_">PerfTask.Dispose(Boolean)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunAndMaybeStats_System_Boolean_">PerfTask.RunAndMaybeStats(Boolean)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetName">PerfTask.GetName()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetName_System_String_">PerfTask.SetName(String)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunData">PerfTask.RunData</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Depth">PerfTask.Depth</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ToString">PerfTask.ToString()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetLogMessage_System_Int32_">PerfTask.GetLogMessage(Int32)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNeverLogAtStart">PerfTask.ShouldNeverLogAtStart</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNotRecordStats">PerfTask.ShouldNotRecordStats</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown">PerfTask.TearDown()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Params">PerfTask.Params</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DisableCounting">PerfTask.DisableCounting</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_AlgLineNum">PerfTask.AlgLineNum</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.Benchmarks.ByTask.Tasks.html">Lucene.Net.Benchmarks.ByTask.Tasks</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6>
<h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SearchTravRetVectorHighlightTask : SearchTravTask, IDisposable</code></pre>
</div>
<h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>Note: This task reuses the reader if it is already open.
Otherwise a reader is opened at start and closed at the end.
<p>
Takes optional multivalued, comma separated param string as:</p>
<pre><code>size[&lt;traversal size>],highlight[&lt;int>],maxFrags[&lt;int>],mergeContiguous[&lt;boolean>],fields[name1;name2;...]</code></pre>
<p><ul><li>traversal sizeThe number of hits to traverse, otherwise all will be traversed.</li><li>highlightThe number of the hits to highlight. Will always be less than or equal to traversal size. Default is <span class="xref">System.Int32.MaxValue</span> (i.e. hits.Length).</li><li>maxFragsThe maximum number of fragments to score by the highlighter.</li><li>fragSizeThe length of fragments.</li><li>fieldsThe fields to highlight. If not specified all fields will be highlighted (or at least attempted).</li></ul>
<p>
Example:</p>
<pre><code>&quot;SearchVecHlgtSameRdr&quot; SearchTravRetVectorHighlight(size[10],highlight[10],maxFrags[3],fields[body]) > : 1000</code></pre>
<p><p>
Fields must be stored and term vector offsets and positions in order must be true for this task to work.
<p>
Other side effects: counts additional 1 (record) for each traversed hit,
and 1 more for each retrieved (non null) document and 1 for each fragment returned.</p>
</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.%23ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L69">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.#ctor*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.#ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)">SearchTravRetVectorHighlightTask(PerfRunData)</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 SearchTravRetVectorHighlightTask(PerfRunData runData)</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.Benchmarks.ByTask.PerfRunData.html">PerfRunData</a></td>
<td><span class="parametername">runData</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_fragSize.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_fragSize%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L65">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_fragSize" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_fragSize">m_fragSize</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 int m_fragSize</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.Int32</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_highlighter.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_highlighter%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L67">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_highlighter" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_highlighter">m_highlighter</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 FastVectorHighlighter m_highlighter</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">Lucene.Net.Search.VectorHighlight.FastVectorHighlighter</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_maxFrags.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_maxFrags%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L64">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_maxFrags" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_maxFrags">m_maxFrags</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 int m_maxFrags</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.Int32</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_numToHighlight.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_numToHighlight%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L63">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_numToHighlight" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_numToHighlight">m_numToHighlight</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 int m_numToHighlight</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.Int32</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_paramFields.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_paramFields%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L66">View Source</a>
</span>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_m_paramFields" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.m_paramFields">m_paramFields</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 ISet&lt;string&gt; m_paramFields</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.Collections.Generic.ISet</span>&lt;<span class="xref">System.String</span>&gt;</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_NumToHighlight.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.NumToHighlight%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L95">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_NumToHighlight_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.NumToHighlight*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_NumToHighlight" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.NumToHighlight">NumToHighlight</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 NumToHighlight { 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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumToHighlight">ReadTask.NumToHighlight</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_WithRetrieve.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.WithRetrieve%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L93">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_WithRetrieve_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.WithRetrieve*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_WithRetrieve" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.WithRetrieve">WithRetrieve</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 WithRetrieve { 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_WithRetrieve">SearchTravTask.WithRetrieve</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_GetBenchmarkHighlighter_Lucene_Net_Search_Query_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.GetBenchmarkHighlighter(Lucene.Net.Search.Query)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L97">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_GetBenchmarkHighlighter_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.GetBenchmarkHighlighter*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_GetBenchmarkHighlighter_Lucene_Net_Search_Query_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.GetBenchmarkHighlighter(Lucene.Net.Search.Query)">GetBenchmarkHighlighter(Query)</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 BenchmarkHighlighter GetBenchmarkHighlighter(Query q)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Lucene.Net.Search.Query</span></td>
<td><span class="parametername">q</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.Benchmarks.ByTask.Tasks.BenchmarkHighlighter.html">BenchmarkHighlighter</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetBenchmarkHighlighter_Lucene_Net_Search_Query_">ReadTask.GetBenchmarkHighlighter(Query)</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_GetFieldsToHighlight_Lucene_Net_Documents_Document_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.GetFieldsToHighlight(Lucene.Net.Documents.Document)%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L123">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_GetFieldsToHighlight_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.GetFieldsToHighlight*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_GetFieldsToHighlight_Lucene_Net_Documents_Document_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.GetFieldsToHighlight(Lucene.Net.Documents.Document)">GetFieldsToHighlight(Document)</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 ICollection&lt;string&gt; GetFieldsToHighlight(Document document)</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.Documents.Document</span></td>
<td><span class="parametername">document</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.Collections.Generic.ICollection</span>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetFieldsToHighlight_Lucene_Net_Documents_Document_">ReadTask.GetFieldsToHighlight(Document)</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_SetParams_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.SetParams(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L145">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_SetParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.SetParams*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_SetParams_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.SetParams(System.String)">SetParams(String)</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 SetParams(string params)</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">params</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravTask_SetParams_System_String_">SearchTravTask.SetParams(String)</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_Setup.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.Setup%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L74">View Source</a>
</span>
<a id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_Setup_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.Setup*"></a>
<h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask_Setup" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask.Setup">Setup()</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 Setup()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_Setup">ReadTask.Setup()</a></div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</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_Benchmarks_ByTask_Tasks_SearchTravRetVectorHighlightTask.md&amp;value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravRetVectorHighlightTask%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.Benchmark/ByTask/Tasks/SearchTravRetVectorHighlightTask.cs/#L61" 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>