Skip to content

Update Coalton documentation #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stylewarning merged 1 commit into from
Dec 10, 2025
Merged

Update Coalton documentation #342

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions content/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4851,7 +4851,7 @@ For example, the following expressions are equivalent.

### Types

#### <a href="#hashmap-type"><code>HashMap</code></a> <sup><sub>[TYPE] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L66-L68">src</a></sub></sup><a name="hashmap-type"></a>
#### <a href="#hashmap-type"><code>HashMap</code></a> <sup><sub>[TYPE] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L67-L69">src</a></sub></sup><a name="hashmap-type"></a>
- <code>(HashMap (<a href="#hmnode-type">HmNode</a> :A :B))</code>

Immutable map (also known as a dictionary or dict) using hashes. Implemented as a hash array mapped trie data structure.
Expand All @@ -4876,7 +4876,7 @@ Immutable map (also known as a dictionary or dict) using hashes. Implemented as

### Values

#### <a href="#adjoin-value"><code>(ADJOIN HM KEY VAL)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L490-L493">src</a></sub></sup><a name="adjoin-value"></a>
#### <a href="#adjoin-value"><code>(ADJOIN HM KEY VAL)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L491-L494">src</a></sub></sup><a name="adjoin-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; :A &rarr; :B &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Returns a hashmap that has a new entry of (`key`, `val`) added to `hm`.
Expand All @@ -4886,7 +4886,7 @@ If `hm` alreay contains an entry with `key`, however, `hm` is returned as is.

***

#### <a href="#count-value"><code>(COUNT HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L350-L359">src</a></sub></sup><a name="count-value"></a>
#### <a href="#count-value"><code>(COUNT HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L351-L360">src</a></sub></sup><a name="count-value"></a>
<code>&forall; :A :B. ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; <a href="#integer-type">Integer</a>)</code>

Returns the number of entries in HM.
Expand All @@ -4895,7 +4895,7 @@ Returns the number of entries in HM.

***

#### <a href="#difference-value"><code>(DIFFERENCE A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L741-L743">src</a></sub></sup><a name="difference-value"></a>
#### <a href="#difference-value"><code>(DIFFERENCE A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L742-L744">src</a></sub></sup><a name="difference-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Raturns a HashMap that contains mappings in `a` but not in `b`.
Expand All @@ -4904,7 +4904,7 @@ Raturns a HashMap that contains mappings in `a` but not in `b`.

***

#### <a href="#empty?-value"><code>(EMPTY? HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L340-L344">src</a></sub></sup><a name="empty?-value"></a>
#### <a href="#empty?-value"><code>(EMPTY? HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L341-L345">src</a></sub></sup><a name="empty?-value"></a>
<code>&forall; :A :B. ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; <a href="#boolean-type">Boolean</a>)</code>

Returns True if a hashmap HM is empty, False if not.
Expand All @@ -4913,7 +4913,7 @@ Returns True if a hashmap HM is empty, False if not.

***

#### <a href="#entries-value"><code>(ENTRIES HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L679-L681">src</a></sub></sup><a name="entries-value"></a>
#### <a href="#entries-value"><code>(ENTRIES HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L680-L682">src</a></sub></sup><a name="entries-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#iterator-type">Iterator</a> (<a href="#tuple-type">Tuple</a> :A :B)))</code>

Returns an interator to iterate over all entries in hashmap hm.
Expand All @@ -4922,7 +4922,7 @@ Returns an interator to iterate over all entries in hashmap hm.

***

#### <a href="#insert-value"><code>(INSERT HM KEY VAL)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L482-L485">src</a></sub></sup><a name="insert-value"></a>
#### <a href="#insert-value"><code>(INSERT HM KEY VAL)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L483-L486">src</a></sub></sup><a name="insert-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; :A &rarr; :B &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Returns a hashmap that has a new entry of (KEY, VAL) added to HM. If HM
Expand All @@ -4932,7 +4932,7 @@ contains an entry with KEY, the new hashmap replaces it for the new entry.

***

#### <a href="#intersection-value"><code>(INTERSECTION A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L728-L738">src</a></sub></sup><a name="intersection-value"></a>
#### <a href="#intersection-value"><code>(INTERSECTION A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L729-L739">src</a></sub></sup><a name="intersection-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Construct a HashMap containing all the mappings whose key is in both A and B.
Expand All @@ -4943,7 +4943,7 @@ The entries from A remains in the result.

***

