Skip to content

Commit

Permalink
core: fix docs for map and set
Browse files Browse the repository at this point in the history
  • Loading branch information
@hellerve
hellerve committed Aug 25, 2018
1 parent 91075cc commit 1c6884b
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 43 deletions.
77 changes: 39 additions & 38 deletions core/Map.carp
View file
Expand Up @@ -91,11 +91,11 @@
(hidden dflt-len)
(def dflt-len 256)

(doc create "Create an empty hashmap.")
(doc create "Create an empty map.")
(defn create []
(init dflt-len (Array.repeat dflt-len Bucket.empty)))

(doc create-with-len "Create an empty hashmap with a given minimum size.")
(doc create-with-len "Create an empty map with a given number of buckets. High numbers reduce the possibility of hash collisions while increasing the memory footprint.")
(defn create-with-len [len]
(init len (Array.repeat len Bucket.empty)))

Expand All @@ -107,7 +107,7 @@
idx
(Bucket.grow (Array.nth b idx) (Pair.init @k @v))))))

(doc get "Get the value for the key k from map m. If it isn’t found, a zero element is returned.")
(doc get "Get the value for the key k from map m. If it isn’t found, a zero element for the value type is returned.")
(defn get [m k]
(let [idx (Int.mod (hash k) @(n-buckets m))]
(Bucket.get (Array.nth (buckets m) idx) k)))
Expand All @@ -119,7 +119,7 @@
(set! c (+ c (Array.length (Bucket.entries (Array.nth (buckets m) i))))))
c))

(doc length "Check whether the map m is empty.")
(doc empty "Check whether the map m is empty.")
(defn empty? [m]
(= (length m) 0))

Expand All @@ -136,7 +136,7 @@
idx
(Bucket.shrink (Array.nth b idx) k)))))

