agate-lang.github.io/Range.html at main · agate-lang/agate-lang.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.12">
<meta name="author" content="v0.1">
<title>Range class</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="./rouge-old_github.css">
  <meta name="keywords" content="Agate, programming language, scripting, gamedev" />
  <meta name="description" content="Agate, a simple and embeddable programming language" />
  <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
  <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
  <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
  <link rel="manifest" href="/site.webmanifest">
  <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
  <meta name="msapplication-TileColor" content="#da532c">
  <meta name="theme-color" content="#ffffff">
</head>
<body class="article toc2 toc-right">
<div id="header">
<h1><code>Range</code> class</h1>
<div class="details">
<span id="author" class="author">v0.1</span><br>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_methods">Methods</a>
<ul class="sectlevel2">
<li><a href="#_clone"><strong>clone</strong>()</a></li>
<li><a href="#_containsvalue"><strong>contains</strong>(value)</a></li>
<li><a href="#_from"><strong>from</strong></a></li>
<li><a href="#_hash"><strong>hash</strong></a></li>
<li><a href="#_inclusive"><strong>inclusive</strong></a></li>
<li><a href="#_iterate"><strong>iterate</strong>(iterator), <strong>iterator_value</strong>(iterator)</a></li>
<li><a href="#_max"><strong>max</strong></a></li>
<li><a href="#_min"><strong>min</strong></a></li>
<li><a href="#_size"><strong>size</strong></a></li>
<li><a href="#_to"><strong>to</strong></a></li>
<li><a href="#_to_s"><strong>to_s</strong></a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>A range is an interval of consecutive integers represented by its endpoints. A range is created with <a href="Int.html#_inclusive_range"><code>..</code> operator</a> for inclusive range and <a href="Int.html#_exclusive_range"><code>...</code> operator</a> for exclusive range.</p>
</div>
<div class="paragraph">
<p><a href="core.html">&lt; Back to core unit</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_methods"><a class="anchor" href="#_methods"></a>Methods</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_clone"><a class="anchor" href="#_clone"></a><strong>clone</strong>()</h3>
<div class="paragraph">
<p>Get a copy of the range.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">clone</span><span class="p">())</span><span class="w"> </span><span class="c1">#&gt; 42..69</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_containsvalue"><a class="anchor" href="#_containsvalue"></a><strong>contains</strong>(value)</h3>
<div class="paragraph">
<p>Return <code>true</code> if the range contains <code>value</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">contains</span><span class="p">(</span><span class="mi">55</span><span class="p">))</span><span class="w"> </span><span class="c1">#&gt; true</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">contains</span><span class="p">(</span><span class="mi">12</span><span class="p">))</span><span class="w"> </span><span class="c1">#&gt; false</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_from"><a class="anchor" href="#_from"></a><strong>from</strong></h3>
<div class="paragraph">
<p>Return the first endpoint of the range.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">from</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 42</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">12</span><span class="p">..</span><span class="mi">7</span><span class="p">).</span><span class="n">from</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 12</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>See also: <a href="#_to"><strong>to</strong></a></p>
</div>
</div>
<div class="sect2">
<h3 id="_hash"><a class="anchor" href="#_hash"></a><strong>hash</strong></h3>
<div class="paragraph">
<p>Compute a hash for the range.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">hash</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; -1259079512711543054</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_inclusive"><a class="anchor" href="#_inclusive"></a><strong>inclusive</strong></h3>
<div class="paragraph">
<p>Return <code>true</code> is the range includes <code>to</code> (<code>from</code> is always included).</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">inclusive</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; true</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">...</span><span class="mi">69</span><span class="p">).</span><span class="n">inclusive</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; false</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_iterate"><a class="anchor" href="#_iterate"></a><strong>iterate</strong>(iterator), <strong>iterator_value</strong>(iterator)</h3>
<div class="paragraph">
<p>Implement the <a href="lang.html#_iterator_protocol">iterator protocol</a> to iterate over the range.</p>
</div>
</div>
<div class="sect2">
<h3 id="_max"><a class="anchor" href="#_max"></a><strong>max</strong></h3>
<div class="paragraph">
<p>Return the maximum endpoint of the range.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">max</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 69</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">12</span><span class="p">..</span><span class="mi">7</span><span class="p">).</span><span class="n">max</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 12</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>See also: <a href="#_min"><strong>min</strong></a></p>
</div>
</div>
<div class="sect2">
<h3 id="_min"><a class="anchor" href="#_min"></a><strong>min</strong></h3>
<div class="paragraph">
<p>Return the minimum endpoint of the range.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">min</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 42</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">12</span><span class="p">..</span><span class="mi">7</span><span class="p">).</span><span class="n">min</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 7</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>See also: <a href="#_max"><strong>max</strong></a></p>
</div>
</div>
<div class="sect2">
<h3 id="_size"><a class="anchor" href="#_size"></a><strong>size</strong></h3>
<div class="paragraph">
<p>Return the number of elements in the range.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">size</span><span class="p">)</span><span class="w">   </span><span class="c1">#&gt; 28</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">...</span><span class="mi">69</span><span class="p">).</span><span class="n">size</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 27</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_to"><a class="anchor" href="#_to"></a><strong>to</strong></h3>
<div class="paragraph">
<p>Return the second endpoint of the range. If the range is inclusive, this value is included, otherwise, it is excluded.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">).</span><span class="n">to</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 69</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">((</span><span class="mi">12</span><span class="p">..</span><span class="mi">7</span><span class="p">).</span><span class="n">to</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 7</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>See also: <a href="#_from"><strong>from</strong></a></p>
</div>
</div>
<div class="sect2">
<h3 id="_to_s"><a class="anchor" href="#_to_s"></a><strong>to_s</strong></h3>
<div class="paragraph">
<p>Transform the range to a <a href="String.html"><code>String</code></a>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="agate"><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="mi">42</span><span class="p">..</span><span class="mi">69</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 42..69</span><span class="err">
</span><span class="nc">IO</span><span class="p">.</span><span class="n">println</span><span class="p">(</span><span class="mi">42</span><span class="p">...</span><span class="mi">69</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 42...69</span></code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  messageStyle: "none",
  tex2jax: {
    inlineMath: [["\\(", "\\)"]],
    displayMath: [["\\[", "\\]"]],
    ignoreClass: "nostem|nolatexmath"
  },
  asciimath2jax: {
    delimiters: [["\\$", "\\$"]],
    ignoreClass: "nostem|noasciimath"
  },
  TeX: { equationNumbers: { autoNumber: "none" } }
})
MathJax.Hub.Register.StartupHook("AsciiMath Jax Ready", function () {
  MathJax.InputJax.AsciiMath.postfilterHooks.Add(function (data, node) {
    if ((node = data.script.parentNode) && (node = node.parentNode) && node.classList.contains("stemblock")) {
      data.math.root.display = "block"
    }
    return data
  })
})
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.9/MathJax.js?config=TeX-MML-AM_HTMLorMML"></script>
</body>
</html>