#### <a href="#keys-value"><code>(KEYS HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L667-L669">src</a></sub></sup><a name="keys-value"></a>
#### <a href="#keys-value"><code>(KEYS HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L668-L670">src</a></sub></sup><a name="keys-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#iterator-type">Iterator</a> :A))</code>

Returns an interator to iterate over all the keys in a hashmap hm.
Expand All @@ -4952,7 +4952,7 @@ Returns an interator to iterate over all the keys in a hashmap hm.

***

#### <a href="#lookup-value"><code>(LOOKUP HM KEY)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L363-L384">src</a></sub></sup><a name="lookup-value"></a>
#### <a href="#lookup-value"><code>(LOOKUP HM KEY)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L364-L385">src</a></sub></sup><a name="lookup-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; :A &rarr; (<a href="#optional-type">Optional</a> :B))</code>

Returns a value associated with KEY in the hashmap HM.
Expand All @@ -4961,7 +4961,7 @@ Returns a value associated with KEY in the hashmap HM.

***

#### <a href="#remove-value"><code>(REMOVE HM KEY)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L507-L517">src</a></sub></sup><a name="remove-value"></a>
#### <a href="#remove-value"><code>(REMOVE HM KEY)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L508-L518">src</a></sub></sup><a name="remove-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; :A &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Returns a hashmap that is identical to HM except the entry with KEY is
Expand All @@ -4971,7 +4971,7 @@ removed. If HM does not contain an entry with KEY, HM is returned as is.

***

#### <a href="#replace-value"><code>(REPLACE HM KEY VAL)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L498-L502">src</a></sub></sup><a name="replace-value"></a>
#### <a href="#replace-value"><code>(REPLACE HM KEY VAL)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L499-L503">src</a></sub></sup><a name="replace-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; :A &rarr; :B &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Returns a hashmap where the value associated with `key` is replaced
Expand All @@ -4982,7 +4982,7 @@ with `val`. If `hm` does not contain an entry with `key`, `hm` is

***

#### <a href="#union-value"><code>(UNION A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L719-L725">src</a></sub></sup><a name="union-value"></a>
#### <a href="#union-value"><code>(UNION A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L720-L726">src</a></sub></sup><a name="union-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Construct a HashMap containing all the mappings from A and B.
Expand All @@ -4995,13 +4995,13 @@ The operation is associative, but not commutative.

***

#### <a href="#update-value"><code>(UPDATE HM KEY F)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L524-L600">src</a></sub></sup><a name="update-value"></a>
#### <a href="#update-value"><code>(UPDATE HM KEY F)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L525-L601">src</a></sub></sup><a name="update-value"></a>
<code>&forall; :A :B :C. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; :A &rarr; ((<a href="#optional-type">Optional</a> :B) &rarr; (<a href="#tuple-type">Tuple</a> (<a href="#optional-type">Optional</a> :B) :C)) &rarr; (<a href="#tuple-type">Tuple</a> (<a href="#hashmap-type">HashMap</a> :A :B) :C))</code>


***

#### <a href="#values-value"><code>(VALUES HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L673-L675">src</a></sub></sup><a name="values-value"></a>
#### <a href="#values-value"><code>(VALUES HM)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L674-L676">src</a></sub></sup><a name="values-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#iterator-type">Iterator</a> :B))</code>

Returns an interator to iterate over all the values in a hashmap hm.
Expand All @@ -5010,7 +5010,7 @@ Returns an interator to iterate over all the values in a hashmap hm.

***

#### <a href="#xor-value"><code>(XOR A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L746-L756">src</a></sub></sup><a name="xor-value"></a>
#### <a href="#xor-value"><code>(XOR A B)</code></a> <sup><sub>[FUNCTION] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L747-L757">src</a></sub></sup><a name="xor-value"></a>
<code>&forall; :A :B. <a href="#hash-class">Hash</a> :A &rArr; ((<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B) &rarr; (<a href="#hashmap-type">HashMap</a> :A :B))</code>

Raturns a HashMap that contains mappings either in `a` or in `b`,
Expand All @@ -5020,7 +5020,7 @@ but not in both.

***

#### <a href="#empty-value"><code>EMPTY</code></a> <sup><sub>[VALUE] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L334-L336">src</a></sub></sup><a name="empty-value"></a>
#### <a href="#empty-value"><code>EMPTY</code></a> <sup><sub>[VALUE] · <a href="https://github.com/coalton-lang/coalton/tree/main/library/hashmap.lisp#L335-L337">src</a></sub></sup><a name="empty-value"></a>
<code>&forall; :A :B. (<a href="#hashmap-type">HashMap</a> :A :B)</code>

An empty HashMap
Expand Down