agate-lang.github.io/Bool.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
<!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>Bool 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>Bool</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="#_hash"><strong>hash</strong></a></li>
<li><a href="#_to_i"><strong>to_i</strong></a></li>
<li><a href="#_to_s"><strong>to_s</strong></a></li>
</ul>
</li>
<li><a href="#_operators">Operators</a>
<ul class="sectlevel2">
<li><a href="#_not"><strong>!</strong> operator</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><code>Bool</code> is the class for the boolean values <code>true</code> and <code>false</code>.</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 boolean.</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="k">true</span><span class="p">.</span><span class="n">clone</span><span class="p">())</span><span class="w"> </span><span class="c1">#&gt; true</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_hash"><a class="anchor" href="#_hash"></a><strong>hash</strong></h3>
<div class="paragraph">
<p>Return a hash for the boolean value: 1 for <code>true</code>, 2 for <code>false</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="k">true</span><span class="p">.</span><span class="n">hash</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 1</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="k">false</span><span class="p">.</span><span class="n">hash</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 2</span></code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_to_i"><a class="anchor" href="#_to_i"></a><strong>to_i</strong></h3>
<div class="paragraph">
<p>Transform the boolean value into an <a href="Int.html"><code>Int</code></a>: 1 for <code>true</code>, 0 for <code>false</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="k">true</span><span class="p">.</span><span class="n">to_i</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; 1</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="k">false</span><span class="p">.</span><span class="n">to_i</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; 0</span></code></pre>
</div>
</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 boolean value into a <a href="String.html"><code>String</code></a>: <code>"true"</code> for <code>true</code>, <code>"false"</code> for <code>false</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="k">true</span><span class="p">.</span><span class="n">to_s</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="k">false</span><span class="p">.</span><span class="n">to_s</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; false</span></code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_operators"><a class="anchor" href="#_operators"></a>Operators</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_not"><a class="anchor" href="#_not"></a><strong>!</strong> operator</h3>
<div class="paragraph">
<p>Return the negation of the value.</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="o">!</span><span class="k">true</span><span class="p">)</span><span class="w">  </span><span class="c1">#&gt; false</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="o">!</span><span class="k">false</span><span class="p">)</span><span class="w"> </span><span class="c1">#&gt; true</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>