carp-lang/Carp
1
1
Fork 0
mirror of https://github.com/carp-lang/Carp.git synced 2024-10-26 13:51:50 +03:00
Code Issues Projects Releases Wiki Activity

Update

Browse Source
This commit is contained in:
scottolsen 2020-10-02 18:03:34 -04:00
parent 25839de02d
commit 1206ad2309
1 changed files with 56 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
docs/core/Dynamic.html
View File

@ -458,7 +458,14 @@
(all? f xs) (all? f xs)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Checks whether all of the elements in <code>xs</code> conform to the predicate
function <code>f</code>.</p>
<pre><code>(all? (fn [x] (&lt; 1 x)) '(2 3 4))
=&gt; true
(all? (fn [x] (&lt; 1 x)) '(-1 0 1))
=&gt; false
</code></pre>
</p> </p>
</div> </div>
<div class="binder"> <div class="binder">
@ -477,11 +484,12 @@
(any? f xs) (any? f xs)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>checks whether all of the elements in <code>xs</code> conform to the predicate <p>Checks whether any of the elements in <code>xs</code> conforms to the predicate
function <code>f</code>.</p> function <code>f</code>.</p>
<p>Example:</p> <pre><code>(any? (fn [x] (= 'a x)) '(a b c))
<pre><code>(all? (fn [x] (&lt; 1 x)) '(2 3 4)) ; =&gt; true =&gt; true
(all? (fn [x] (&lt; 1 x)) '(-1 0 1)) ; =&gt; false (any? (fn [x] (= 'a x)) '(e f g))
=&gt; false
</code></pre> </code></pre>
</p> </p>
@ -1331,7 +1339,6 @@ result.</p>
<p>If you only need to compose functions that take a single argument (unary arity) <p>If you only need to compose functions that take a single argument (unary arity)
see <code>comp</code>. Comp also generates the form that corresponds to the composition, see <code>comp</code>. Comp also generates the form that corresponds to the composition,
compose contrarily evaluates 'eagerly' and returns a computed symbol.</p> compose contrarily evaluates 'eagerly' and returns a computed symbol.</p>
<p>For exmaple:</p>
<pre><code>;; a silly composition <pre><code>;; a silly composition
((compose empty take) 3 [1 2 3 4 5]) ((compose empty take) 3 [1 2 3 4 5])
;; =&gt; [] ;; =&gt; []
@ -1408,11 +1415,10 @@ compose contrarily evaluates 'eagerly' and returns a computed symbol.</p>
(curry f x) (curry f x)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Returns a curried function accepting a single argument, that applies f to x <p>Returns a curried function accepting a single argument, that applies <code>f</code> to <code>x</code>
and then to the following argument.</p> and then to the following argument.</p>
<p>For example,</p>
<pre><code>(map (curry Symbol.prefix 'Foo) '(bar baz)) <pre><code>(map (curry Symbol.prefix 'Foo) '(bar baz))
;; =&gt; (Foo.bar Foo.baz) =&gt; (Foo.bar Foo.baz)
</code></pre> </code></pre>
</p> </p>
@ -1434,16 +1440,15 @@ and then to the following argument.</p>
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Curry functions of any airity.</p> <p>Curry functions of any airity.</p>
<p>For example:</p>
<pre><code>(map (curry* Dynamic.zip + '(1 2 3)) '((4 5) (6))) <pre><code>(map (curry* Dynamic.zip + '(1 2 3)) '((4 5) (6)))
;; =&gt; (((+ 1 4) (+ 2 5)) ((+ 1 6))) =&gt; (((+ 1 4) (+ 2 5)) ((+ 1 6)))
((curry Dynamic.zip cons '(1 2 3)) '((4 5) (6))) ((curry Dynamic.zip cons '(1 2 3)) '((4 5) (6)))
;; =&gt; ((cons 1 (4 5)) (cons (2 (6)))) =&gt; ((cons 1 (4 5)) (cons (2 (6))))
(defndynamic add-em-up [x y z] (+ (+ x y) z)) (defndynamic add-em-up [x y z] (+ (+ x y) z))
(map (curry* add-em-up 1 2) '(1 2 3)) (map (curry* add-em-up 1 2) '(1 2 3))
;; =&gt; (4 5 6) =&gt; (4 5 6)
</code></pre> </code></pre>
</p> </p>
@ -1730,11 +1735,10 @@ and then to the following argument.</p>
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Returns the empty form of <code>xs</code>.</p> <p>Returns the empty form of <code>xs</code>.</p>
<p>For example:</p>
<pre><code>(empty '(1 2 3 4)) <pre><code>(empty '(1 2 3 4))
;; =&gt; () =&gt; ()
(empty '[1 2 3 4]) (empty '[1 2 3 4])
;; =&gt; [] =&gt; []
</code></pre> </code></pre>
</p> </p>
@ -1907,9 +1911,8 @@ and then to the following argument.</p>
<p class="doc"> <p class="doc">
<p>Returns a list containing only the elements of <code>xs</code> that satisify <p>Returns a list containing only the elements of <code>xs</code> that satisify
predicate <code>p</code>.</p> predicate <code>p</code>.</p>
<p>For example:</p>
<pre><code>(filter (fn [x] (= 'a x)) '(a b a b a b a b)) <pre><code>(filter (fn [x] (= 'a x)) '(a b a b a b a b))
;; =&gt; (a a a a) =&gt; (a a a a)
</code></pre> </code></pre>
</p> </p>
@ -1930,10 +1933,9 @@ predicate <code>p</code>.</p>
(flatten l) (flatten l)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>flattens a list recursively.</p> <p>Flattens a list recursively.</p>
<p>For example:</p>
<pre><code>(flatten '(1 2 (3 (4)))) <pre><code>(flatten '(1 2 (3 (4))))
; =&gt; '(1 2 3 4) =&gt; '(1 2 3 4)
</code></pre> </code></pre>
</p> </p>
@ -1955,9 +1957,8 @@ predicate <code>p</code>.</p>
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Flips the arguments of a function <code>f</code>.</p> <p>Flips the arguments of a function <code>f</code>.</p>
<p>For example,</p>
<pre><code>((flip Symbol.prefix) 'Bar 'Foo) <pre><code>((flip Symbol.prefix) 'Bar 'Foo)
=&gt; ;; (Foo.Bar) =&gt; (Foo.Bar)
</code></pre> </code></pre>
</p> </p>
@ -2046,6 +2047,29 @@ predicate <code>p</code>.</p>
<p>prints all information associated with a symbol.</p> <p>prints all information associated with a symbol.</p>
<p>Example Usage:</p> <p>Example Usage:</p>
<pre><code>(info mysymbol) <pre><code>(info mysymbol)
</code></pre>
</p>
</div>
<div class="binder">
<a class="anchor" href="#kind">
<h3 id="kind">
kind
</h3>
</a>
<div class="description">
primitive
</div>
<p class="sig">
Dynamic
</p>
<span>
</span>
<p class="doc">
<p>prints the kind of a symbol.</p>
<p>Example Usage:</p>
<pre><code>(kind mysymbol)
</code></pre> </code></pre>
</p> </p>
@ -2142,25 +2166,6 @@ predicate <code>p</code>.</p>
</p> </p>
</div> </div>
<div class="binder">
<a class="anchor" href="#list-to-array-internal">
<h3 id="list-to-array-internal">
list-to-array-internal
</h3>
</a>
<div class="description">
dynamic
</div>
<p class="sig">
Dynamic
</p>
<pre class="args">
(list-to-array-internal xs acc)
</pre>
<p class="doc">
</p>
</div>
<div class="binder"> <div class="binder">
<a class="anchor" href="#list?"> <a class="anchor" href="#list?">
<h3 id="list?"> <h3 id="list?">
@ -2295,8 +2300,7 @@ predicate <code>p</code>.</p>
<p>Applies a function <code>f</code> to each element in the list or array <code>xs</code> and <p>Applies a function <code>f</code> to each element in the list or array <code>xs</code> and
returns a list dynamic data literal containing the result of the function returns a list dynamic data literal containing the result of the function
applications.</p> applications.</p>
<p>For example:</p> <pre><code>'(map symbol? '(a b c))
<pre><code class="language-clojure">'(map symbol? '(a b c))
=&gt; (true true true) =&gt; (true true true)
'(map (curry + 1) '(1 2 3)) '(map (curry + 1) '(1 2 3))
=&gt; (2 3 4) =&gt; (2 3 4)
@ -2875,10 +2879,9 @@ value through successive applications of <code>f</code>.</p>
(take n xs) (take n xs)
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Returns a list containing the first <code>n</code> eleements of a list.</p> <p>Returns a list containing the first <code>n</code> elements of a list.</p>
<p>For example:</p>
<pre><code>(take 3 '(1 2 3 4 5)) <pre><code>(take 3 '(1 2 3 4 5))
;; =&gt; (1 2 3) =&gt; (1 2 3)
</code></pre> </code></pre>
</p> </p>
@ -2925,9 +2928,8 @@ value through successive applications of <code>f</code>.</p>
<p>Applies <code>f</code> to a starting value <code>x</code>, then generates a sequence of values <p>Applies <code>f</code> to a starting value <code>x</code>, then generates a sequence of values
by successively applying <code>f</code> to the result <code>lim-1</code> times. by successively applying <code>f</code> to the result <code>lim-1</code> times.
Collects results in the structure given by <code>acc</code>.</p> Collects results in the structure given by <code>acc</code>.</p>
<p>For example:</p>
<pre><code>(unreduce (curry + 1) 0 10 (list)) <pre><code>(unreduce (curry + 1) 0 10 (list))
;; =&gt; (1 2 3 4 5 6 7 8 9 10) =&gt; (1 2 3 4 5 6 7 8 9 10)
</code></pre> </code></pre>
</p> </p>
@ -2995,22 +2997,21 @@ Collects results in the structure given by <code>acc</code>.</p>
</pre> </pre>
<p class="doc"> <p class="doc">
<p>Returns the <em>form</em> that results from applying a function <code>f</code> to each of <p>Returns the <em>form</em> that results from applying a function <code>f</code> to each of
the values supplied in <code>forms</code>.</p> the values supplied in <code>forms</code>.
<p>If the members of a single form are exhuasted, the result of the If the members of a single form are exhuasted, the result of the
applications thus far is returned, and any remaining members in the other applications thus far is returned, and any remaining members in the other
forms are ignored.</p> forms are ignored.</p>
<p>For example,</p>
<pre><code>(zip + '(1 2 3) '(4 5 6)) <pre><code>(zip + '(1 2 3) '(4 5 6))
;; =&gt; ((+ 1 4) (+ 2 5) (+ 3 6)) =&gt; ((+ 1 4) (+ 2 5) (+ 3 6))
</code></pre> </code></pre>
<p>It's important to note that zip operates on forms, and that the form <p>It's important to note that zip operates on forms, and that the form
returned by zip may not be evaluable by itself. For instance, to actually returned by zip may not be evaluable by itself. For instance, to actually
transform the result in the example above into something Carp can transform the result in the example above into something Carp can
evaluate, we need to wrap each member of the list in a <code>do</code>:</p> evaluate, we need to wrap each member of the list in a <code>do</code>:</p>
<pre><code>(append (list 'do) (zip + '(1 2 3) '(4 5 6))) <pre><code>(append (list 'do) (zip + '(1 2 3) '(4 5 6)))
;; =&gt; (do (+ 1 4) (+ 2 5) (+ 3 6)) =&gt; (do (+ 1 4) (+ 2 5) (+ 3 6))
(eval (append (list 'do) (zip + '(1 2 3) '(4 5 6)))) (eval (append (list 'do) (zip + '(1 2 3) '(4 5 6))))
;; =&gt; 9 ;; do returns the value of the last form in its body =&gt; 9 ;; do returns the value of the last form in its body
</code></pre> </code></pre>
</p> </p>