(doc for-each "Execute the binary function f for all keys and value in map m.")
(doc for-each "Execute the binary function f for all keys and values in the map m.")
(defn for-each [m f]
(for [i 0 @(n-buckets m)]
(let [bucket (Array.nth (buckets m) i)
Expand Down Expand Up @@ -205,53 +205,54 @@
(deftype (Set a) [n-buckets Int buckets (Array (SetBucket a))])

(defmodule Set
(hidden dflt-len)
(def dflt-len 256)

(doc create "Create an empty hashset.")
(doc create "Create an empty set.")
(defn create []
(init dflt-len (Array.repeat dflt-len SetBucket.empty)))

(doc create-with-len "Create an empty hashset with a given minimum size.")
(doc create-with-len "Create an empty set with a given number of buckets. Higher numbers decrease the probability of hash collisions while increasing the memory footprint.")
(defn create-with-len [len]
(init len (Array.repeat len SetBucket.empty)))

(doc put "Put a a key kinto set m.")
(defn put [m k]
(let [idx (Int.mod (hash k) @(n-buckets m))
b (buckets m)]
(set-buckets @m (Array.aset @b
(doc put "Put a a key k into the set s.")
(defn put [s k]
(let [idx (Int.mod (hash k) @(n-buckets s))
b (buckets s)]
(set-buckets @s (Array.aset @b
idx
(SetBucket.grow (Array.nth b idx) @k)))))

(doc length "Get the length of set m.")
(defn length [m]
(doc length "Get the length of set s.")
(defn length [s]
(let-do [c 0]
(for [i 0 @(n-buckets m)]
(set! c (+ c (Array.length (SetBucket.entries (Array.nth (buckets m) i))))))
(for [i 0 @(n-buckets s)]
(set! c (+ c (Array.length (SetBucket.entries (Array.nth (buckets s) i))))))
c))

(doc empty? "Check whether the set m is empty.")
(defn empty? [m]
(= (length m) 0))
(doc empty? "Check whether the set s is empty.")
(defn empty? [s]
(= (length s) 0))

(doc contains? "Check whether the set m contains the key k.")
(defn contains? [m k]
(let [idx (Int.mod (hash k) @(n-buckets m))]
(SetBucket.contains? (Array.nth (buckets m) idx) k)))
(doc contains? "Check whether the set s contains the key k.")
(defn contains? [s k]
(let [idx (Int.mod (hash k) @(n-buckets s))]
(SetBucket.contains? (Array.nth (buckets s) idx) k)))

(doc remove "Remove the key k from set m.")
(defn remove [m k]
(let [idx (Int.mod (hash k) @(n-buckets &m))
b (buckets &m)]
(set-buckets m (Array.aset @b
(doc remove "Remove the key k from the set s.")
(defn remove [s k]
(let [idx (Int.mod (hash k) @(n-buckets &s))
b (buckets &s)]
(set-buckets s (Array.aset @b
idx
(SetBucket.shrink (Array.nth b idx) k)))))


(doc for-each "Execute the unary function f for each element in set m.")
(defn for-each [m f]
(for [i 0 @(n-buckets m)]
(let [bucket (Array.nth (buckets m) i)
(doc for-each "Execute the unary function f for each element in the set s.")
(defn for-each [s f]
(for [i 0 @(n-buckets s)]
(let [bucket (Array.nth (buckets s) i)
len (Array.length (SetBucket.entries bucket))
entries (SetBucket.entries bucket)]
(for [j 0 len]
Expand All @@ -260,16 +261,16 @@

(doc from-array "Create a set from the values in array a.")
(defn from-array [a]
(let-do [m (create)]
(let-do [s (create)]
(for [i 0 (Array.length a)]
(let [e (Array.nth a i)]
(set! m (put &m e))))
m))
(set! s (put &s e))))
s))

(defn str [m]
(defn str [s]
(let-do [res @"{"]
(for [i 0 @(n-buckets m)]
(let [bucket (Array.nth (buckets m) i)
(for [i 0 @(n-buckets s)]
(let [bucket (Array.nth (buckets s) i)
len (Array.length (SetBucket.entries bucket))
entries (SetBucket.entries bucket)]
(for [j 0 len]
Expand Down
29 changes: 24 additions & 5 deletions docs/core/Map.html
View file
Expand Up @@ -216,7 +216,7 @@ <h3 id="create">
(create)
</pre>
<p class="doc">
Create an empty hashmap.
Create an empty map.
</p>
</div>
<div class="binder">
Expand All @@ -235,7 +235,7 @@ <h3 id="create-with-len">
(create-with-len len)
</pre>
<p class="doc">
Create an empty hashmap with a given minimum size.
Create an empty map with a given number of buckets. High numbers reduce the possibility of hash collisions while increasing the memory footprint.
</p>
</div>
<div class="binder">
Expand All @@ -257,6 +257,25 @@ <h3 id="delete">

</p>
</div>
<div class="binder">
<a class="anchor" href="#empty">
<h3 id="empty">
empty
</h3>
</a>
<div class="description">
external
</div>
<p class="sig">
a
</p>
<span>

</span>
<p class="doc">
Check whether the map m is empty.
</p>
</div>
<div class="binder">
<a class="anchor" href="#empty?">
<h3 id="empty?">
Expand Down Expand Up @@ -292,7 +311,7 @@ <h3 id="for-each">
(for-each m f)
</pre>
<p class="doc">
Execute the binary function f for all keys and value in map m.
Execute the binary function f for all keys and values in the map m.
</p>
</div>
<div class="binder">
Expand Down Expand Up @@ -330,7 +349,7 @@ <h3 id="get">
(get m k)
</pre>
<p class="doc">
Get the value for the key k from map m. If it isn’t found, a zero element is returned.
Get the value for the key k from map m. If it isn’t found, a zero element for the value type is returned.
</p>
</div>
<div class="binder">
Expand Down Expand Up @@ -368,7 +387,7 @@ <h3 id="length">
(length m)
</pre>
<p class="doc">
Check whether the map m is empty.
Get the length of the map m.
</p>
</div>
<div class="binder">
Expand Down

0 comments on commit 1c6884b

Please sign in to comment.