oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-14 04:15:41 +00:00
Code Issues
gh-pages
X10D/api/X10D.Core.RangeExtensions.html
oliverbooth df639e5f83 Deploy to GitHub Pages
2024-06-12 13:17:02 +00:00

209 lines
10 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class RangeExtensions
| X10D </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class RangeExtensions
| X10D ">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../images/favicon.png">
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/night-owl.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.2/font/bootstrap-icons.css" integrity="sha384-EvBWSlnoFgZlXJvpzS+MAUEjvN7+gcCwH+qh7GRFOGgZO0PuwOFro7qPOJnLfe7l" crossorigin="anonymous">
<link rel="stylesheet" href="../styles/config.css">
<link rel="stylesheet" href="../styles/discord.css">
<link rel="stylesheet" href="../styles/singulink.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<meta property="docfx:newtab" content="true">
</head>
<body>
<div class="top-navbar">
<a class="burger-icon" onclick="toggleMenu()">
<svg name="Hamburger" style="vertical-align: middle;" width="34" height="34" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
</a>
<a class="brand" href="../index.html">
<img src="../images/favicon.png" alt="X10D" class="logomark">
<span class="brand-title">X10D</span>
</a> </div>
<div class="body-content">
<div id="blackout" class="blackout" onclick="toggleMenu()"></div>
<nav id="sidebar" role="navigation">
<div class="sidebar">
<div>
<div class="mobile-hide">
<a class="brand" href="../index.html">
<img src="../images/favicon.png" alt="X10D" class="logomark">
<span class="brand-title">X10D</span>
</a> </div>
<div class="sidesearch">
<form id="search" role="search" class="search">
<i class="bi bi-search search-icon"></i>
<input type="text" id="search-query" placeholder="Search" autocomplete="off">
</form>
</div>
<div id="navbar">
</div>
</div> <div class="sidebar-item-separator"></div>
<div id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="footer">
<strong>DocFX + Singulink = ♥</strong>
</div> </nav>
<main class="main-panel">
<div id="search-results" style="display: none;">
<h1 class="search-list">Search Results for <span></span></h1>
<div class="sr-items">
<p><i class="bi bi-hourglass-split index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
<div role="main" class="hide-when-search">
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
<article class="content wrap" id="_content" data-uid="X10D.Core.RangeExtensions">
<h1 id="X10D_Core_RangeExtensions" data-uid="X10D.Core.RangeExtensions" class="text-break">Class RangeExtensions
</h1>
<div class="markdown level0 summary"><p>Extension methods for <see cref="!:Range"></see>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">RangeExtensions</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="X10D.Core.html">X10D.Core</a></h6>
<h6><strong>Assembly</strong>: X10D.dll</h6>
<h5 id="X10D_Core_RangeExtensions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class RangeExtensions : object</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Core_RangeExtensions_GetEnumerator_Range_.md&amp;value=---%0Auid%3A%20X10D.Core.RangeExtensions.GetEnumerator(Range)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Core/RangeExtensions.cs/#L44">View Source</a>
</span>
<a id="X10D_Core_RangeExtensions_GetEnumerator_" data-uid="X10D.Core.RangeExtensions.GetEnumerator*"></a>
<h4 id="X10D_Core_RangeExtensions_GetEnumerator_Range_" data-uid="X10D.Core.RangeExtensions.GetEnumerator(Range)">GetEnumerator(Range)</h4>
<div class="markdown level1 summary"><p>Allows the ability to use a <code>for</code> loop to iterate over the indices of a <see cref="!:Range"></see>. The indices of the
range are the inclusive lower and upper bounds of the enumeration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static RangeEnumerator GetEnumerator(this Range range)</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">Range</span></td>
<td><span class="parametername">range</span></td>
<td><p>The range whose indices over which will be enumerated.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="X10D.Core.RangeEnumerator.html">RangeEnumerator</a></td>
<td><p>A <a class="xref" href="X10D.Core.RangeEnumerator.html">RangeEnumerator</a> that will enumerate over the indices of <code data-dev-comment-type="paramref" class="paramref">range</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="X10D_Core_RangeExtensions_GetEnumerator_Range__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method aims to implement Python-esque for loops in C# by taking advantage of the language syntax used to define
a <see cref="!:Range"></see> value. Negative bounds may be specified using the C# <code>^</code> operator, or by providing an
<see cref="!:Index"></see> whose <see cref="!:Index.IsFromEnd"></see> property is <span class="xref">true</span>.</p>
</div>
<h5 id="X10D_Core_RangeExtensions_GetEnumerator_Range__examples">Examples</h5>
<p>The following example counts from 0 to 10 inclusive:</p>
<pre><code> foreach (var i in 0..10)
{
Console.WriteLine(i);
}</code></pre>
<p>To use negative bounds, use the <code>^</code> operator. The following example counts from -5 to 5 inclusive:</p>
<pre><code> foreach (var i in ^5..5)
{
Console.WriteLine(i);
}</code></pre>
<p>Decrementing enumeration is supported. The following example counts from 5 to -5 inclusive:</p>
<pre><code> foreach (var i in 5..^5)
{
Console.WriteLine(i);
}</code></pre>
</article>
</div>
<div class="copyright-footer">
<span>&#169; Singulink. All rights reserved.</span>
</div>
</main>
</div>
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
<script type="text/javascript" src="../styles/url.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/singulink.js"></script>
<script type="text/javascript" src="../styles/main.js"></script> </body>
</html>
View Git Blame Copy Permalink