simon/beowulf
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
beowulf/docs/codox/beowulf.cons-cell.html

16 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>beowulf.cons-cell documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><link rel="icon" type="image/x-icon" href="../img/beowulf_logo_favicon.png" /></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Beowulf</span> <span class="project-version">0.3.1-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="further_reading.html"><div class="inner"><span>Further Reading</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>beowulf</span></div></a></li><li class="depth-1 "><a href="mexpr.html"><div class="inner"><span>Interpreting M-Expressions</span></div></a></li><li class="depth-1 "><a href="values.html"><div class="inner"><span>The properties of the system, and their values</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>beowulf</span></div></div></li><li class="depth-2 branch"><a href="beowulf.bootstrap.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>bootstrap</span></div></a></li><li class="depth-2 branch current"><a href="beowulf.cons-cell.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cons-cell</span></div></a></li><li class="depth-2 branch"><a href="beowulf.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="beowulf.gendoc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gendoc</span></div></a></li><li class="depth-2 branch"><a href="beowulf.host.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>host</span></div></a></li><li class="depth-2 branch"><a href="beowulf.interop.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>interop</span></div></a></li><li class="depth-2 branch"><a href="beowulf.io.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></a></li><li class="depth-2 branch"><a href="beowulf.manual.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>manual</span></div></a></li><li class="depth-2 branch"><a href="beowulf.oblist.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oblist</span></div></a></li><li class="depth-2 branch"><a href="beowulf.read.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>read</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>reader</span></div></div></li><li class="depth-3 branch"><a href="beowulf.reader.char-reader.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>char-reader</span></div></a></li><li class="depth-3 branch"><a href="beowulf.reader.generate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>generate</span></div></a></li><li class="depth-3 branch"><a href="beowulf.reader.macros.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>macros</span></div></a></li><li class="depth-3 branch"><a href="beowulf.reader.parser.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>parser</span></div></a></li><li class="depth-3"><a href="beowulf.reader.simplify.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>simplify</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="beowulf.cons-cell.html#var-cons-cell.3F"><div class="inner"><span>cons-cell?</span></div></a></li><li class="depth-1"><a href="beowulf.cons-cell.html#var-F"><div class="inner"><span>F</span></div></a></li><li class="depth-1"><a href="beowulf.cons-cell.html#var-make-beowulf-list"><div class="inner"><span>make-beowulf-list</span></div></a></li><li class="depth-1"><a href="beowulf.cons-cell.html#var-make-cons-cell"><div class="inner"><span>make-cons-cell</span></div></a></li><li class="depth-1"><a href="beowulf.cons-cell.html#var-MutableSequence"><div class="inner"><span>MutableSequence</span></div></a></li><li class="depth-2 branch"><a href="beowulf.cons-cell.html#var-getCar"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>getCar</span></div></a></li><li class="depth-2 branch"><a href="beowulf.cons-cell.html#var-getCdr"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>getCdr</span></div></a></li><li class="depth-2 branch"><a href="beowulf.cons-cell.html#var-getUid"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>getUid</span></div></a></li><li class="depth-2 branch"><a href="beowulf.cons-cell.html#var-rplaca"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rplaca</span></div></a></li><li class="depth-2"><a href="beowulf.cons-cell.html#var-rplacd"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rplacd</span></div></a></li><li class="depth-1"><a href="beowulf.cons-cell.html#var-pretty-print"><div class="inner"><span>pretty-print</span></div></a></li><li class="depth-1"><a href="beowulf.cons-cell.html#var-T"><div class="inner"><span>T</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">beowulf.cons-cell</h1><div class="doc"><div class="markdown"><p>The fundamental cons cell on which all Lisp structures are built. Lisp 1.5 lists do not necessarily have a sequence as their CDR, and must have both CAR and CDR mutable, so cannot be implemented on top of Clojure lists.</p>
</div></div><div class="public anchor" id="var-cons-cell.3F"><h3>cons-cell?</h3><div class="usage"><code>(cons-cell? o)</code></div><div class="doc"><div class="markdown"><p>Is this object <code>o</code> a beowulf cons-cell?</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L240">view source</a></div></div><div class="public anchor" id="var-F"><h3>F</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The canonical false value - different from <code>NIL</code>, which is not canonically false in Lisp 1.5.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L34">view source</a></div></div><div class="public anchor" id="var-make-beowulf-list"><h3>make-beowulf-list</h3><div class="usage"><code>(make-beowulf-list x)</code></div><div class="doc"><div class="markdown"><p>Construct a linked list of cons cells with the same content as the sequence <code>x</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L254">view source</a></div></div><div class="public anchor" id="var-make-cons-cell"><h3>make-cons-cell</h3><div class="usage"><code>(make-cons-cell car cdr)</code></div><div class="doc"><div class="markdown"><p>Construct a new instance of cons cell with this <code>car</code> and <code>cdr</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L245">view source</a></div></div><div class="public anchor" id="var-MutableSequence"><h3>MutableSequence</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><div class="markdown"><p>Like a sequence, but mutable.</p>
</div></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-getCar"><h3>getCar</h3><div class="usage"><code>(getCar this)</code></div><div class="doc"><div class="markdown"><p>Return the first element of this sequence.</p>
</div></div></div><div class="public anchor" id="var-getCdr"><h3>getCdr</h3><div class="usage"><code>(getCdr this)</code></div><div class="doc"><div class="markdown"><p>like <code>more</code>, q.v., but returns List <code>NIL</code> not Clojure <code>nil</code> when empty.</p>
</div></div></div><div class="public anchor" id="var-getUid"><h3>getUid</h3><div class="usage"><code>(getUid this)</code></div><div class="doc"><div class="markdown"><p>Returns a unique identifier for this object</p>
</div></div></div><div class="public anchor" id="var-rplaca"><h3>rplaca</h3><div class="usage"><code>(rplaca this value)</code></div><div class="doc"><div class="markdown"><p>replace the first element of this sequence with this value</p>
</div></div></div><div class="public anchor" id="var-rplacd"><h3>rplacd</h3><div class="usage"><code>(rplacd this value)</code></div><div class="doc"><div class="markdown"><p>replace the rest (but-first; cdr) of this sequence with this value</p>
</div></div></div></div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L41">view source</a></div></div><div class="public anchor" id="var-pretty-print"><h3>pretty-print</h3><div class="usage"><code>(pretty-print cell)</code><code>(pretty-print cell width level)</code></div><div class="doc"><div class="markdown"><p>This isn’t the world’s best pretty printer but it sort of works.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L206">view source</a></div></div><div class="public anchor" id="var-T"><h3>T</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The canonical true value.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/beowulf/blob/master/src/beowulf/cons_cell.clj#L30">view source</a></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink