| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Config |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Config |
| | Apache Lucene.NET 4.8.0-beta00009 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.Utils.Config"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_ByTask_Utils_Config" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config" class="text-break">Class Config |
| </h1> |
| <div class="markdown level0 summary"><p>Perf run configuration properties.</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">Config</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <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> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Utils.html">Lucene.Net.Benchmarks.ByTask.Utils</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class Config</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>Numeric property containing ":", e.g. "10<span class="emoji" shortcode="100">💯</span>5" is interpreted |
| as array of numeric values. It is extracted once, on first use, and |
| maintain a round number to return the appropriate value. |
| <p> |
| The config property "work.dir" tells where is the root of |
| docs data dirs and indexes dirs. It is set to either of: |
| <ul><li>value supplied for it in the alg file;</li><li>otherwise, value of environment variable "benchmark.work.dir";</li><li>otherwise, "work".</li></ul></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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config__ctor_System_Collections_Generic_IDictionary_System_String_System_String__.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.%23ctor(System.Collections.Generic.IDictionary%7BSystem.String%2CSystem.String%7D)%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L126">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config__ctor_System_Collections_Generic_IDictionary_System_String_System_String__" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">Config(IDictionary<String, String>)</h4> |
| <div class="markdown level1 summary"><p>Create config without algorithm - useful for a programmatic perf test.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Config(IDictionary<string, string> props)</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.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>></td> |
| <td><span class="parametername">props</span></td> |
| <td><p>Configuration properties.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config__ctor_System_IO_TextReader_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.%23ctor(System.IO.TextReader)%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L64">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config__ctor_System_IO_TextReader_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.#ctor(System.IO.TextReader)">Config(TextReader)</h4> |
| <div class="markdown level1 summary"><p>Read both algorithm and config properties.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Config(TextReader algReader)</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.IO.TextReader</span></td> |
| <td><span class="parametername">algReader</span></td> |
| <td><p>From where to read algorithm and config properties.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_AlgorithmText.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.AlgorithmText%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L559">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_AlgorithmText_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.AlgorithmText*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_AlgorithmText" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.AlgorithmText">AlgorithmText</h4> |
| <div class="markdown level1 summary"><p>Gets the algorithmText.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string AlgorithmText { 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> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_RoundNumber.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.RoundNumber%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L551">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_RoundNumber_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.RoundNumber*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_RoundNumber" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.RoundNumber">RoundNumber</h4> |
| <div class="markdown level1 summary"><p>Gets the round number.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int RoundNumber { 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> |
| <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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L306">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_Boolean_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String,System.Boolean)">Get(String, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Return a boolean property. |
| If the property contain ":", e.g. "true.true.false", it is interpreted |
| as array of booleans. It is extracted once, on first call |
| to Get() it, and a by-round-value is returned.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool Get(string name, bool dflt)</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">name</span></td> |
| <td><p>Name of property.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">dflt</span></td> |
| <td><p>Default value.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><p>A <span class="xref">System.Boolean</span> property.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String%2CSystem.Double)%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L267">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_Double_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String,System.Double)">Get(String, Double)</h4> |
| <div class="markdown level1 summary"><p>Return a double property. |
| <p> |
| If the property contain ":", e.g. "10<span class="emoji" shortcode="100">💯</span>5", it is interpreted |
| as array of doubles. It is extracted once, on first call |
| to Get() it, and a by-round-value is returned.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual double Get(string name, double dflt)</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">name</span></td> |
| <td><p>Name of property.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">dflt</span></td> |
| <td><p>Default value.</p> |
| </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.Double</span></td> |
| <td><p>A double property.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String%2CSystem.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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L227">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_Int32_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String,System.Int32)">Get(String, Int32)</h4> |
| <div class="markdown level1 summary"><p>Return an <span class="xref">System.Int32</span> property. |
| <p> |
| If the property contain ":", e.g. "10<span class="emoji" shortcode="100">💯</span>5", it is interpreted |
| as array of ints. It is extracted once, on first call |
| to Get() it, and a by-round-value is returned.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int Get(string name, int dflt)</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">name</span></td> |
| <td><p>Name of property.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">dflt</span></td> |
| <td><p>Default value.</p> |
| </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.Int32</span></td> |
| <td><p>An <span class="xref">System.Int32</span> property.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String%2CSystem.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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L161">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Get_System_String_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Get(System.String,System.String)">Get(String, String)</h4> |
| <div class="markdown level1 summary"><p>Return a string property.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string Get(string name, string dflt)</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">name</span></td> |
| <td><p>Name of property.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">dflt</span></td> |
| <td><p>Default value.</p> |
| </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.String</span></td> |
| <td><p>A string property.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_GetColsNamesForValsByRound.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.GetColsNamesForValsByRound%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L480">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_GetColsNamesForValsByRound_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.GetColsNamesForValsByRound*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_GetColsNamesForValsByRound" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.GetColsNamesForValsByRound">GetColsNamesForValsByRound()</h4> |
| <div class="markdown level1 summary"><p>Gets names of params set by round, for reports title.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string GetColsNamesForValsByRound()</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_GetColsValuesForValsByRound_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.GetColsValuesForValsByRound(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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L498">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_GetColsValuesForValsByRound_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.GetColsValuesForValsByRound*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_GetColsValuesForValsByRound_System_Int32_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.GetColsValuesForValsByRound(System.Int32)">GetColsValuesForValsByRound(Int32)</h4> |
| <div class="markdown level1 summary"><p>Gets values of params set by round, for reports lines.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string GetColsValuesForValsByRound(int roundNum)</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">roundNum</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.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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_NewRound.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.NewRound%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L340">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_NewRound_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.NewRound*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_NewRound" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.NewRound">NewRound()</h4> |
| <div class="markdown level1 summary"><p>Increment the round number, for config values that are extracted by round number.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int NewRound()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>The new round number.</p> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config_Set_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config.Set(System.String%2CSystem.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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L207">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Set_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Set*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Utils_Config_Set_System_String_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Utils.Config.Set(System.String,System.String)">Set(String, String)</h4> |
| <div class="markdown level1 summary"><p>Set a property. |
| <p> |
| Note: once a multiple values property is set, it can no longer be modified.</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 Set(string name, string value)</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">name</span></td> |
| <td><p>Name of property.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>Either single or multiple property value (multiple values are separated by ":")</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Utils_Config.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Utils.Config%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/docs-poc/src/Lucene.Net.Benchmark/ByTask/Utils/Config.cs/#L46" 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> |