Terminal.Gui.StackExtensions.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class StackExtensions
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class StackExtensions
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.StackExtensions">
  73. <h1 id="Terminal_Gui_StackExtensions" data-uid="Terminal.Gui.StackExtensions" class="text-break">Class StackExtensions
  74. </h1>
  75. <div class="markdown level0 summary">
  76. 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>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">StackExtensions</span></div>
  83. </div>
  84. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  85. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  86. <h5 id="Terminal_Gui_StackExtensions_syntax">Syntax</h5>
  87. <div class="codewrapper">
  88. <pre><code class="lang-csharp hljs">public static class StackExtensions : Object</code></pre>
  89. </div>
  90. <h3 id="methods">Methods
  91. </h3>
  92. <a id="Terminal_Gui_StackExtensions_Contains_" data-uid="Terminal.Gui.StackExtensions.Contains*"></a>
  93. <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>
  94. <div class="markdown level1 summary">
  95. Check if the stack object contains the value to find.
  96. </div>
  97. <div class="markdown level1 conceptual"></div>
  98. <h5 class="decalaration">Declaration</h5>
  99. <div class="codewrapper">
  100. <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>
  101. </div>
  102. <h5 class="parameters">Parameters</h5>
  103. <table class="table table-bordered table-striped table-condensed">
  104. <thead>
  105. <tr>
  106. <th>Type</th>
  107. <th>Name</th>
  108. <th>Description</th>
  109. </tr>
  110. </thead>
  111. <tbody>
  112. <tr>
  113. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  114. <td><span class="parametername">stack</span></td>
  115. <td>The stack object.</td>
  116. </tr>
  117. <tr>
  118. <td><span class="xref">T</span></td>
  119. <td><span class="parametername">valueToFind</span></td>
  120. <td>Value to find.</td>
  121. </tr>
  122. <tr>
  123. <td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
  124. <td><span class="parametername">comparer</span></td>
  125. <td>The comparison object.</td>
  126. </tr>
  127. </tbody>
  128. </table>
  129. <h5 class="returns">Returns</h5>
  130. <table class="table table-bordered table-striped table-condensed">
  131. <thead>
  132. <tr>
  133. <th>Type</th>
  134. <th>Description</th>
  135. </tr>
  136. </thead>
  137. <tbody>
  138. <tr>
  139. <td><span class="xref">System.Boolean</span></td>
  140. <td><code>true</code> If the value was found.<code>false</code> otherwise.</td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <h5 class="typeParameters">Type Parameters</h5>
  145. <table class="table table-bordered table-striped table-condensed">
  146. <thead>
  147. <tr>
  148. <th>Name</th>
  149. <th>Description</th>
  150. </tr>
  151. </thead>
  152. <tbody>
  153. <tr>
  154. <td><span class="parametername">T</span></td>
  155. <td>The stack object type.</td>
  156. </tr>
  157. </tbody>
  158. </table>
  159. <a id="Terminal_Gui_StackExtensions_FindDuplicates_" data-uid="Terminal.Gui.StackExtensions.FindDuplicates*"></a>
  160. <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>
  161. <div class="markdown level1 summary">
  162. Find all duplicates stack objects values.
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <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>
  168. </div>
  169. <h5 class="parameters">Parameters</h5>
  170. <table class="table table-bordered table-striped table-condensed">
  171. <thead>
  172. <tr>
  173. <th>Type</th>
  174. <th>Name</th>
  175. <th>Description</th>
  176. </tr>
  177. </thead>
  178. <tbody>
  179. <tr>
  180. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  181. <td><span class="parametername">stack</span></td>
  182. <td>The stack object.</td>
  183. </tr>
  184. <tr>
  185. <td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
  186. <td><span class="parametername">comparer</span></td>
  187. <td>The comparison object.</td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <h5 class="returns">Returns</h5>
  192. <table class="table table-bordered table-striped table-condensed">
  193. <thead>
  194. <tr>
  195. <th>Type</th>
  196. <th>Description</th>
  197. </tr>
  198. </thead>
  199. <tbody>
  200. <tr>
  201. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  202. <td>The duplicates stack object.</td>
  203. </tr>
  204. </tbody>
  205. </table>
  206. <h5 class="typeParameters">Type Parameters</h5>
  207. <table class="table table-bordered table-striped table-condensed">
  208. <thead>
  209. <tr>
  210. <th>Name</th>
  211. <th>Description</th>
  212. </tr>
  213. </thead>
  214. <tbody>
  215. <tr>
  216. <td><span class="parametername">T</span></td>
  217. <td>The stack object type.</td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <a id="Terminal_Gui_StackExtensions_MoveNext_" data-uid="Terminal.Gui.StackExtensions.MoveNext*"></a>
  222. <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>
  223. <div class="markdown level1 summary">
  224. Move the first stack object value to the end.
  225. </div>
  226. <div class="markdown level1 conceptual"></div>
  227. <h5 class="decalaration">Declaration</h5>
  228. <div class="codewrapper">
  229. <pre><code class="lang-csharp hljs">public static void MoveNext&lt;T&gt;(this Stack&lt;T&gt; stack)</code></pre>
  230. </div>
  231. <h5 class="parameters">Parameters</h5>
  232. <table class="table table-bordered table-striped table-condensed">
  233. <thead>
  234. <tr>
  235. <th>Type</th>
  236. <th>Name</th>
  237. <th>Description</th>
  238. </tr>
  239. </thead>
  240. <tbody>
  241. <tr>
  242. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  243. <td><span class="parametername">stack</span></td>
  244. <td>The stack object.</td>
  245. </tr>
  246. </tbody>
  247. </table>
  248. <h5 class="typeParameters">Type Parameters</h5>
  249. <table class="table table-bordered table-striped table-condensed">
  250. <thead>
  251. <tr>
  252. <th>Name</th>
  253. <th>Description</th>
  254. </tr>
  255. </thead>
  256. <tbody>
  257. <tr>
  258. <td><span class="parametername">T</span></td>
  259. <td>The stack object type.</td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <a id="Terminal_Gui_StackExtensions_MovePrevious_" data-uid="Terminal.Gui.StackExtensions.MovePrevious*"></a>
  264. <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>
  265. <div class="markdown level1 summary">
  266. Move the last stack object value to the top.
  267. </div>
  268. <div class="markdown level1 conceptual"></div>
  269. <h5 class="decalaration">Declaration</h5>
  270. <div class="codewrapper">
  271. <pre><code class="lang-csharp hljs">public static void MovePrevious&lt;T&gt;(this Stack&lt;T&gt; stack)</code></pre>
  272. </div>
  273. <h5 class="parameters">Parameters</h5>
  274. <table class="table table-bordered table-striped table-condensed">
  275. <thead>
  276. <tr>
  277. <th>Type</th>
  278. <th>Name</th>
  279. <th>Description</th>
  280. </tr>
  281. </thead>
  282. <tbody>
  283. <tr>
  284. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  285. <td><span class="parametername">stack</span></td>
  286. <td>The stack object.</td>
  287. </tr>
  288. </tbody>
  289. </table>
  290. <h5 class="typeParameters">Type Parameters</h5>
  291. <table class="table table-bordered table-striped table-condensed">
  292. <thead>
  293. <tr>
  294. <th>Name</th>
  295. <th>Description</th>
  296. </tr>
  297. </thead>
  298. <tbody>
  299. <tr>
  300. <td><span class="parametername">T</span></td>
  301. <td>The stack object type.</td>
  302. </tr>
  303. </tbody>
  304. </table>
  305. <a id="Terminal_Gui_StackExtensions_MoveTo_" data-uid="Terminal.Gui.StackExtensions.MoveTo*"></a>
  306. <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>
  307. <div class="markdown level1 summary">
  308. Move the stack object value to the index.
  309. </div>
  310. <div class="markdown level1 conceptual"></div>
  311. <h5 class="decalaration">Declaration</h5>
  312. <div class="codewrapper">
  313. <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>
  314. </div>
  315. <h5 class="parameters">Parameters</h5>
  316. <table class="table table-bordered table-striped table-condensed">
  317. <thead>
  318. <tr>
  319. <th>Type</th>
  320. <th>Name</th>
  321. <th>Description</th>
  322. </tr>
  323. </thead>
  324. <tbody>
  325. <tr>
  326. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  327. <td><span class="parametername">stack</span></td>
  328. <td>The stack object.</td>
  329. </tr>
  330. <tr>
  331. <td><span class="xref">T</span></td>
  332. <td><span class="parametername">valueToMove</span></td>
  333. <td>Value to move.</td>
  334. </tr>
  335. <tr>
  336. <td><span class="xref">System.Int32</span></td>
  337. <td><span class="parametername">index</span></td>
  338. <td>The index where to move.</td>
  339. </tr>
  340. <tr>
  341. <td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
  342. <td><span class="parametername">comparer</span></td>
  343. <td>The comparison object.</td>
  344. </tr>
  345. </tbody>
  346. </table>
  347. <h5 class="typeParameters">Type Parameters</h5>
  348. <table class="table table-bordered table-striped table-condensed">
  349. <thead>
  350. <tr>
  351. <th>Name</th>
  352. <th>Description</th>
  353. </tr>
  354. </thead>
  355. <tbody>
  356. <tr>
  357. <td><span class="parametername">T</span></td>
  358. <td>The stack object type.</td>
  359. </tr>
  360. </tbody>
  361. </table>
  362. <a id="Terminal_Gui_StackExtensions_Replace_" data-uid="Terminal.Gui.StackExtensions.Replace*"></a>
  363. <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>
  364. <div class="markdown level1 summary">
  365. Replaces an stack object values that match with the value to replace.
  366. </div>
  367. <div class="markdown level1 conceptual"></div>
  368. <h5 class="decalaration">Declaration</h5>
  369. <div class="codewrapper">
  370. <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>
  371. </div>
  372. <h5 class="parameters">Parameters</h5>
  373. <table class="table table-bordered table-striped table-condensed">
  374. <thead>
  375. <tr>
  376. <th>Type</th>
  377. <th>Name</th>
  378. <th>Description</th>
  379. </tr>
  380. </thead>
  381. <tbody>
  382. <tr>
  383. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  384. <td><span class="parametername">stack</span></td>
  385. <td>The stack object.</td>
  386. </tr>
  387. <tr>
  388. <td><span class="xref">T</span></td>
  389. <td><span class="parametername">valueToReplace</span></td>
  390. <td>Value to replace.</td>
  391. </tr>
  392. <tr>
  393. <td><span class="xref">T</span></td>
  394. <td><span class="parametername">valueToReplaceWith</span></td>
  395. <td>Value to replace with to what matches the value to replace.</td>
  396. </tr>
  397. <tr>
  398. <td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
  399. <td><span class="parametername">comparer</span></td>
  400. <td>The comparison object.</td>
  401. </tr>
  402. </tbody>
  403. </table>
  404. <h5 class="typeParameters">Type Parameters</h5>
  405. <table class="table table-bordered table-striped table-condensed">
  406. <thead>
  407. <tr>
  408. <th>Name</th>
  409. <th>Description</th>
  410. </tr>
  411. </thead>
  412. <tbody>
  413. <tr>
  414. <td><span class="parametername">T</span></td>
  415. <td>The stack object type.</td>
  416. </tr>
  417. </tbody>
  418. </table>
  419. <a id="Terminal_Gui_StackExtensions_Swap_" data-uid="Terminal.Gui.StackExtensions.Swap*"></a>
  420. <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>
  421. <div class="markdown level1 summary">
  422. Swap two stack objects values that matches with the both values.
  423. </div>
  424. <div class="markdown level1 conceptual"></div>
  425. <h5 class="decalaration">Declaration</h5>
  426. <div class="codewrapper">
  427. <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>
  428. </div>
  429. <h5 class="parameters">Parameters</h5>
  430. <table class="table table-bordered table-striped table-condensed">
  431. <thead>
  432. <tr>
  433. <th>Type</th>
  434. <th>Name</th>
  435. <th>Description</th>
  436. </tr>
  437. </thead>
  438. <tbody>
  439. <tr>
  440. <td><span class="xref">System.Collections.Generic.Stack</span>&lt;T&gt;</td>
  441. <td><span class="parametername">stack</span></td>
  442. <td>The stack object.</td>
  443. </tr>
  444. <tr>
  445. <td><span class="xref">T</span></td>
  446. <td><span class="parametername">valueToSwapFrom</span></td>
  447. <td>Value to swap from.</td>
  448. </tr>
  449. <tr>
  450. <td><span class="xref">T</span></td>
  451. <td><span class="parametername">valueToSwapTo</span></td>
  452. <td>Value to swap to.</td>
  453. </tr>
  454. <tr>
  455. <td><span class="xref">System.Collections.Generic.IEqualityComparer</span>&lt;T&gt;</td>
  456. <td><span class="parametername">comparer</span></td>
  457. <td>The comparison object.</td>
  458. </tr>
  459. </tbody>
  460. </table>
  461. <h5 class="typeParameters">Type Parameters</h5>
  462. <table class="table table-bordered table-striped table-condensed">
  463. <thead>
  464. <tr>
  465. <th>Name</th>
  466. <th>Description</th>
  467. </tr>
  468. </thead>
  469. <tbody>
  470. <tr>
  471. <td><span class="parametername">T</span></td>
  472. <td>The stack object type.</td>
  473. </tr>
  474. </tbody>
  475. </table>
  476. </article>
  477. </div>
  478. <div class="hidden-sm col-md-2" role="complementary">
  479. <div class="sideaffix">
  480. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  481. <h5>In This Article</h5>
  482. <div></div>
  483. </nav>
  484. </div>
  485. </div>
  486. </div>
  487. </div>
  488. <footer>
  489. <div class="grad-bottom"></div>
  490. <div class="footer">
  491. <div class="container">
  492. <span class="pull-right">
  493. <a href="#top">Back to top</a>
  494. </span>
  495. <span>Generated by <strong>DocFX</strong></span>
  496. </div>
  497. </div>
  498. </footer>
  499. </div>
  500. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  501. <script type="text/javascript" src="../../styles/docfx.js"></script>
  502. <script type="text/javascript" src="../../styles/main.js"></script>
  503. </body>
  504. </html>