elf
/
cons-lists
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of github.com:elfsternberg/cons-lists 

* 'master' of github.com:elfsternberg/cons-lists:
  Prettier.
  Fixed an embarassing typo.
This commit is contained in:
Elf M. Sternberg 2015-06-27 10:45:37 -07:00
parent 279ba3e7a2 cf0a17ad5e
commit d00f70db64
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,4 +1,6 @@
# This library contains a javascript implementation of Lisp-like cons(), using vectors # A Javascript<sup>1</sup> implementation of Lisp-like cons(), using vectors
<sup>1</sup>Technically, Coffeescript, but it's just Javascript.
## Purpose ## Purpose
@ -9,14 +11,12 @@ managed repo.
## API ## API
A cons is a singly-link list consisting of *cells*, two-position A cons is a singly-link list consisting of *pairs*, two-position
objects. In a true cons *list*, the leftmost cell (the "car") contains objects. In a true cons *list*, the leftmost cell (the "car")
a data object of interest, and the rightmost cell (the "cdr") contains a contains a data object of interest, and the rightmost cell (the "cdr")
pointer to the next cell. (A cell in which the second object is not a contains a pointer to the next pair. Cons lists traditionally end
pointer to the next cell is called a *pair*.) Cons lists traditionally with a cdr object pointing to an empty list. The following functions
end with a cdr object pointing to an empty list. The following are provided to create, identify, traverse, and modify cons lists.
functions are provided to create, identify, traverse, and modify cons
lists.
nil: An empty list, used as a static sentinel nil: An empty list, used as a static sentinel
@ -32,18 +32,18 @@ cdr(lst): Return a reference to the next item in the list, or nil.
nilp(lst): (Boolean) is list an empty list? nilp(lst): (Boolean) is list an empty list?
pairp(lst): (Boolean) is this a cell object? pairp(obj): (Boolean) is this a object a pair?
listp(lst): (Boolean) is this a list object? listp(obj): (Boolean) is this object a list?
list(a, b, ...): Construct a list out of the arguments list(a, b, ...): Construct a list out of the arguments
vectorToList(v): Return a cons list from a vector. Recursive: if a vectorToList(v): Return a cons list given a vector. Recursive: if a
vector is encountered inside v, it will be converted to a cons list. vector is encountered inside v, it will be converted to a cons list.
listToVector(l): Return a vector given a cons list. Recursive: if listToVector(l): Return a vector given a cons list. Recursive: if
car(l) is a vector, the return list will contain a list at that car(l) is itself a cons list, the returned vector will contain an
position. internal vector at that position.
setcar(obj, l): Replace the contents of car(l) with obj setcar(obj, l): Replace the contents of car(l) with obj