forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBelt.Id.html
249 lines (194 loc) · 14.6 KB
/
Belt.Id.html
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="../api_static/tomorrow-night.css">
<link rel="stylesheet" href="../api_static/style.css" type="text/css">
<script src="../api_static//highlight.pack.js"></script>
<script src="../api_static//script.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<meta charset="utf8">
<link rel="next" href="Belt.Array.html">
<title> Belt.Id </title></head>
<body>
<nav class="module-index"><ul><li><a href="Belt.html">Belt</a></li>
<li><a href="Belt_Array.html">Belt_Array</a></li>
<li><a href="Belt_Debug.html">Belt_Debug</a></li>
<li><a href="Belt_Float.html">Belt_Float</a></li>
<li><a href="Belt_HashMap.html">Belt_HashMap</a></li>
<li><a href="Belt_HashMapInt.html">Belt_HashMapInt</a></li>
<li><a href="Belt_HashMapString.html">Belt_HashMapString</a></li>
<li><a href="Belt_HashSet.html">Belt_HashSet</a></li>
<li><a href="Belt_HashSetInt.html">Belt_HashSetInt</a></li>
<li><a href="Belt_HashSetString.html">Belt_HashSetString</a></li>
<li><a href="Belt_Id.html">Belt_Id</a></li>
<li><a href="Belt_Int.html">Belt_Int</a></li>
<li><a href="Belt_List.html">Belt_List</a></li>
<li><a href="Belt_Map.html">Belt_Map</a></li>
<li><a href="Belt_MapDict.html">Belt_MapDict</a></li>
<li><a href="Belt_MapInt.html">Belt_MapInt</a></li>
<li><a href="Belt_MapString.html">Belt_MapString</a></li>
<li><a href="Belt_MutableMap.html">Belt_MutableMap</a></li>
<li><a href="Belt_MutableMapInt.html">Belt_MutableMapInt</a></li>
<li><a href="Belt_MutableMapString.html">Belt_MutableMapString</a></li>
<li><a href="Belt_MutableQueue.html">Belt_MutableQueue</a></li>
<li><a href="Belt_MutableSet.html">Belt_MutableSet</a></li>
<li><a href="Belt_MutableSetInt.html">Belt_MutableSetInt</a></li>
<li><a href="Belt_MutableSetString.html">Belt_MutableSetString</a></li>
<li><a href="Belt_MutableStack.html">Belt_MutableStack</a></li>
<li><a href="Belt_Option.html">Belt_Option</a></li>
<li><a href="Belt_Range.html">Belt_Range</a></li>
<li><a href="Belt_Result.html">Belt_Result</a></li>
<li><a href="Belt_Set.html">Belt_Set</a></li>
<li><a href="Belt_SetDict.html">Belt_SetDict</a></li>
<li><a href="Belt_SetInt.html">Belt_SetInt</a></li>
<li><a href="Belt_SetString.html">Belt_SetString</a></li>
<li><a href="Belt_SortArray.html">Belt_SortArray</a></li>
<li><a href="Belt_SortArrayInt.html">Belt_SortArrayInt</a></li>
<li><a href="Belt_SortArrayString.html">Belt_SortArrayString</a></li>
<li><a href="Belt_internalAVLset.html">Belt_internalAVLset</a></li>
<li><a href="Belt_internalAVLtree.html">Belt_internalAVLtree</a></li>
<li><a href="Belt_internalBuckets.html">Belt_internalBuckets</a></li>
<li><a href="Belt_internalBucketsType.html">Belt_internalBucketsType</a></li>
<li><a href="Belt_internalMapInt.html">Belt_internalMapInt</a></li>
<li><a href="Belt_internalMapString.html">Belt_internalMapString</a></li>
<li><a href="Belt_internalSetBuckets.html">Belt_internalSetBuckets</a></li>
<li><a href="Belt_internalSetInt.html">Belt_internalSetInt</a></li>
<li><a href="Belt_internalSetString.html">Belt_internalSetString</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Dom_storage.html">Dom_storage</a></li>
<li><a href="Dom_storage2.html">Dom_storage2</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_array2.html">Js_array2</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_console.html">Js_console</a></li>
<li><a href="Js_date.html">Js_date</a></li>
<li><a href="Js_dict.html">Js_dict</a></li>
<li><a href="Js_exn.html">Js_exn</a></li>
<li><a href="Js_float.html">Js_float</a></li>
<li><a href="Js_global.html">Js_global</a></li>
<li><a href="Js_int.html">Js_int</a></li>
<li><a href="Js_json.html">Js_json</a></li>
<li><a href="Js_list.html">Js_list</a></li>
<li><a href="Js_mapperRt.html">Js_mapperRt</a></li>
<li><a href="Js_math.html">Js_math</a></li>
<li><a href="Js_null.html">Js_null</a></li>
<li><a href="Js_null_undefined.html">Js_null_undefined</a></li>
<li><a href="Js_obj.html">Js_obj</a></li>
<li><a href="Js_option.html">Js_option</a></li>
<li><a href="Js_promise.html">Js_promise</a></li>
<li><a href="Js_re.html">Js_re</a></li>
<li><a href="Js_result.html">Js_result</a></li>
<li><a href="Js_string.html">Js_string</a></li>
<li><a href="Js_string2.html">Js_string2</a></li>
<li><a href="Js_typed_array.html">Js_typed_array</a></li>
<li><a href="Js_typed_array2.html">Js_typed_array2</a></li>
<li><a href="Js_types.html">Js_types</a></li>
<li><a href="Js_undefined.html">Js_undefined</a></li>
<li><a href="Js_vector.html">Js_vector</a></li>
<li><a href="Node.html">Node</a></li>
<li><a href="Node_buffer.html">Node_buffer</a></li>
<li><a href="Node_child_process.html">Node_child_process</a></li>
<li><a href="Node_fs.html">Node_fs</a></li>
<li><a href="Node_module.html">Node_module</a></li>
<li><a href="Node_path.html">Node_path</a></li>
<li><a href="Node_process.html">Node_process</a></li></ul></nav>
<div class="navbar"> <a class="up" href="Belt.html" title="Belt">Up</a>
<a class="post" href="Belt.Array.html" title="Belt.Array">Next</a>
</div>
<h1>Module <a href="type_Belt.Id.html">Belt.Id</a></h1>
<pre><span id="MODULEId"><span class="keyword">module</span> Id</span>: <code class="type"><a href="Belt_Id.html">Belt_Id</a></code></pre><div class="info module top">
<div class="not-examples">
<a href="Belt.Id.html"><code class="code">Belt.Id</code></a>
Provide utilities to create identified comparators or hashes for
data structures used below.
It create a unique identifier per module of
functions so that different data structures with slightly different
comparison functions won't mix<br>
</div>
</div>
<hr width="100%">
<pre><span id="TYPEhash"><span class="keyword">type</span> <code class="type">('a, 'id)</code> hash</span> </pre>
<div class="info ">
<div class="not-examples">
<code class="code">('a, 'id) hash</code>
Its runtime represenation is a <code class="code">hash</code> function, but signed with a
type parameter, so that different hash functions type mismatch<br>
</div>
</div>
<pre><span id="TYPEeq"><span class="keyword">type</span> <code class="type">('a, 'id)</code> eq</span> </pre>
<div class="info ">
<div class="not-examples">
<code class="code">('a, 'id) eq</code>
Its runtime represenation is an <code class="code">eq</code> function, but signed with a
type parameter, so that different hash functions type mismatch<br>
</div>
</div>
<pre><span id="TYPEcmp"><span class="keyword">type</span> <code class="type">('a, 'id)</code> cmp</span> </pre>
<div class="info ">
<div class="not-examples">
<code class="code">('a,'id) cmp</code>
Its runtime representation is a <code class="code">cmp</code> function, but signed with a
type parameter, so that different hash functions type mismatch<br>
</div>
</div>
<pre><span id="MODULETYPEComparable"><span class="keyword">module type</span> <a href="Belt_Id.Comparable.html">Comparable</a></span> = <code class="code">sig</code> <a href="Belt_Id.Comparable.html">..</a> <code class="code">end</code></pre> <div class="info">
<div class="not-examples">
</div>
</div>
<pre><span id="TYPEcomparable"><span class="keyword">type</span> <code class="type">('key, 'id)</code> comparable</span> = <code class="type">(module Belt_Id.Comparable with type identity = 'id and type t = 'key)</code> </pre>
<div class="info ">
<div class="not-examples">
<code class="code">('key, 'id) cmparable</code> is a module of functions, here it only includes <code class="code">cmp</code>.
Unlike normal functions, when created, it comes with a unique identity (guaranteed
by the type system).
It can be created using function <a href="Belt_Id.html#VALcomparableU"><code class="code">Belt_Id.comparableU</code></a> or<a href="Belt_Id.html#VALcomparable"><code class="code">Belt_Id.comparable</code></a>.
The idea of a unique identity when created is that it makes sure two sets would type
mismatch if they use different comparison function<br>
</div>
</div>
<pre><span id="MODULEMakeComparableU"><span class="keyword">module</span> <a href="Belt_Id.MakeComparableU.html">MakeComparableU</a></span>: <div class="sig_block"><code class="code">functor (</code><code class="code">M</code><code class="code"> : </code><code class="code">sig</code></pre><div class="sig_block">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<pre><span id="VALcmp"><span class="keyword">val</span> cmp</span> : <code class="type">(t -> t -> int [@bs])</code></pre></div><pre><code class="code">end</code><code class="code">) -> </code><code class="type"><a href="Belt_Id.Comparable.html">Comparable</a></code><code class="type"> with type t = M.t</code></div></pre> <div class="info">
<div class="not-examples">
</div>
</div>
<pre><span id="MODULEMakeComparable"><span class="keyword">module</span> <a href="Belt_Id.MakeComparable.html">MakeComparable</a></span>: <div class="sig_block"><code class="code">functor (</code><code class="code">M</code><code class="code"> : </code><code class="code">sig</code></pre><div class="sig_block">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<pre><span id="VALcmp"><span class="keyword">val</span> cmp</span> : <code class="type">t -> t -> int</code></pre></div><pre><code class="code">end</code><code class="code">) -> </code><code class="type"><a href="Belt_Id.Comparable.html">Comparable</a></code><code class="type"> with type t = M.t</code></div></pre> <div class="info">
<div class="not-examples">
</div>
</div>
<pre><span id="VALcomparableU"><span class="keyword">val</span> comparableU</span> : <code class="type">cmp:('a -> 'a -> int [@bs]) -> (module Belt_Id.Comparable with type t = 'a)</code></pre>
<pre><span id="VALcomparable"><span class="keyword">val</span> comparable</span> : <code class="type">cmp:('a -> 'a -> int) -> (module Belt_Id.Comparable with type t = 'a)</code></pre>
<pre><span id="MODULETYPEHashable"><span class="keyword">module type</span> <a href="Belt_Id.Hashable.html">Hashable</a></span> = <code class="code">sig</code> <a href="Belt_Id.Hashable.html">..</a> <code class="code">end</code></pre> <div class="info">
<div class="not-examples">
</div>
</div>
<pre><span id="TYPEhashable"><span class="keyword">type</span> <code class="type">('key, 'id)</code> hashable</span> = <code class="type">(module Belt_Id.Hashable with type identity = 'id and type t = 'key)</code> </pre>
<div class="info ">
<div class="not-examples">
<code class="code">('key, 'id) hashable</code> is a module of functions, here it only includes <code class="code">hash</code>, <code class="code">eq</code>.
Unlike normal functions, when created, it comes with a unique identity (guaranteed
by the type system).
It can be created using function <a href="Belt_Id.html#VALhashableU"><code class="code">Belt_Id.hashableU</code></a> or <a href="Belt_Id.html#VALhashable"><code class="code">Belt_Id.hashable</code></a>.
The idea of a unique identity when created is that it makes sure two hash sets would type
mismatch if they use different comparison function<br>
</div>
</div>
<pre><span id="MODULEMakeHashableU"><span class="keyword">module</span> <a href="Belt_Id.MakeHashableU.html">MakeHashableU</a></span>: <div class="sig_block"><code class="code">functor (</code><code class="code">M</code><code class="code"> : </code><code class="code">sig</code></pre><div class="sig_block">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<pre><span id="VALhash"><span class="keyword">val</span> hash</span> : <code class="type">(t -> int [@bs])</code></pre>
<pre><span id="VALeq"><span class="keyword">val</span> eq</span> : <code class="type">(t -> t -> bool [@bs])</code></pre></div><pre><code class="code">end</code><code class="code">) -> </code><code class="type"><a href="Belt_Id.Hashable.html">Hashable</a></code><code class="type"> with type t = M.t</code></div></pre> <div class="info">
<div class="not-examples">
</div>
</div>
<pre><span id="MODULEMakeHashable"><span class="keyword">module</span> <a href="Belt_Id.MakeHashable.html">MakeHashable</a></span>: <div class="sig_block"><code class="code">functor (</code><code class="code">M</code><code class="code"> : </code><code class="code">sig</code></pre><div class="sig_block">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<pre><span id="VALhash"><span class="keyword">val</span> hash</span> : <code class="type">t -> int</code></pre>
<pre><span id="VALeq"><span class="keyword">val</span> eq</span> : <code class="type">t -> t -> bool</code></pre></div><pre><code class="code">end</code><code class="code">) -> </code><code class="type"><a href="Belt_Id.Hashable.html">Hashable</a></code><code class="type"> with type t = M.t</code></div></pre> <div class="info">
<div class="not-examples">
</div>
</div>
<pre><span id="VALhashableU"><span class="keyword">val</span> hashableU</span> : <code class="type">hash:('a -> int [@bs]) -><br> eq:('a -> 'a -> bool [@bs]) -> (module Belt_Id.Hashable with type t = 'a)</code></pre>
<pre><span id="VALhashable"><span class="keyword">val</span> hashable</span> : <code class="type">hash:('a -> int) -><br> eq:('a -> 'a -> bool) -> (module Belt_Id.Hashable with type t = 'a)</code></pre></body></html>