This commit is contained in:
2025-12-29 11:56:30 +08:00
parent 1e41b2def5
commit 955dab6e65
44 changed files with 2497 additions and 928 deletions
@@ -153,6 +153,139 @@ Class ListUtil
</h2>
<a id="Hi_Common_Collections_ListUtil_GetCeilBySeek_" data-uid="Hi.Common.Collections.ListUtil.GetCeilBySeek*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetCeilBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.ListUtil.GetCeilBySeek``2(System.Collections.Generic.IList{``0},``1,System.Func{``0,``1},``0@,System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetCeilBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"><p>Gets the ceil item by seeking with the specified direction.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilBySeek&lt;TItem, TKey&gt;(this IList&lt;TItem&gt; src, TKey key, Func&lt;TItem, TKey&gt; getKeyFunc, out TItem ceilValue, out int ceilIndex, int seekingStartIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TItem&gt;</dt>
<dd><p>The source list.</p>
</dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>getKeyFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TItem, TKey&gt;</dt>
<dd><p>A function that extracts the key from an item.</p>
</dd>
<dt><code>ceilValue</code> <span class="xref">TItem</span></dt>
<dd><p>The output ceil value.</p>
</dd>
<dt><code>ceilIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The output ceil index.</p>
</dd>
<dt><code>seekingStartIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>The seek direction.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The search result.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TItem</code></dt>
<dd><p>The type of items in the list.</p>
</dd>
<dt><code>TKey</code></dt>
<dd><p>The type of the key.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_ListUtil_GetCeilIndexBySeek_" data-uid="Hi.Common.Collections.ListUtil.GetCeilIndexBySeek*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetCeilIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.ListUtil.GetCeilIndexBySeek``2(System.Collections.Generic.IList{``0},``1,System.Func{``0,``1},System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetCeilIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"><p>Gets the ceil index by seeking with the specified direction.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilIndexBySeek&lt;TItem, TKey&gt;(this IList&lt;TItem&gt; src, TKey key, Func&lt;TItem, TKey&gt; getKeyFunc, out int ceilIndex, int seekingStartIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TItem&gt;</dt>
<dd><p>The source list.</p>
</dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>getKeyFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TItem, TKey&gt;</dt>
<dd><p>A function that extracts the key from an item.</p>
</dd>
<dt><code>ceilIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The output ceil index.</p>
</dd>
<dt><code>seekingStartIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>The seek direction.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The search result.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TItem</code></dt>
<dd><p>The type of items in the list.</p>
</dd>
<dt><code>TKey</code></dt>
<dd><p>The type of the key.</p>
</dd>
</dl>
<h4 class="section" id="Hi_Common_Collections_ListUtil_GetCeilIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Hi.Common.Collections.SeekDirection.html#Hi_Common_Collections_SeekDirection_Free">Free</a> seek direction does not loss additional performance.
The seek direction only effect the resulting value by the <code class="paramref">seekingStartIndex</code> bound.</p>
</div>
<a id="Hi_Common_Collections_ListUtil_GetCeilIndex_" data-uid="Hi.Common.Collections.ListUtil.GetCeilIndex*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetCeilIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__" data-uid="Hi.Common.Collections.ListUtil.GetCeilIndex``2(System.Collections.Generic.IList{``0},``1,System.Func{``0,``1,System.Int32},System.Int32@)">
@@ -165,7 +298,7 @@ Class ListUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeilIndex&lt;Item, ItemKey&gt;(this IList&lt;Item&gt; sortedItems, ItemKey key, Func&lt;Item, ItemKey, int&gt; comparingFunc, out int index)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilIndex&lt;Item, ItemKey&gt;(this IList&lt;Item&gt; sortedItems, ItemKey key, Func&lt;Item, ItemKey, int&gt; comparingFunc, out int index)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -186,8 +319,8 @@ Class ListUtil
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a> indicating the result of the search.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a> indicating the result of the search.</p>
</dd>
</dl>
@@ -222,7 +355,7 @@ Class ListUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeilIndex&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey keyQuantity, Func&lt;Item, TKey&gt; getKeyQuantityFunc, out int index) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilIndex&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey keyQuantity, Func&lt;Item, TKey&gt; getKeyQuantityFunc, out int index) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -243,8 +376,8 @@ Class ListUtil
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a> indicating the result of the search.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a> indicating the result of the search.</p>
</dd>
</dl>
@@ -279,7 +412,7 @@ Class ListUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeil&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey keyQuantity, Func&lt;Item, TKey&gt; getKeyQuantityFunc, out Item dst) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetCeil&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey keyQuantity, Func&lt;Item, TKey&gt; getKeyQuantityFunc, out Item dst) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -300,8 +433,8 @@ Class ListUtil
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a> indicating the result of the search.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a> indicating the result of the search.</p>
</dd>
</dl>
@@ -324,6 +457,139 @@ Class ListUtil
<a id="Hi_Common_Collections_ListUtil_GetFloorBySeek_" data-uid="Hi.Common.Collections.ListUtil.GetFloorBySeek*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetFloorBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.ListUtil.GetFloorBySeek``2(System.Collections.Generic.IList{``0},``1,System.Func{``0,``1},``0@,System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetFloorBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"><p>Gets the floor item by seeking with the specified direction.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorBySeek&lt;TItem, TKey&gt;(this IList&lt;TItem&gt; src, TKey key, Func&lt;TItem, TKey&gt; getKeyFunc, out TItem floorValue, out int floorIndex, int seekingStartIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TItem&gt;</dt>
<dd><p>The source list.</p>
</dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>getKeyFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TItem, TKey&gt;</dt>
<dd><p>A function that extracts the key from an item.</p>
</dd>
<dt><code>floorValue</code> <span class="xref">TItem</span></dt>
<dd><p>The output floor value.</p>
</dd>
<dt><code>floorIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The output floor index.</p>
</dd>
<dt><code>seekingStartIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>The seek direction.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The search result.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TItem</code></dt>
<dd><p>The type of items in the list.</p>
</dd>
<dt><code>TKey</code></dt>
<dd><p>The type of the key.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_ListUtil_GetFloorIndexBySeek_" data-uid="Hi.Common.Collections.ListUtil.GetFloorIndexBySeek*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetFloorIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.ListUtil.GetFloorIndexBySeek``2(System.Collections.Generic.IList{``0},``1,System.Func{``0,``1},System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetFloorIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"><p>Gets the floor index by seeking with the specified direction.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorIndexBySeek&lt;TItem, TKey&gt;(this IList&lt;TItem&gt; src, TKey key, Func&lt;TItem, TKey&gt; getKeyFunc, out int floorIndex, int seekingStartIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TItem&gt;</dt>
<dd><p>The source list.</p>
</dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>getKeyFunc</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;TItem, TKey&gt;</dt>
<dd><p>A function that extracts the key from an item.</p>
</dd>
<dt><code>floorIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The output floor index.</p>
</dd>
<dt><code>seekingStartIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>The seek direction.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The search result.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TItem</code></dt>
<dd><p>The type of items in the list.</p>
</dd>
<dt><code>TKey</code></dt>
<dd><p>The type of the key.</p>
</dd>
</dl>
<h4 class="section" id="Hi_Common_Collections_ListUtil_GetFloorIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Hi.Common.Collections.SeekDirection.html#Hi_Common_Collections_SeekDirection_Free">Free</a> seek direction does not loss additional performance.
The seek direction only effect the resulting value by the <code class="paramref">seekingStartIndex</code> bound.</p>
</div>
<a id="Hi_Common_Collections_ListUtil_GetFloorIndex_" data-uid="Hi.Common.Collections.ListUtil.GetFloorIndex*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetFloorIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__" data-uid="Hi.Common.Collections.ListUtil.GetFloorIndex``2(System.Collections.Generic.IList{``0},``1,System.Func{``0,``1,System.Int32},System.Int32@)">
@@ -336,7 +602,7 @@ Class ListUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorIndex&lt;Item, ItemKey&gt;(this IList&lt;Item&gt; sortedItems, ItemKey key, Func&lt;Item, ItemKey, int&gt; comparingFunc, out int index)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorIndex&lt;Item, ItemKey&gt;(this IList&lt;Item&gt; sortedItems, ItemKey key, Func&lt;Item, ItemKey, int&gt; comparingFunc, out int index)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -357,8 +623,8 @@ Class ListUtil
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a> indicating the result of the search.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a> indicating the result of the search.</p>
</dd>
</dl>
@@ -393,7 +659,7 @@ Class ListUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorIndex&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey key, Func&lt;Item, TKey&gt; getKeyFunc, out int index) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorIndex&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey key, Func&lt;Item, TKey&gt; getKeyFunc, out int index) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -414,8 +680,8 @@ Class ListUtil
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a> indicating the result of the search.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a> indicating the result of the search.</p>
</dd>
</dl>
@@ -450,7 +716,7 @@ Class ListUtil
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloor&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey keyQuantity, Func&lt;Item, TKey&gt; getKeyQuantityFunc, out Item dst) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloor&lt;TKey, Item&gt;(this IList&lt;Item&gt; sortedItems, TKey keyQuantity, Func&lt;Item, TKey&gt; getKeyQuantityFunc, out Item dst) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -471,8 +737,8 @@ Class ListUtil
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a> indicating the result of the search.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A <a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a> indicating the result of the search.</p>
</dd>
</dl>
@@ -1175,7 +1441,7 @@ with the list items.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestIndex&lt;TItem, TItemKey&gt;(this IList&lt;TItem&gt; src, TItemKey key, Func&lt;TItem, TItemKey, double&gt; itemToKeyDistanceFunc, out int index)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetNearestIndex&lt;TItem, TItemKey&gt;(this IList&lt;TItem&gt; src, TItemKey key, Func&lt;TItem, TItemKey, double&gt; itemToKeyDistanceFunc, out int index)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -1196,7 +1462,7 @@ with the list items.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A BinarySearchResult indicating the result of the search</p>
</dd>
</dl>
@@ -1232,7 +1498,7 @@ with the list items.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestIndex&lt;TItem, TItemKey&gt;(this IList&lt;TItem&gt; src, TItemKey key, Func&lt;TItem, TItemKey, int&gt; itemCompareToKeyFunc, Func&lt;TItem, TItemKey, double&gt; itemToKeyDistanceFunc, out int index)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetNearestIndex&lt;TItem, TItemKey&gt;(this IList&lt;TItem&gt; src, TItemKey key, Func&lt;TItem, TItemKey, int&gt; itemCompareToKeyFunc, Func&lt;TItem, TItemKey, double&gt; itemToKeyDistanceFunc, out int index)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -1256,7 +1522,7 @@ with the list items.</p>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A BinarySearchResult indicating the result of the search</p>
</dd>
</dl>
@@ -1718,6 +1984,51 @@ with the list items.</p>
<a id="Hi_Common_Collections_ListUtil_GetSubList_" data-uid="Hi.Common.Collections.ListUtil.GetSubList*"></a>
<h3 id="Hi_Common_Collections_ListUtil_GetSubList__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.ListUtil.GetSubList``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32)">
GetSubList&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SubList&lt;TItem&gt; GetSubList&lt;TItem&gt;(this IList&lt;TItem&gt; src, int beginIndex, int endIndex)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TItem&gt;</dt>
<dd></dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.Collections.SubList-1.html">SubList</a>&lt;TItem&gt;</dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TItem</code></dt>
<dd></dd>
</dl>
<a id="Hi_Common_Collections_ListUtil_Swap_" data-uid="Hi.Common.Collections.ListUtil.Swap*"></a>
<h3 id="Hi_Common_Collections_ListUtil_Swap__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.ListUtil.Swap``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32)">
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Enum SortedListUtil.SearchMethod | HiAPI-C# 2025 </title>
<title>Enum SearchTargetMode | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum SortedListUtil.SearchMethod | HiAPI-C# 2025 ">
<meta name="title" content="Enum SearchTargetMode | HiAPI-C# 2025 ">
<meta name="description" content="Specifies the search method to use when looking for values in a sorted list.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,13 +84,13 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.Collections.SortedListUtil.SearchMethod">
<article data-uid="Hi.Common.Collections.SearchTargetMode">
<h1 id="Hi_Common_Collections_SortedListUtil_SearchMethod" data-uid="Hi.Common.Collections.SortedListUtil.SearchMethod" class="text-break">
Enum SortedListUtil.SearchMethod
<h1 id="Hi_Common_Collections_SearchTargetMode" data-uid="Hi.Common.Collections.SearchTargetMode" class="text-break">
Enum SearchTargetMode
</h1>
<div class="facts text-secondary">
@@ -103,7 +103,7 @@ Enum SortedListUtil.SearchMethod
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum SortedListUtil.SearchMethod</code></pre>
<pre><code class="lang-csharp hljs">public enum SearchTargetMode</code></pre>
</div>
@@ -145,11 +145,11 @@ Enum SortedListUtil.SearchMethod
<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="Hi_Common_Collections_SortedListUtil_SearchMethod_Ceil"><code>Ceil = 1</code></dt>
<dt id="Hi_Common_Collections_SearchTargetMode_Ceil"><code>Ceil = 1</code></dt>
<dd><p>Find the smallest element greater than or equal to the key.</p>
</dd>
<dt id="Hi_Common_Collections_SortedListUtil_SearchMethod_Floor"><code>Floor = 0</code></dt>
<dt id="Hi_Common_Collections_SearchTargetMode_Floor"><code>Floor = 0</code></dt>
<dd><p>Find the largest element less than or equal to the key.</p>
</dd>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Enum SortedListUtil.SeekDirection | HiAPI-C# 2025 </title>
<title>Enum SeekDirection | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum SortedListUtil.SeekDirection | HiAPI-C# 2025 ">
<meta name="title" content="Enum SeekDirection | HiAPI-C# 2025 ">
<meta name="description" content="Specifies the seek direction for sorted list operations.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,13 +84,13 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.Collections.SortedListUtil.SeekDirection">
<article data-uid="Hi.Common.Collections.SeekDirection">
<h1 id="Hi_Common_Collections_SortedListUtil_SeekDirection" data-uid="Hi.Common.Collections.SortedListUtil.SeekDirection" class="text-break">
Enum SortedListUtil.SeekDirection
<h1 id="Hi_Common_Collections_SeekDirection" data-uid="Hi.Common.Collections.SeekDirection" class="text-break">
Enum SeekDirection
</h1>
<div class="facts text-secondary">
@@ -103,7 +103,7 @@ Enum SortedListUtil.SeekDirection
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum SortedListUtil.SeekDirection</code></pre>
<pre><code class="lang-csharp hljs">public enum SeekDirection</code></pre>
</div>
@@ -145,15 +145,15 @@ Enum SortedListUtil.SeekDirection
<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="Hi_Common_Collections_SortedListUtil_SeekDirection_Backward"><code>Backward = 2</code></dt>
<dt id="Hi_Common_Collections_SeekDirection_Backward"><code>Backward = 2</code></dt>
<dd><p>Backward seek direction.</p>
</dd>
<dt id="Hi_Common_Collections_SortedListUtil_SeekDirection_Forward"><code>Forward = 1</code></dt>
<dt id="Hi_Common_Collections_SeekDirection_Forward"><code>Forward = 1</code></dt>
<dd><p>Forward seek direction.</p>
</dd>
<dt id="Hi_Common_Collections_SortedListUtil_SeekDirection_Free"><code>Free = 0</code></dt>
<dt id="Hi_Common_Collections_SeekDirection_Free"><code>Free = 0</code></dt>
<dd><p>Free seek direction without additional performance cost.</p>
</dd>
@@ -155,18 +155,18 @@ Class SortedListUtil
<a id="Hi_Common_Collections_SortedListUtil_GetByMethod_" data-uid="Hi.Common.Collections.SortedListUtil.GetByMethod*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetByMethod__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_Collections_SortedListUtil_SearchMethod___1__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetByMethod``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.Collections.SortedListUtil.SearchMethod,``1@,System.Int32,System.Int32)">
GetByMethod&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, SearchMethod, out V, int, int)
<h3 id="Hi_Common_Collections_SortedListUtil_GetByMethod__2_System_Collections_Generic_SortedList___0___1____0_Hi_Common_Collections_SearchTargetMode___1__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetByMethod``2(System.Collections.Generic.SortedList{``0,``1},``0,Hi.Common.Collections.SearchTargetMode,``1@,System.Int32,System.Int32)">
GetByMethod&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, SearchTargetMode, out V, int, int)
</h3>
<div class="markdown level1 summary"><p>Get value by <code class="paramref">searchMethod</code>.
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.SearchResult.html#Hi_Common_SearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetByMethod&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, SortedListUtil.SearchMethod searchMethod, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetByMethod&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, SearchTargetMode searchMethod, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -177,7 +177,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>key</p>
</dd>
<dt><code>searchMethod</code> <a class="xref" href="Hi.Common.Collections.SortedListUtil.html">SortedListUtil</a>.<a class="xref" href="Hi.Common.Collections.SortedListUtil.SearchMethod.html">SearchMethod</a></dt>
<dt><code>searchMethod</code> <a class="xref" href="Hi.Common.Collections.SearchTargetMode.html">SearchTargetMode</a></dt>
<dd><p>search method</p>
</dd>
<dt><code>resultValue</code> <span class="xref">V</span></dt>
@@ -193,7 +193,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -217,6 +217,125 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<a id="Hi_Common_Collections_SortedListUtil_GetCeilBySeek_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilBySeek*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeilBySeek__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetCeilBySeek&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"><p>Gets the ceil value by seeking with the specified direction.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V ceilValue, out int ceilListIndex, int seekingStartListIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd><p>The source sorted list.</p>
</dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd><p>The key to search for.</p>
</dd>
<dt><code>ceilValue</code> <span class="xref">V</span></dt>
<dd><p>The output ceil value.</p>
</dd>
<dt><code>ceilListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The output ceil list index.</p>
</dd>
<dt><code>seekingStartListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start list index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>The seek direction.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The binary search result.</p>
</dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd><p>The type of keys in the sorted list.</p>
</dd>
<dt><code>V</code></dt>
<dd><p>The type of values in the sorted list.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SortedListUtil_GetCeilListIndexBySeek_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilListIndexBySeek*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeilListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilListIndexBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetCeilListIndexBySeek&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out int, int, SeekDirection)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilListIndexBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int ceilListIndex, int seekingStartListIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.sortedlist-2">SortedList</a>&lt;TKey, V&gt;</dt>
<dd></dd>
<dt><code>key</code> <span class="xref">TKey</span></dt>
<dd></dd>
<dt><code>ceilListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>seekingStartListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>start list index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd></dd>
</dl>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>TKey</code></dt>
<dd></dd>
<dt><code>V</code></dt>
<dd></dd>
</dl>
<h4 class="section" id="Hi_Common_Collections_SortedListUtil_GetCeilListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SeekDirection__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Hi.Common.Collections.SeekDirection.html#Hi_Common_Collections_SeekDirection_Free">Free</a> seek direction does not loss additional performance.
The seek direction only effect the resulting value by the <code class="paramref">seekingStartListIndex</code> bound.</p>
</div>
<a id="Hi_Common_Collections_SortedListUtil_GetCeilListIndex_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilListIndex*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetCeilListIndex__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SortedListUtil.GetCeilListIndex``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,System.Int32)">
@@ -229,7 +348,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeilListIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int resultListIndex, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetCeilListIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int resultListIndex, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -253,7 +372,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, a ceiling value was found, or no suitable element exists.</p>
</dd>
</dl>
@@ -289,7 +408,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -313,7 +432,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The binary search result.</p>
</dd>
</dl>
@@ -345,12 +464,12 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
</h3>
<div class="markdown level1 summary"><p>Get ceil value by <code class="paramref">key</code>.
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.SearchResult.html#Hi_Common_SearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, out int ceilIndex, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetCeil&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, out int ceilIndex, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -377,7 +496,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -469,7 +588,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<a id="Hi_Common_Collections_SortedListUtil_GetFloorBySeek_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorBySeek*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorBySeek__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32__System_Int32_Hi_Common_Collections_SortedListUtil_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32@,System.Int32,Hi.Common.Collections.SortedListUtil.SeekDirection)">
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorBySeek__2_System_Collections_Generic_SortedList___0___1____0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,``1@,System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetFloorBySeek&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out V, out int, int, SeekDirection)
</h3>
@@ -479,7 +598,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V floorValue, out int floorListIndex, int startListIndex, SortedListUtil.SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V floorValue, out int floorListIndex, int seekingStartListIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -496,17 +615,17 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<dt><code>floorListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The output floor list index.</p>
</dd>
<dt><code>startListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start list index.</p>
<dt><code>seekingStartListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start list index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SortedListUtil.html">SortedListUtil</a>.<a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html">SeekDirection</a></dt>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>The seek direction.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>The binary search result.</p>
</dd>
</dl>
@@ -532,7 +651,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<a id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndexBySeek*"></a>
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SortedListUtil_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndexBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,Hi.Common.Collections.SortedListUtil.SeekDirection)">
<h3 id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_" data-uid="Hi.Common.Collections.SortedListUtil.GetFloorListIndexBySeek``2(System.Collections.Generic.SortedList{``0,``1},``0,System.Int32@,System.Int32,Hi.Common.Collections.SeekDirection)">
GetFloorListIndexBySeek&lt;TKey, V&gt;(SortedList&lt;TKey, V&gt;, TKey, out int, int, SeekDirection)
</h3>
@@ -541,7 +660,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorListIndexBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int floorListIndex, int startListIndex, SortedListUtil.SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorListIndexBySeek&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int floorListIndex, int seekingStartListIndex, SeekDirection seekDirection = SeekDirection.Free) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -552,15 +671,16 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<dd></dd>
<dt><code>floorListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>startListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SortedListUtil.html">SortedListUtil</a>.<a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html">SeekDirection</a></dt>
<dt><code>seekingStartListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>start list index for seeking.</p>
</dd>
<dt><code>seekDirection</code> <a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd></dd>
</dl>
@@ -577,9 +697,9 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section" id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SortedListUtil_SeekDirection__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html#Hi_Common_Collections_SortedListUtil_SeekDirection_Free">Free</a> seek direction does not loss additional performance.
The seek direction only effect the resulting value by the <code class="paramref">startListIndex</code> bound.</p>
<h4 class="section" id="Hi_Common_Collections_SortedListUtil_GetFloorListIndexBySeek__2_System_Collections_Generic_SortedList___0___1____0_System_Int32__System_Int32_Hi_Common_Collections_SeekDirection__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Hi.Common.Collections.SeekDirection.html#Hi_Common_Collections_SeekDirection_Free">Free</a> seek direction does not loss additional performance.
The seek direction only effect the resulting value by the <code class="paramref">seekingStartListIndex</code> bound.</p>
</div>
@@ -597,7 +717,7 @@ The seek direction only effect the resulting value by the <code class="paramref"
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloorListIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int resultListIndex, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloorListIndex&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out int resultListIndex, int beginListIndex = 0, int endListIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -621,7 +741,7 @@ The seek direction only effect the resulting value by the <code class="paramref"
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, a floor value was found, or no suitable element exists.</p>
</dd>
</dl>
@@ -653,12 +773,12 @@ The seek direction only effect the resulting value by the <code class="paramref"
</h3>
<div class="markdown level1 summary"><p>Get floor value by <code class="paramref">key</code>.
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.SearchResult.html#Hi_Common_SearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -682,7 +802,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -714,12 +834,12 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
</h3>
<div class="markdown level1 summary"><p>Get floor value by <code class="paramref">key</code>.
If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Common_BinarySearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
If return value is <a class="xref" href="Hi.Common.SearchResult.html#Hi_Common_SearchResult_NotExisted">NotExisted</a>, <code class="paramref">resultValue</code> will be the default value of <code class="typeparamref">V</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, out int floorIndex, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetFloor&lt;TKey, V&gt;(this SortedList&lt;TKey, V&gt; src, TKey key, out V resultValue, out int floorIndex, int beginIndex = 0, int endIndex = -1) where TKey : IComparable&lt;TKey&gt;</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -746,7 +866,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>search result</p>
</dd>
</dl>
@@ -848,7 +968,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestIndex&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out int resultIndex, int beginIndex = 0, int endIndex = -1)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetNearestIndex&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out int resultIndex, int beginIndex = 0, int endIndex = -1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -872,7 +992,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
</dd>
</dl>
@@ -905,7 +1025,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestKey&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out double resultKey, int beginIndex = 0, int endIndex = -1)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetNearestKey&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out double resultKey, int beginIndex = 0, int endIndex = -1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -929,7 +1049,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
</dd>
</dl>
@@ -962,7 +1082,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BinarySearchResult GetNearestValue&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out V resultValue, int beginIndex = 0, int endIndex = -1)</code></pre>
<pre><code class="lang-csharp hljs">public static SearchResult GetNearestValue&lt;V&gt;(this SortedList&lt;double, V&gt; src, double key, out V resultValue, int beginIndex = 0, int endIndex = -1)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -986,7 +1106,7 @@ If return value is <a class="xref" href="Hi.Common.BinarySearchResult.html#Hi_Co
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>A value indicating whether an exact match was found, or the nearest floor/ceiling value.</p>
</dd>
</dl>
@@ -0,0 +1,798 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class SubList&lt;T&gt; | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class SubList&lt;T&gt; | HiAPI-C# 2025 ">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.Collections.SubList`1">
<h1 id="Hi_Common_Collections_SubList_1" data-uid="Hi.Common.Collections.SubList`1" class="text-break">
Class SubList&lt;T&gt;
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.Collections.html">Collections</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"></div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SubList&lt;T&gt; : IList&lt;T&gt;, ICollection&lt;T&gt;, IEnumerable&lt;T&gt;, IEnumerable</code></pre>
</div>
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
</dl>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">SubList&lt;T&gt;</span></div>
</dd>
</dl>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;T&gt;</div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection</a>&lt;T&gt;</div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a>&lt;T&gt;</div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_ToDotSplitedString__1_System_Collections_Generic_IEnumerable___0__">StringUtil.ToDotSplitedString&lt;T&gt;(IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetCeilBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetCeilIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__">ListUtil.GetCeilIndex&lt;Item, ItemKey&gt;(IList&lt;Item&gt;, ItemKey, Func&lt;Item, ItemKey, int&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndex__2_System_Collections_Generic_IList___1____0_System_Func___1___0__System_Int32__">ListUtil.GetCeilIndex&lt;TKey, Item&gt;(IList&lt;Item&gt;, TKey, Func&lt;Item, TKey&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeil__2_System_Collections_Generic_IList___1____0_System_Func___1___0____1__">ListUtil.GetCeil&lt;TKey, Item&gt;(IList&lt;Item&gt;, TKey, Func&lt;Item, TKey&gt;, out Item)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetFloorBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetFloorIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__">ListUtil.GetFloorIndex&lt;Item, ItemKey&gt;(IList&lt;Item&gt;, ItemKey, Func&lt;Item, ItemKey, int&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndex__2_System_Collections_Generic_IList___1____0_System_Func___1___0__System_Int32__">ListUtil.GetFloorIndex&lt;TKey, Item&gt;(IList&lt;Item&gt;, TKey, Func&lt;Item, TKey&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloor__2_System_Collections_Generic_IList___1____0_System_Func___1___0____1__">ListUtil.GetFloor&lt;TKey, Item&gt;(IList&lt;Item&gt;, TKey, Func&lt;Item, TKey&gt;, out Item)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetIndexBasedEnumerable__1_System_Collections_Generic_IList___0__">ListUtil.GetIndexBasedEnumerable&lt;TItem&gt;(IList&lt;TItem&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetIndexBasedEnumerable__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.GetIndexBasedEnumerable&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetIndexByBinarySearch__1_System_Collections_Generic_IList___0____0_">ListUtil.GetIndexByBinarySearch&lt;TItem&gt;(IList&lt;TItem&gt;, TItem)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetIndexByBinarySearch__1_System_Collections_Generic_IList___0____0_System_Collections_Generic_IComparer___0__">ListUtil.GetIndexByBinarySearch&lt;TItem&gt;(IList&lt;TItem&gt;, TItem, IComparer&lt;TItem&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetIndexByBinarySearch__2_System_Collections_Generic_IList___0____1_System_Func___1___0_System_Int32__">ListUtil.GetIndexByBinarySearch&lt;TItem, TSearch&gt;(IList&lt;TItem&gt;, TSearch, Func&lt;TSearch, TItem, int&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetNearestIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Double__System_Int32__">ListUtil.GetNearestIndex&lt;TItem, TItemKey&gt;(IList&lt;TItem&gt;, TItemKey, Func&lt;TItem, TItemKey, double&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetNearestIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Func___0___1_System_Double__System_Int32__">ListUtil.GetNearestIndex&lt;TItem, TItemKey&gt;(IList&lt;TItem&gt;, TItemKey, Func&lt;TItem, TItemKey, int&gt;, Func&lt;TItem, TItemKey, double&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetSubList__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.GetSubList&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_Swap__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.Swap&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Common_Collections_SubList_1__ctor_" data-uid="Hi.Common.Collections.SubList`1.#ctor*"></a>
<h3 id="Hi_Common_Collections_SubList_1__ctor_System_Collections_Generic_IList__0__System_Int32_System_Int32_" data-uid="Hi.Common.Collections.SubList`1.#ctor(System.Collections.Generic.IList{`0},System.Int32,System.Int32)">
SubList(IList&lt;T&gt;, int, int)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SubList(IList&lt;T&gt; source, int beginIndex, int endIndex)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;T&gt;</dt>
<dd></dd>
<dt><code>beginIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
<dt><code>endIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Common_Collections_SubList_1_Count_" data-uid="Hi.Common.Collections.SubList`1.Count*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Count" data-uid="Hi.Common.Collections.SubList`1.Count">
Count
</h3>
<div class="markdown level1 summary"><p>Gets the number of elements contained in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Count { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The number of elements contained in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_IsReadOnly_" data-uid="Hi.Common.Collections.SubList`1.IsReadOnly*"></a>
<h3 id="Hi_Common_Collections_SubList_1_IsReadOnly" data-uid="Hi.Common.Collections.SubList`1.IsReadOnly">
IsReadOnly
</h3>
<div class="markdown level1 summary"><p>Gets a value indicating whether the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> is read-only.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsReadOnly { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> is read-only; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_Item_" data-uid="Hi.Common.Collections.SubList`1.Item*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Item_System_Int32_" data-uid="Hi.Common.Collections.SubList`1.Item(System.Int32)">
this[int]
</h3>
<div class="markdown level1 summary"><p>Gets or sets the element at the specified index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public T this[int index] { get; set; }</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>index</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The zero-based index of the element to get or set.</p>
</dd>
</dl>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd><p>The element at the specified index.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
<dd><p><code class="paramref">index</code> is not a valid index in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt>
<dd><p>The property is set and the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a> is read-only.</p>
</dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Common_Collections_SubList_1_Add_" data-uid="Hi.Common.Collections.SubList`1.Add*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Add__0_" data-uid="Hi.Common.Collections.SubList`1.Add(`0)">
Add(T)
</h3>
<div class="markdown level1 summary"><p>Adds an item to the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Add(T item)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <span class="xref">T</span></dt>
<dd><p>The object to add to the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt>
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> is read-only.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_Clear_" data-uid="Hi.Common.Collections.SubList`1.Clear*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Clear" data-uid="Hi.Common.Collections.SubList`1.Clear">
Clear()
</h3>
<div class="markdown level1 summary"><p>Removes all items from the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Clear()</code></pre>
</div>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt>
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> is read-only.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_Contains_" data-uid="Hi.Common.Collections.SubList`1.Contains*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Contains__0_" data-uid="Hi.Common.Collections.SubList`1.Contains(`0)">
Contains(T)
</h3>
<div class="markdown level1 summary"><p>Determines whether the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> contains a specific value.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Contains(T item)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <span class="xref">T</span></dt>
<dd><p>The object to locate in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if <code class="paramref">item</code> is found in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_CopyTo_" data-uid="Hi.Common.Collections.SubList`1.CopyTo*"></a>
<h3 id="Hi_Common_Collections_SubList_1_CopyTo__0___System_Int32_" data-uid="Hi.Common.Collections.SubList`1.CopyTo(`0[],System.Int32)">
CopyTo(T[], int)
</h3>
<div class="markdown level1 summary"><p>Copies the elements of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> to an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.array">Array</a>, starting at a particular <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.array">Array</a> index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void CopyTo(T[] array, int arrayIndex)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>array</code> T[]</dt>
<dd><p>The one-dimensional <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.array">Array</a> that is the destination of the elements copied from <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>. The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.array">Array</a> must have zero-based indexing.</p>
</dd>
<dt><code>arrayIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The zero-based index in <code class="paramref">array</code> at which copying begins.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
<dd><p><code class="paramref">array</code> is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
<dd><p><code class="paramref">arrayIndex</code> is less than 0.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></dt>
<dd><p>The number of elements in the source <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> is greater than the available space from <code class="paramref">arrayIndex</code> to the end of the destination <code class="paramref">array</code>.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_GetEnumerator_" data-uid="Hi.Common.Collections.SubList`1.GetEnumerator*"></a>
<h3 id="Hi_Common_Collections_SubList_1_GetEnumerator" data-uid="Hi.Common.Collections.SubList`1.GetEnumerator">
GetEnumerator()
</h3>
<div class="markdown level1 summary"><p>Returns an enumerator that iterates through the collection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerator&lt;T&gt; GetEnumerator()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerator-1">IEnumerator</a>&lt;T&gt;</dt>
<dd><p>An enumerator that can be used to iterate through the collection.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_IndexOf_" data-uid="Hi.Common.Collections.SubList`1.IndexOf*"></a>
<h3 id="Hi_Common_Collections_SubList_1_IndexOf__0_" data-uid="Hi.Common.Collections.SubList`1.IndexOf(`0)">
IndexOf(T)
</h3>
<div class="markdown level1 summary"><p>Determines the index of a specific item in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int IndexOf(T item)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <span class="xref">T</span></dt>
<dd><p>The object to locate in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The index of <code class="paramref">item</code> if found in the list; otherwise, -1.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_Insert_" data-uid="Hi.Common.Collections.SubList`1.Insert*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Insert_System_Int32__0_" data-uid="Hi.Common.Collections.SubList`1.Insert(System.Int32,`0)">
Insert(int, T)
</h3>
<div class="markdown level1 summary"><p>Inserts an item to the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a> at the specified index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Insert(int index, T item)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>index</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The zero-based index at which <code class="paramref">item</code> should be inserted.</p>
</dd>
<dt><code>item</code> <span class="xref">T</span></dt>
<dd><p>The object to insert into the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
<dd><p><code class="paramref">index</code> is not a valid index in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt>
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a> is read-only.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_Remove_" data-uid="Hi.Common.Collections.SubList`1.Remove*"></a>
<h3 id="Hi_Common_Collections_SubList_1_Remove__0_" data-uid="Hi.Common.Collections.SubList`1.Remove(`0)">
Remove(T)
</h3>
<div class="markdown level1 summary"><p>Removes the first occurrence of a specific object from the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Remove(T item)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>item</code> <span class="xref">T</span></dt>
<dd><p>The object to remove from the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if <code class="paramref">item</code> was successfully removed from the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>. This method also returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if <code class="paramref">item</code> is not found in the original <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a>.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt>
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> is read-only.</p>
</dd>
</dl>
<a id="Hi_Common_Collections_SubList_1_RemoveAt_" data-uid="Hi.Common.Collections.SubList`1.RemoveAt*"></a>
<h3 id="Hi_Common_Collections_SubList_1_RemoveAt_System_Int32_" data-uid="Hi.Common.Collections.SubList`1.RemoveAt(System.Int32)">
RemoveAt(int)
</h3>
<div class="markdown level1 summary"><p>Removes the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a> item at the specified index.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void RemoveAt(int index)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>index</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The zero-based index of the item to remove.</p>
</dd>
</dl>
<h4 class="section">Exceptions</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
<dd><p><code class="paramref">index</code> is not a valid index in the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>.</p>
</dd>
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt>
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a> is read-only.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>
@@ -180,6 +180,12 @@ Class SynList&lt;T&gt;
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_ToDotSplitedString__1_System_Collections_Generic_IEnumerable___0__">StringUtil.ToDotSplitedString&lt;T&gt;(IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetCeilBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetCeilIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__">ListUtil.GetCeilIndex&lt;Item, ItemKey&gt;(IList&lt;Item&gt;, ItemKey, Func&lt;Item, ItemKey, int&gt;, out int)</a>
</div>
@@ -189,6 +195,12 @@ Class SynList&lt;T&gt;
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeil__2_System_Collections_Generic_IList___1____0_System_Func___1___0____1__">ListUtil.GetCeil&lt;TKey, Item&gt;(IList&lt;Item&gt;, TKey, Func&lt;Item, TKey&gt;, out Item)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetFloorBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetFloorIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__">ListUtil.GetFloorIndex&lt;Item, ItemKey&gt;(IList&lt;Item&gt;, ItemKey, Func&lt;Item, ItemKey, int&gt;, out int)</a>
</div>
@@ -219,6 +231,9 @@ Class SynList&lt;T&gt;
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetNearestIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Func___0___1_System_Double__System_Int32__">ListUtil.GetNearestIndex&lt;TItem, TItemKey&gt;(IList&lt;TItem&gt;, TItemKey, Func&lt;TItem, TItemKey, int&gt;, Func&lt;TItem, TItemKey, double&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetSubList__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.GetSubList&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_Swap__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.Swap&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
@@ -129,6 +129,10 @@ Classes
<dd><p>Utility class providing extension methods for SortedList operations.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Collections.SubList-1.html">SubList&lt;T&gt;</a></dt>
<dd></dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Collections.SynList-1.html">SynList&lt;T&gt;</a></dt>
<dd><p>Thread-safe List.</p>
@@ -143,12 +147,12 @@ Enums
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Collections.SortedListUtil.SearchMethod.html">SortedListUtil.SearchMethod</a></dt>
<dt><a class="xref" href="Hi.Common.Collections.SearchTargetMode.html">SearchTargetMode</a></dt>
<dd><p>Specifies the search method to use when looking for values in a sorted list.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.Collections.SortedListUtil.SeekDirection.html">SortedListUtil.SeekDirection</a></dt>
<dt><a class="xref" href="Hi.Common.Collections.SeekDirection.html">SeekDirection</a></dt>
<dd><p>Specifies the seek direction for sorted list operations.</p>
</dd>
</dl>
@@ -777,7 +777,7 @@ Used for defining segment of data in collections or arrays.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IndexSegment GetIndexSegment&lt;TData&gt;(IList&lt;TData&gt; steps, int startListIndex, int targetGroupIndex, Func&lt;TData, int?&gt; dataToGroupIndexFunc)</code></pre>
<pre><code class="lang-csharp hljs">public static IndexSegment GetIndexSegment&lt;TData&gt;(IList&lt;TData&gt; steps, int seekingStartListIndex, int targetGroupIndex, Func&lt;TData, int?&gt; dataToGroupIndexFunc)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -785,7 +785,7 @@ Used for defining segment of data in collections or arrays.</p>
<dt><code>steps</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;TData&gt;</dt>
<dd><p>The list of data items.</p>
</dd>
<dt><code>startListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dt><code>seekingStartListIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>The start step index for seeking.</p>
</dd>
<dt><code>targetGroupIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
@@ -2,11 +2,11 @@
<html>
<head>
<meta charset="utf-8">
<title>Enum BinarySearchResult | HiAPI-C# 2025 </title>
<title>Enum SearchResult | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum BinarySearchResult | HiAPI-C# 2025 ">
<meta name="title" content="Enum SearchResult | HiAPI-C# 2025 ">
<meta name="description" content="Represents the result of a binary search operation.">
<meta name="description" content="Represents the result of a search operation.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -84,13 +84,13 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Common.BinarySearchResult">
<article data-uid="Hi.Common.SearchResult">
<h1 id="Hi_Common_BinarySearchResult" data-uid="Hi.Common.BinarySearchResult" class="text-break">
Enum BinarySearchResult
<h1 id="Hi_Common_SearchResult" data-uid="Hi.Common.SearchResult" class="text-break">
Enum SearchResult
</h1>
<div class="facts text-secondary">
@@ -98,12 +98,12 @@ Enum BinarySearchResult
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents the result of a binary search operation.</p>
<div class="markdown summary"><p>Represents the result of a search operation.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum BinarySearchResult</code></pre>
<pre><code class="lang-csharp hljs">public enum SearchResult</code></pre>
</div>
@@ -145,19 +145,19 @@ Enum BinarySearchResult
<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="Hi_Common_BinarySearchResult_CriticalFound"><code>CriticalFound = 2</code></dt>
<dt id="Hi_Common_SearchResult_CriticalFound"><code>CriticalFound = 2</code></dt>
<dd><p>Indicates that an exact match was found.</p>
</dd>
<dt id="Hi_Common_BinarySearchResult_FoundCeil"><code>FoundCeil = 8</code></dt>
<dt id="Hi_Common_SearchResult_FoundCeil"><code>FoundCeil = 8</code></dt>
<dd><p>Indicates that a value greater than to the target was found.</p>
</dd>
<dt id="Hi_Common_BinarySearchResult_FoundFloor"><code>FoundFloor = 4</code></dt>
<dt id="Hi_Common_SearchResult_FoundFloor"><code>FoundFloor = 4</code></dt>
<dd><p>Indicates that a value less than to the target was found.</p>
</dd>
<dt id="Hi_Common_BinarySearchResult_NotExisted"><code>NotExisted = 1</code></dt>
<dt id="Hi_Common_SearchResult_NotExisted"><code>NotExisted = 1</code></dt>
<dd><p>Indicates that the target value does not exist in the collection.</p>
</dd>
+2 -2
View File
@@ -362,8 +362,8 @@ Generally used to suggest a name when generating or saving files.</p>
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Common.BinarySearchResult.html">BinarySearchResult</a></dt>
<dd><p>Represents the result of a binary search operation.</p>
<dt><a class="xref" href="Hi.Common.SearchResult.html">SearchResult</a></dt>
<dd><p>Represents the result of a search operation.</p>
</dd>
</dl>
<h3 id="delegates">
@@ -219,6 +219,12 @@ Class DispList
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_ToDotSplitedString__1_System_Collections_Generic_IEnumerable___0__">StringUtil.ToDotSplitedString&lt;T&gt;(IEnumerable&lt;T&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetCeilBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetCeilIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeilIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__">ListUtil.GetCeilIndex&lt;Item, ItemKey&gt;(IList&lt;Item&gt;, ItemKey, Func&lt;Item, ItemKey, int&gt;, out int)</a>
</div>
@@ -228,6 +234,12 @@ Class DispList
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetCeil__2_System_Collections_Generic_IList___1____0_System_Func___1___0____1__">ListUtil.GetCeil&lt;TKey, Item&gt;(IList&lt;Item&gt;, TKey, Func&lt;Item, TKey&gt;, out Item)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1____0__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetFloorBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out TItem, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndexBySeek__2_System_Collections_Generic_IList___0____1_System_Func___0___1__System_Int32__System_Int32_Hi_Common_Collections_SeekDirection_">ListUtil.GetFloorIndexBySeek&lt;TItem, TKey&gt;(IList&lt;TItem&gt;, TKey, Func&lt;TItem, TKey&gt;, out int, int, SeekDirection)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetFloorIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Int32__">ListUtil.GetFloorIndex&lt;Item, ItemKey&gt;(IList&lt;Item&gt;, ItemKey, Func&lt;Item, ItemKey, int&gt;, out int)</a>
</div>
@@ -258,6 +270,9 @@ Class DispList
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetNearestIndex__2_System_Collections_Generic_IList___0____1_System_Func___0___1_System_Int32__System_Func___0___1_System_Double__System_Int32__">ListUtil.GetNearestIndex&lt;TItem, TItemKey&gt;(IList&lt;TItem&gt;, TItemKey, Func&lt;TItem, TItemKey, int&gt;, Func&lt;TItem, TItemKey, double&gt;, out int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_GetSubList__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.GetSubList&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
<div>
<a class="xref" href="Hi.Common.Collections.ListUtil.html#Hi_Common_Collections_ListUtil_Swap__1_System_Collections_Generic_IList___0__System_Int32_System_Int32_">ListUtil.Swap&lt;TItem&gt;(IList&lt;TItem&gt;, int, int)</a>
</div>
@@ -263,7 +263,8 @@ public double DiffVisualRadius_mm { get; set; }</code></pre>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long DispCacheMb { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete]
public long DispCacheMb { get; set; }</code></pre>
</div>
@@ -818,8 +819,7 @@ public IMachiningMotionResolution MachiningMotionResolution { get; set; }</code>
</h3>
<div class="markdown level1 summary"><p>Gets or sets the machining resolution in millimeters.
For legacy compatable.</p>
<div class="markdown level1 summary"><p>Gets or sets the machining resolution in millimeters.</p>
</div>
<div class="markdown level1 conceptual"></div>
@@ -2699,7 +2699,7 @@ public void LoadCuttingParaByFile(string relFile)</code></pre>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;MapByActualTime($1timeShotRelFile)&quot;)]
<pre><code class="lang-csharp hljs">[Obsolete]
public void MapByActualTime(string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode = CycleSamplingMode.SpindleCycle)</code></pre>
</div>
@@ -2724,6 +2724,78 @@ public void MapByActualTime(string timeShotRelFile, StepTimeShotUtil.CycleSampli
<a id="Hi_MachiningProcs_RuntimeApi_MapSeriesByCsvFile_" data-uid="Hi.MachiningProcs.RuntimeApi.MapSeriesByCsvFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MapSeriesByCsvFile_System_String_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_" data-uid="Hi.MachiningProcs.RuntimeApi.MapSeriesByCsvFile(System.String,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode)">
MapSeriesByCsvFile(string, CycleSamplingMode)
</h3>
<div class="markdown level1 summary"><p>Maps machining steps by actual time from a time shot csv file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(&quot;MapSeriesByCsvFile($1timeShotRelFile)&quot;)]
public void MapSeriesByCsvFile(string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode = CycleSamplingMode.SpindleCycle)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>timeShotRelFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Relative path to the time shot file.</p>
</dd>
<dt><code>cycleSamplingMode</code> <a class="xref" href="Hi.Mapping.StepTimeShotUtil.html">StepTimeShotUtil</a>.<a class="xref" href="Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html">CycleSamplingMode</a></dt>
<dd><p>The cycle sampling mode.</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_MapSingleByCsvFile_" data-uid="Hi.MachiningProcs.RuntimeApi.MapSingleByCsvFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_MapSingleByCsvFile_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.MapSingleByCsvFile(System.String)">
MapSingleByCsvFile(string)
</h3>
<div class="markdown level1 summary"><p>Reads a CSV file and performs time-based interpolation to map data to milling steps.
It is one (step) - one (embedded-data) mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;MapSingleByCsvFile($1\&quot;csvFile\&quot;)&quot;)]
public void MapSingleByCsvFile(string csvFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>csvFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Path to the CSV file relative to the base directory</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeApi_Message_" data-uid="Hi.MachiningProcs.RuntimeApi.Message*"></a>
<h3 id="Hi_MachiningProcs_RuntimeApi_Message_System_String_" data-uid="Hi.MachiningProcs.RuntimeApi.Message(System.String)">
@@ -3223,12 +3295,13 @@ public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double
</h3>
<div class="markdown level1 summary"><p>Reads a CSV file and performs time-based interpolation to map data to milling steps.</p>
<div class="markdown level1 summary"><p>Reads a CSV file and performs time-based interpolation to map data to milling steps.
It is one (step) - one (embedded-data) mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;ReadCsvByTimeInterpolation($1\&quot;csvFile\&quot;)&quot;)]
<pre><code class="lang-csharp hljs">[Obsolete]
public void ReadCsvByTimeInterpolation(string csvFile)</code></pre>
</div>
@@ -789,7 +789,8 @@ public double DiffVisualRadius_mm { get; set; }</code></pre>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long DispCacheMb { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">[Obsolete]
public long DispCacheMb { get; set; }</code></pre>
</div>
@@ -2701,6 +2702,42 @@ public void Diff(double detectionRadius_mm)</code></pre>
<a id="Hi_MachiningProcs_RuntimeController_EmbedSingleDataPerStepByCsvFile_" data-uid="Hi.MachiningProcs.RuntimeController.EmbedSingleDataPerStepByCsvFile*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_EmbedSingleDataPerStepByCsvFile_System_String_" data-uid="Hi.MachiningProcs.RuntimeController.EmbedSingleDataPerStepByCsvFile(System.String)">
EmbedSingleDataPerStepByCsvFile(string)
</h3>
<div class="markdown level1 summary"><p>Reads a CSV file and performs time-based interpolation to map data to milling steps.
It is one (step) - one (embedded-data) mapping.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;EmbedSingleDataPerStepByCsvFile($1\&quot;csvFile\&quot;)&quot;)]
[HttpPost]
public void EmbedSingleDataPerStepByCsvFile(string csvFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>csvFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Path to the CSV file relative to the base directory</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeController_EndPreserve_" data-uid="Hi.MachiningProcs.RuntimeController.EndPreserve*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_EndPreserve" data-uid="Hi.MachiningProcs.RuntimeController.EndPreserve">
@@ -3549,41 +3586,6 @@ public void ReTrainMillingPara(SampleFlag sampleFlag, string dstRelFile, double
<a id="Hi_MachiningProcs_RuntimeController_ReadCsvByTimeInterpolation_" data-uid="Hi.MachiningProcs.RuntimeController.ReadCsvByTimeInterpolation*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_ReadCsvByTimeInterpolation_System_String_" data-uid="Hi.MachiningProcs.RuntimeController.ReadCsvByTimeInterpolation(System.String)">
ReadCsvByTimeInterpolation(string)
</h3>
<div class="markdown level1 summary"><p>Reads a CSV file and performs time-based interpolation to map data to milling steps.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[JsAce(Snippet = &quot;ReadCsvByTimeInterpolation($1\&quot;csvFile\&quot;)&quot;)]
[HttpPost]
public void ReadCsvByTimeInterpolation(string csvFile)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>csvFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Path to the CSV file relative to the base directory</p>
</dd>
</dl>
<a id="Hi_MachiningProcs_RuntimeController_ReadRuntimeGeom_" data-uid="Hi.MachiningProcs.RuntimeController.ReadRuntimeGeom*"></a>
<h3 id="Hi_MachiningProcs_RuntimeController_ReadRuntimeGeom_System_String_" data-uid="Hi.MachiningProcs.RuntimeController.ReadRuntimeGeom(System.String)">
@@ -1,179 +0,0 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Enum CsvNcStep.StepInterpoationMode | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Enum CsvNcStep.StepInterpoationMode | HiAPI-C# 2025 ">
<meta name="description" content="Defines the interpolation modes for step interpolation.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Mapping.CsvNcStep.StepInterpoationMode">
<h1 id="Hi_Mapping_CsvNcStep_StepInterpoationMode" data-uid="Hi.Mapping.CsvNcStep.StepInterpoationMode" class="text-break">
Enum CsvNcStep.StepInterpoationMode
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Mapping.html">Mapping</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Defines the interpolation modes for step interpolation.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum CsvNcStep.StepInterpoationMode</code></pre>
</div>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.MaskUtil.html#Hi_Common_MaskUtil_GetMaskedValue__1___0___0_System_Boolean_">MaskUtil.GetMaskedValue&lt;T&gt;(T, T, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Common.MaskUtil.html#Hi_Common_MaskUtil_SetMask__1___0____0_System_Boolean_">MaskUtil.SetMask&lt;T&gt;(ref T, T, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 id="fields">Fields
</h2>
<dl class="parameters">
<dt id="Hi_Mapping_CsvNcStep_StepInterpoationMode_InterpolateByTime"><code>InterpolateByTime = 0</code></dt>
<dd><p>Interpolate steps based on time values.</p>
</dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>
@@ -232,6 +232,70 @@ Class CsvNcStep
</h2>
<a id="Hi_Mapping_CsvNcStep_ActualTime_" data-uid="Hi.Mapping.CsvNcStep.ActualTime*"></a>
<h3 id="Hi_Mapping_CsvNcStep_ActualTime" data-uid="Hi.Mapping.CsvNcStep.ActualTime">
ActualTime
</h3>
<div class="markdown level1 summary"><p>Gets or sets the time value for this step.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan ActualTime { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd></dd>
</dl>
<a id="Hi_Mapping_CsvNcStep_ActualTimeTag_" data-uid="Hi.Mapping.CsvNcStep.ActualTimeTag*"></a>
<h3 id="Hi_Mapping_CsvNcStep_ActualTimeTag" data-uid="Hi.Mapping.CsvNcStep.ActualTimeTag">
ActualTimeTag
</h3>
<div class="markdown level1 summary"><p>Gets or sets the column title for time in the CSV.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string ActualTimeTag { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<a id="Hi_Mapping_CsvNcStep_DoubleFlexList_" data-uid="Hi.Mapping.CsvNcStep.DoubleFlexList*"></a>
<h3 id="Hi_Mapping_CsvNcStep_DoubleFlexList" data-uid="Hi.Mapping.CsvNcStep.DoubleFlexList">
@@ -296,10 +360,10 @@ Class CsvNcStep
<a id="Hi_Mapping_CsvNcStep_FileNoTitle_" data-uid="Hi.Mapping.CsvNcStep.FileNoTitle*"></a>
<a id="Hi_Mapping_CsvNcStep_FileNoTag_" data-uid="Hi.Mapping.CsvNcStep.FileNoTag*"></a>
<h3 id="Hi_Mapping_CsvNcStep_FileNoTitle" data-uid="Hi.Mapping.CsvNcStep.FileNoTitle">
FileNoTitle
<h3 id="Hi_Mapping_CsvNcStep_FileNoTag" data-uid="Hi.Mapping.CsvNcStep.FileNoTag">
FileNoTag
</h3>
@@ -308,7 +372,7 @@ Class CsvNcStep
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string FileNoTitle { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public static string FileNoTag { get; set; }</code></pre>
</div>
@@ -328,10 +392,10 @@ Class CsvNcStep
<a id="Hi_Mapping_CsvNcStep_LineNoTitle_" data-uid="Hi.Mapping.CsvNcStep.LineNoTitle*"></a>
<a id="Hi_Mapping_CsvNcStep_LineNoTag_" data-uid="Hi.Mapping.CsvNcStep.LineNoTag*"></a>
<h3 id="Hi_Mapping_CsvNcStep_LineNoTitle" data-uid="Hi.Mapping.CsvNcStep.LineNoTitle">
LineNoTitle
<h3 id="Hi_Mapping_CsvNcStep_LineNoTag" data-uid="Hi.Mapping.CsvNcStep.LineNoTag">
LineNoTag
</h3>
@@ -340,7 +404,7 @@ Class CsvNcStep
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string LineNoTitle { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public static string LineNoTag { get; set; }</code></pre>
</div>
@@ -360,10 +424,10 @@ Class CsvNcStep
<a id="Hi_Mapping_CsvNcStep_McTitle_" data-uid="Hi.Mapping.CsvNcStep.McTitle*"></a>
<a id="Hi_Mapping_CsvNcStep_McTag_" data-uid="Hi.Mapping.CsvNcStep.McTag*"></a>
<h3 id="Hi_Mapping_CsvNcStep_McTitle" data-uid="Hi.Mapping.CsvNcStep.McTitle">
McTitle
<h3 id="Hi_Mapping_CsvNcStep_McTag" data-uid="Hi.Mapping.CsvNcStep.McTag">
McTag
</h3>
@@ -372,7 +436,7 @@ Class CsvNcStep
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string McTitle { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public static string McTag { get; set; }</code></pre>
</div>
@@ -424,119 +488,10 @@ Class CsvNcStep
<a id="Hi_Mapping_CsvNcStep_Time_" data-uid="Hi.Mapping.CsvNcStep.Time*"></a>
<h3 id="Hi_Mapping_CsvNcStep_Time" data-uid="Hi.Mapping.CsvNcStep.Time">
Time
</h3>
<div class="markdown level1 summary"><p>Gets or sets the time value for this step.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TimeSpan Time { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.timespan">TimeSpan</a></dt>
<dd></dd>
</dl>
<a id="Hi_Mapping_CsvNcStep_TimeTagTitle_" data-uid="Hi.Mapping.CsvNcStep.TimeTagTitle*"></a>
<h3 id="Hi_Mapping_CsvNcStep_TimeTagTitle" data-uid="Hi.Mapping.CsvNcStep.TimeTagTitle">
TimeTagTitle
</h3>
<div class="markdown level1 summary"><p>Gets or sets the column title for time in the CSV.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string TimeTagTitle { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Mapping_CsvNcStep_BuildByFile_" data-uid="Hi.Mapping.CsvNcStep.BuildByFile*"></a>
<h3 id="Hi_Mapping_CsvNcStep_BuildByFile_Hi_CutterLocations_ClStrips_ClStrip_System_String_System_String_Hi_Common_Messages_IMessageHost_Hi_Mapping_CsvNcStep_StepInterpoationMode_" data-uid="Hi.Mapping.CsvNcStep.BuildByFile(Hi.CutterLocations.ClStrips.ClStrip,System.String,System.String,Hi.Common.Messages.IMessageHost,Hi.Mapping.CsvNcStep.StepInterpoationMode)">
BuildByFile(ClStrip, string, string, IMessageHost, StepInterpoationMode)
</h3>
<div class="markdown level1 summary"><p>Builds a collection of CsvNcStep instances from a CSV file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void BuildByFile(ClStrip clStrip, string baseDirectory, string relPath, IMessageHost messageHost, CsvNcStep.StepInterpoationMode stepInterpoationMode)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
<dd><p>The cutter location strip to populate.</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for the file path.</p>
</dd>
<dt><code>relPath</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative path to the CSV file.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging.</p>
</dd>
<dt><code>stepInterpoationMode</code> <a class="xref" href="Hi.Mapping.CsvNcStep.html">CsvNcStep</a>.<a class="xref" href="Hi.Mapping.CsvNcStep.StepInterpoationMode.html">StepInterpoationMode</a></dt>
<dd><p>The interpolation mode to use.</p>
</dd>
</dl>
<a id="Hi_Mapping_CsvNcStep_GetFileLineIndex_" data-uid="Hi.Mapping.CsvNcStep.GetFileLineIndex*"></a>
<h3 id="Hi_Mapping_CsvNcStep_GetFileLineIndex" data-uid="Hi.Mapping.CsvNcStep.GetFileLineIndex">
@@ -570,6 +525,51 @@ Class CsvNcStep
<a id="Hi_Mapping_CsvNcStep_MapSingleByCsvFile_" data-uid="Hi.Mapping.CsvNcStep.MapSingleByCsvFile*"></a>
<h3 id="Hi_Mapping_CsvNcStep_MapSingleByCsvFile_Hi_CutterLocations_ClStrips_ClStrip_System_String_System_String_Hi_Common_Messages_IMessageHost_" data-uid="Hi.Mapping.CsvNcStep.MapSingleByCsvFile(Hi.CutterLocations.ClStrips.ClStrip,System.String,System.String,Hi.Common.Messages.IMessageHost)">
MapSingleByCsvFile(ClStrip, string, string, IMessageHost)
</h3>
<div class="markdown level1 summary"><p>Embed single data per step by CSV file.
It is one (step) - one (embedded-data) mapping.
Time interpolation is applied. It is time-based mapping.
Builds a collection of CsvNcStep instances from a CSV file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void MapSingleByCsvFile(ClStrip clStrip, string baseDirectory, string relFile, IMessageHost messageHost)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>clStrip</code> <a class="xref" href="Hi.CutterLocations.ClStrips.ClStrip.html">ClStrip</a></dt>
<dd><p>The cutter location strip to populate.</p>
</dd>
<dt><code>baseDirectory</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The base directory for the file path.</p>
</dd>
<dt><code>relFile</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The relative file path to the CSV file.</p>
</dd>
<dt><code>messageHost</code> <a class="xref" href="Hi.Common.Messages.IMessageHost.html">IMessageHost</a></dt>
<dd><p>The message host for logging.</p>
</dd>
</dl>
<h2 class="section" id="operators">Operators
</h2>
@@ -6,7 +6,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class TimeMapping | HiAPI-C# 2025 ">
<meta name="description" content="Provides mapping between machining steps and time-based measurements (shots),">
<meta name="description" content="Provides mapping between machining steps and time-based measurements (shots). It is one step to many data mapping (one-many).">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
@@ -97,7 +97,8 @@ Class TimeMapping
<dl><dt>Assembly</dt><dd>HiMech.dll</dd></dl>
</div>
<div class="markdown summary"><p>Provides mapping between machining steps and time-based measurements (shots),</p>
<div class="markdown summary"><p>Provides mapping between machining steps and time-based measurements (shots).
It is one step to many data mapping (one-many).</p>
</div>
<div class="markdown conceptual"></div>
@@ -812,10 +813,10 @@ This method is thread-safe and can be called concurrently.</p>
<a id="Hi_Mapping_TimeMapping_MapByActualTime_" data-uid="Hi.Mapping.TimeMapping.MapByActualTime*"></a>
<a id="Hi_Mapping_TimeMapping_MapSeriesByActualTime_" data-uid="Hi.Mapping.TimeMapping.MapSeriesByActualTime*"></a>
<h3 id="Hi_Mapping_TimeMapping_MapByActualTime_System_String_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_Hi_CutterLocations_ClStrips_ClStrip_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.MapByActualTime(System.String,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,Hi.CutterLocations.ClStrips.ClStrip,Hi.Common.Messages.IMessageHost,System.Nullable{System.Threading.CancellationToken})">
MapByActualTime(string, CycleSamplingMode, ClStrip, IMessageHost, CancellationToken?)
<h3 id="Hi_Mapping_TimeMapping_MapSeriesByActualTime_System_String_Hi_Mapping_StepTimeShotUtil_CycleSamplingMode_Hi_CutterLocations_ClStrips_ClStrip_Hi_Common_Messages_IMessageHost_System_Nullable_System_Threading_CancellationToken__" data-uid="Hi.Mapping.TimeMapping.MapSeriesByActualTime(System.String,Hi.Mapping.StepTimeShotUtil.CycleSamplingMode,Hi.CutterLocations.ClStrips.ClStrip,Hi.Common.Messages.IMessageHost,System.Nullable{System.Threading.CancellationToken})">
MapSeriesByActualTime(string, CycleSamplingMode, ClStrip, IMessageHost, CancellationToken?)
</h3>
@@ -824,7 +825,7 @@ This method is thread-safe and can be called concurrently.</p>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void MapByActualTime(string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, ClStrip clStrip, IMessageHost messageHost, CancellationToken? cancellationToken = null)</code></pre>
<pre><code class="lang-csharp hljs">public void MapSeriesByActualTime(string timeShotRelFile, StepTimeShotUtil.CycleSamplingMode cycleSamplingMode, ClStrip clStrip, IMessageHost messageHost, CancellationToken? cancellationToken = null)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -112,7 +112,8 @@ This class manages the loading and caching of time shot data from measurement fi
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Mapping.TimeMapping.html">TimeMapping</a></dt>
<dd><p>Provides mapping between machining steps and time-based measurements (shots),</p>
<dd><p>Provides mapping between machining steps and time-based measurements (shots).
It is one step to many data mapping (one-many).</p>
</dd>
</dl>
<h3 id="interfaces">
@@ -145,11 +146,6 @@ This interface provides a foundation for time-series data with vector operations
<h3 id="enums">
Enums
</h3>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Mapping.CsvNcStep.StepInterpoationMode.html">CsvNcStep.StepInterpoationMode</a></dt>
<dd><p>Defines the interpolation modes for step interpolation.</p>
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Mapping.StepTimeShotUtil.CycleSamplingMode.html">StepTimeShotUtil.CycleSamplingMode</a></dt>
<dd><p>Defines the cycle sampling modes for mapping time shots to machining steps.
@@ -247,6 +247,37 @@ Class DistributedQueueTaskStarter
<a id="Hi_Parallels_DistributedQueueTaskStarter_ThreadPriority_" data-uid="Hi.Parallels.DistributedQueueTaskStarter.ThreadPriority*"></a>
<h3 id="Hi_Parallels_DistributedQueueTaskStarter_ThreadPriority" data-uid="Hi.Parallels.DistributedQueueTaskStarter.ThreadPriority">
ThreadPriority
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ThreadPriority ThreadPriority { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.threadpriority">ThreadPriority</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
@@ -2,9 +2,9 @@
<html>
<head>
<meta charset="utf-8">
<title>Class PriorityBasedTaskScheduler | HiAPI-C# 2025 </title>
<title>Class PriorityTaskScheduler | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class PriorityBasedTaskScheduler | HiAPI-C# 2025 ">
<meta name="title" content="Class PriorityTaskScheduler | HiAPI-C# 2025 ">
<meta name="description" content="A task scheduler that executes tasks with a specified thread priority.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
@@ -84,12 +84,12 @@
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Parallels.PriorityBasedTaskScheduler">
<article data-uid="Hi.Parallels.PriorityTaskScheduler">
<h1 id="Hi_Parallels_PriorityBasedTaskScheduler" data-uid="Hi.Parallels.PriorityBasedTaskScheduler" class="text-break">
Class PriorityBasedTaskScheduler
<h1 id="Hi_Parallels_PriorityTaskScheduler" data-uid="Hi.Parallels.PriorityTaskScheduler" class="text-break">
Class PriorityTaskScheduler
</h1>
<div class="facts text-secondary">
@@ -102,7 +102,7 @@ Class PriorityBasedTaskScheduler
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PriorityBasedTaskScheduler : TaskScheduler</code></pre>
<pre><code class="lang-csharp hljs">public class PriorityTaskScheduler : TaskScheduler</code></pre>
</div>
@@ -113,7 +113,7 @@ Class PriorityBasedTaskScheduler
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler">TaskScheduler</a></div>
<div><span class="xref">PriorityBasedTaskScheduler</span></div>
<div><span class="xref">PriorityTaskScheduler</span></div>
</dd>
</dl>
@@ -203,10 +203,10 @@ Class PriorityBasedTaskScheduler
</h2>
<a id="Hi_Parallels_PriorityBasedTaskScheduler__ctor_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.#ctor*"></a>
<a id="Hi_Parallels_PriorityTaskScheduler__ctor_" data-uid="Hi.Parallels.PriorityTaskScheduler.#ctor*"></a>
<h3 id="Hi_Parallels_PriorityBasedTaskScheduler__ctor_System_Threading_ThreadPriority_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.#ctor(System.Threading.ThreadPriority)">
PriorityBasedTaskScheduler(ThreadPriority)
<h3 id="Hi_Parallels_PriorityTaskScheduler__ctor_System_Threading_ThreadPriority_" data-uid="Hi.Parallels.PriorityTaskScheduler.#ctor(System.Threading.ThreadPriority)">
PriorityTaskScheduler(ThreadPriority)
</h3>
@@ -215,7 +215,7 @@ Class PriorityBasedTaskScheduler
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PriorityBasedTaskScheduler(ThreadPriority threadPriority)</code></pre>
<pre><code class="lang-csharp hljs">public PriorityTaskScheduler(ThreadPriority threadPriority)</code></pre>
</div>
<h4 class="section">Parameters</h4>
@@ -240,9 +240,9 @@ Class PriorityBasedTaskScheduler
</h2>
<a id="Hi_Parallels_PriorityBasedTaskScheduler_MaxDegreeOfParallelism_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.MaxDegreeOfParallelism*"></a>
<a id="Hi_Parallels_PriorityTaskScheduler_MaxDegreeOfParallelism_" data-uid="Hi.Parallels.PriorityTaskScheduler.MaxDegreeOfParallelism*"></a>
<h3 id="Hi_Parallels_PriorityBasedTaskScheduler_MaxDegreeOfParallelism" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.MaxDegreeOfParallelism">
<h3 id="Hi_Parallels_PriorityTaskScheduler_MaxDegreeOfParallelism" data-uid="Hi.Parallels.PriorityTaskScheduler.MaxDegreeOfParallelism">
MaxDegreeOfParallelism
</h3>
@@ -273,9 +273,9 @@ Set special value 0 for no limiting.</p>
<a id="Hi_Parallels_PriorityBasedTaskScheduler_ThreadPriority_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.ThreadPriority*"></a>
<a id="Hi_Parallels_PriorityTaskScheduler_ThreadPriority_" data-uid="Hi.Parallels.PriorityTaskScheduler.ThreadPriority*"></a>
<h3 id="Hi_Parallels_PriorityBasedTaskScheduler_ThreadPriority" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.ThreadPriority">
<h3 id="Hi_Parallels_PriorityTaskScheduler_ThreadPriority" data-uid="Hi.Parallels.PriorityTaskScheduler.ThreadPriority">
ThreadPriority
</h3>
@@ -309,9 +309,9 @@ Set special value 0 for no limiting.</p>
</h2>
<a id="Hi_Parallels_PriorityBasedTaskScheduler_GetScheduledTasks_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.GetScheduledTasks*"></a>
<a id="Hi_Parallels_PriorityTaskScheduler_GetScheduledTasks_" data-uid="Hi.Parallels.PriorityTaskScheduler.GetScheduledTasks*"></a>
<h3 id="Hi_Parallels_PriorityBasedTaskScheduler_GetScheduledTasks" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.GetScheduledTasks">
<h3 id="Hi_Parallels_PriorityTaskScheduler_GetScheduledTasks" data-uid="Hi.Parallels.PriorityTaskScheduler.GetScheduledTasks">
GetScheduledTasks()
</h3>
@@ -348,9 +348,9 @@ Set special value 0 for no limiting.</p>
<a id="Hi_Parallels_PriorityBasedTaskScheduler_QueueTask_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.QueueTask*"></a>
<a id="Hi_Parallels_PriorityTaskScheduler_QueueTask_" data-uid="Hi.Parallels.PriorityTaskScheduler.QueueTask*"></a>
<h3 id="Hi_Parallels_PriorityBasedTaskScheduler_QueueTask_System_Threading_Tasks_Task_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.QueueTask(System.Threading.Tasks.Task)">
<h3 id="Hi_Parallels_PriorityTaskScheduler_QueueTask_System_Threading_Tasks_Task_" data-uid="Hi.Parallels.PriorityTaskScheduler.QueueTask(System.Threading.Tasks.Task)">
QueueTask(Task)
</h3>
@@ -387,9 +387,9 @@ Set special value 0 for no limiting.</p>
<a id="Hi_Parallels_PriorityBasedTaskScheduler_TryExecuteTaskInline_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.TryExecuteTaskInline*"></a>
<a id="Hi_Parallels_PriorityTaskScheduler_TryExecuteTaskInline_" data-uid="Hi.Parallels.PriorityTaskScheduler.TryExecuteTaskInline*"></a>
<h3 id="Hi_Parallels_PriorityBasedTaskScheduler_TryExecuteTaskInline_System_Threading_Tasks_Task_System_Boolean_" data-uid="Hi.Parallels.PriorityBasedTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)">
<h3 id="Hi_Parallels_PriorityTaskScheduler_TryExecuteTaskInline_System_Threading_Tasks_Task_System_Boolean_" data-uid="Hi.Parallels.PriorityTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)">
TryExecuteTaskInline(Task, bool)
</h3>
@@ -116,7 +116,7 @@ Allows for controlled execution of tasks with a specified maximum concurrency le
</dd>
</dl>
<dl class="jumplist">
<dt><a class="xref" href="Hi.Parallels.PriorityBasedTaskScheduler.html">PriorityBasedTaskScheduler</a></dt>
<dt><a class="xref" href="Hi.Parallels.PriorityTaskScheduler.html">PriorityTaskScheduler</a></dt>
<dd><p>A task scheduler that executes tasks with a specified thread priority.</p>
</dd>
</dl>
+11 -11
View File
@@ -219,9 +219,6 @@
<li>
<a href="Hi.Common.BinIoUtil.html" name="" title="BinIoUtil">BinIoUtil</a>
</li>
<li>
<a href="Hi.Common.BinarySearchResult.html" name="" title="BinarySearchResult">BinarySearchResult</a>
</li>
<li>
<a href="Hi.Common.BitUtil.html" name="" title="BitUtil">BitUtil</a>
</li>
@@ -351,6 +348,9 @@
<li>
<a href="Hi.Common.RoutineBlocker0.html" name="" title="RoutineBlocker0">RoutineBlocker0</a>
</li>
<li>
<a href="Hi.Common.SearchResult.html" name="" title="SearchResult">SearchResult</a>
</li>
<li>
<a href="Hi.Common.SeqPairUtil.html" name="" title="SeqPairUtil">SeqPairUtil</a>
</li>
@@ -403,14 +403,17 @@
<li>
<a href="Hi.Common.Collections.ListUtil.OuterPolationMode.html" name="" title="ListUtil.OuterPolationMode">ListUtil.OuterPolationMode</a>
</li>
<li>
<a href="Hi.Common.Collections.SearchTargetMode.html" name="" title="SearchTargetMode">SearchTargetMode</a>
</li>
<li>
<a href="Hi.Common.Collections.SeekDirection.html" name="" title="SeekDirection">SeekDirection</a>
</li>
<li>
<a href="Hi.Common.Collections.SortedListUtil.html" name="" title="SortedListUtil">SortedListUtil</a>
</li>
<li>
<a href="Hi.Common.Collections.SortedListUtil.SearchMethod.html" name="" title="SortedListUtil.SearchMethod">SortedListUtil.SearchMethod</a>
</li>
<li>
<a href="Hi.Common.Collections.SortedListUtil.SeekDirection.html" name="" title="SortedListUtil.SeekDirection">SortedListUtil.SeekDirection</a>
<a href="Hi.Common.Collections.SubList-1.html" name="" title="SubList&lt;T&gt;">SubList&lt;T&gt;</a>
</li>
<li>
<a href="Hi.Common.Collections.SynList-1.html" name="" title="SynList&lt;T&gt;">SynList&lt;T&gt;</a>
@@ -1379,9 +1382,6 @@
<li>
<a href="Hi.Mapping.CsvNcStep.html" name="" title="CsvNcStep">CsvNcStep</a>
</li>
<li>
<a href="Hi.Mapping.CsvNcStep.StepInterpoationMode.html" name="" title="CsvNcStep.StepInterpoationMode">CsvNcStep.StepInterpoationMode</a>
</li>
<li>
<a href="Hi.Mapping.FileToTimeShotMapping.html" name="" title="FileToTimeShotMapping">FileToTimeShotMapping</a>
</li>
@@ -2840,7 +2840,7 @@
<a href="Hi.Parallels.LockUtil.html" name="" title="LockUtil">LockUtil</a>
</li>
<li>
<a href="Hi.Parallels.PriorityBasedTaskScheduler.html" name="" title="PriorityBasedTaskScheduler">PriorityBasedTaskScheduler</a>
<a href="Hi.Parallels.PriorityTaskScheduler.html" name="" title="PriorityTaskScheduler">PriorityTaskScheduler</a>
</li>
<li>
<a href="Hi.Parallels.QueueTaskScheduler.html" name="" title="QueueTaskScheduler">QueueTaskScheduler</a>
File diff suppressed because one or more lines are too long