carp-lang/Carp
1
1
Fork 0
mirror of https://github.com/carp-lang/Carp.git synced 2024-08-16 00:30:24 +03:00
Code Issues Projects Releases Wiki Activity

docs: add docstrings to some dynamic functions (#1191)

Browse Source
This commit is contained in:
Veit Heller 2021-03-30 10:22:18 +02:00 committed by GitHub
parent 459a62e61f
commit fd9ceef1ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
core/Dynamic.carp
View File

@ -10,15 +10,20 @@
(defndynamic nil? [value]
(= value nil))
(doc inc "increments a number.")
(defndynamic inc [x]
(+ x 1))
(doc dec "decrements a number.")
(defndynamic dec [x]
(- x 1))
(doc neg "negates a number.")
(defndynamic neg [x]
(* -1 x))
(doc mod "implements modulo, is slower than modulo specialized on
integers [`imod`](#imod).")
(defndynamic mod [x y]
(let-do [a (if (< x 0) (neg x) x)
b (if (< y 0) (neg y) y)
@ -27,7 +32,7 @@
(set! m (- m b)))
(if (< a 0) (neg m) m)))
(doc imod "implements the modulo on integers, and is much faster than
(doc imod "implements modulo on integers, and is much faster than
[`mod](#mod).")
(defndynamic imod [x y]
(- x (* y (/ x y))))
@ -46,15 +51,19 @@
(Project.config "echo-compiler-cmd" false))))
(defmodule String
(doc prefix "takes the prefix of the string `s` up to the index `to`.")
(defndynamic prefix [s to]
(String.slice s 0 to))
(doc suffix "takes the suffix of the string `s` from the index `from`.")
(defndynamic suffix [s from]
(String.slice s from (String.length s)))
(doc head "takes the head of the string `s` as a one-character string.")
(defndynamic head [s]
(String.prefix s 1))
(doc tail "takes the tail of the string `s`.")
(defndynamic tail [s]
(String.suffix s 1))
)

12
core/List.carp
View File

@ -1,5 +1,14 @@
(defmodule Dynamic
(doc cxr "takes a specification of a traversal in `a` (head) and `d` (tail)
symbols and a list `pair` to traverse.
Example:
```
(cxr '(1 a 1 d) '(1 2 3)) ; => 2
(cxr '(1 a 1 d 1 a 4 d) '(1 2 3 4 (5 6 7))) ; => 6
```")
(defndynamic cxr [x pair]
(cond
(= (length x) 0) pair
@ -12,12 +21,15 @@
(cxr (cddr x) pair)
(cxr (cons (- (car x) 1) (cdr x)) pair)))))
(doc nthcdr "takes the `n`th tail or `cdr` of the list `pair`.")
(defndynamic nthcdr [n pair]
(cxr (list (+ n 1) 'd) pair))
(doc nthcar "takes the `n`th head or `car` of the list `pair`.")
(defndynamic nthcar [n pair]
(cxr (list 1 'a n 'd) pair))
(hidden collect-into-internal)
(defndynamic collect-into-internal [xs acc f]
(if (= 0 (length xs))
acc