Files
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.StackExtensions.html
Tig Kindel 26d2353e40 Prep for Release v1.7.0 (#1910)
* prepping for v1.7 release

* Updated release notes for v1.7

* updated rel notes

* regen docs

* trying to fix view source

* reactive ui update
2022-07-28 05:39:06 -07:00

539 lines
20 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class StackExtensions
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class StackExtensions
">
<meta name="generator" content="docfx 2.59.3.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.StackExtensions">
<h1 id="Terminal_Gui_StackExtensions" data-uid="Terminal.Gui.StackExtensions" class="text-break">Class StackExtensions
</h1>
<div class="markdown level0 summary">
Extension of <span class="xref">System.Collections.Generic.Stack&lt;&gt;</span> helper to work with specific <span class="xref">System.Collections.Generic.IEqualityComparer&lt;&gt;</span>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">StackExtensions</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_StackExtensions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class StackExtensions : Object</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_StackExtensions_Contains_" data-uid="Terminal.Gui.StackExtensions.Contains*"></a>
<h4 id="Terminal_Gui_StackExtensions_Contains__1_System_Collections_Generic_Stack___0____0_System_Collections_Generic_IEqualityComparer___0__" data-uid="Terminal.Gui.StackExtensions.Contains``1(System.Collections.Generic.Stack{``0},``0,System.Collections.Generic.IEqualityComparer{``0})">Contains&lt;T&gt;(Stack&lt;T&gt;, T, IEqualityComparer&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Check if the stack object contains the value to find.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool Contains&lt;T&gt;(this Stack&lt;T&gt; stack, T valueToFind, IEqualityComparer&lt;T&gt; comparer = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">valueToFind</span></td>
<td>Value to find.</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td>The comparison object.</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code> If the value was found.<code>false</code> otherwise.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_StackExtensions_FindDuplicates_" data-uid="Terminal.Gui.StackExtensions.FindDuplicates*"></a>
<h4 id="Terminal_Gui_StackExtensions_FindDuplicates__1_System_Collections_Generic_Stack___0__System_Collections_Generic_IEqualityComparer___0__" data-uid="Terminal.Gui.StackExtensions.FindDuplicates``1(System.Collections.Generic.Stack{``0},System.Collections.Generic.IEqualityComparer{``0})">FindDuplicates&lt;T&gt;(Stack&lt;T&gt;, IEqualityComparer&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Find all duplicates stack objects values.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Stack&lt;T&gt; FindDuplicates&lt;T&gt;(this Stack&lt;T&gt; stack, IEqualityComparer&lt;T&gt; comparer = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td>The comparison object.</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td>The duplicates stack object.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_StackExtensions_MoveNext_" data-uid="Terminal.Gui.StackExtensions.MoveNext*"></a>
<h4 id="Terminal_Gui_StackExtensions_MoveNext__1_System_Collections_Generic_Stack___0__" data-uid="Terminal.Gui.StackExtensions.MoveNext``1(System.Collections.Generic.Stack{``0})">MoveNext&lt;T&gt;(Stack&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Move the first stack object value to the end.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void MoveNext&lt;T&gt;(this Stack&lt;T&gt; stack)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_StackExtensions_MovePrevious_" data-uid="Terminal.Gui.StackExtensions.MovePrevious*"></a>
<h4 id="Terminal_Gui_StackExtensions_MovePrevious__1_System_Collections_Generic_Stack___0__" data-uid="Terminal.Gui.StackExtensions.MovePrevious``1(System.Collections.Generic.Stack{``0})">MovePrevious&lt;T&gt;(Stack&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Move the last stack object value to the top.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void MovePrevious&lt;T&gt;(this Stack&lt;T&gt; stack)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_StackExtensions_MoveTo_" data-uid="Terminal.Gui.StackExtensions.MoveTo*"></a>
<h4 id="Terminal_Gui_StackExtensions_MoveTo__1_System_Collections_Generic_Stack___0____0_System_Int32_System_Collections_Generic_IEqualityComparer___0__" data-uid="Terminal.Gui.StackExtensions.MoveTo``1(System.Collections.Generic.Stack{``0},``0,System.Int32,System.Collections.Generic.IEqualityComparer{``0})">MoveTo&lt;T&gt;(Stack&lt;T&gt;, T, Int32, IEqualityComparer&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Move the stack object value to the index.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void MoveTo&lt;T&gt;(this Stack&lt;T&gt; stack, T valueToMove, int index = 0, IEqualityComparer&lt;T&gt; comparer = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">valueToMove</span></td>
<td>Value to move.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td>The index where to move.</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td>The comparison object.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_StackExtensions_Replace_" data-uid="Terminal.Gui.StackExtensions.Replace*"></a>
<h4 id="Terminal_Gui_StackExtensions_Replace__1_System_Collections_Generic_Stack___0____0___0_System_Collections_Generic_IEqualityComparer___0__" data-uid="Terminal.Gui.StackExtensions.Replace``1(System.Collections.Generic.Stack{``0},``0,``0,System.Collections.Generic.IEqualityComparer{``0})">Replace&lt;T&gt;(Stack&lt;T&gt;, T, T, IEqualityComparer&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Replaces an stack object values that match with the value to replace.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Replace&lt;T&gt;(this Stack&lt;T&gt; stack, T valueToReplace, T valueToReplaceWith, IEqualityComparer&lt;T&gt; comparer = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">valueToReplace</span></td>
<td>Value to replace.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">valueToReplaceWith</span></td>
<td>Value to replace with to what matches the value to replace.</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td>The comparison object.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_StackExtensions_Swap_" data-uid="Terminal.Gui.StackExtensions.Swap*"></a>
<h4 id="Terminal_Gui_StackExtensions_Swap__1_System_Collections_Generic_Stack___0____0___0_System_Collections_Generic_IEqualityComparer___0__" data-uid="Terminal.Gui.StackExtensions.Swap``1(System.Collections.Generic.Stack{``0},``0,``0,System.Collections.Generic.IEqualityComparer{``0})">Swap&lt;T&gt;(Stack&lt;T&gt;, T, T, IEqualityComparer&lt;T&gt;)</h4>
<div class="markdown level1 summary">
Swap two stack objects values that matches with the both values.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Swap&lt;T&gt;(this Stack&lt;T&gt; stack, T valueToSwapFrom, T valueToSwapTo, IEqualityComparer&lt;T&gt; comparer = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
<td><span class="parametername">stack</span></td>
<td>The stack object.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">valueToSwapFrom</span></td>
<td>Value to swap from.</td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">valueToSwapTo</span></td>
<td>Value to swap to.</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td>The comparison object.</td>
</tr>
</tbody>
</table>
<h5 class="typeParameters">Type Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td>The stack object type.</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>