steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

deques: doc examples

db4
Björn Lindqvist 2014-08-06 16:57:40 +02:00 committed by John Benediktsson
parent c3253406e3
commit 16d32190ab
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
basis/deques/deques-docs.factor
View File

@ -5,7 +5,14 @@ IN: deques
HELP: deque-empty?
{ $values { "deque" deque } { "?" boolean } }
{ $contract "Returns true if a deque is empty." }
{ $notes "This operation is O(1)." } ;
{ $notes "This operation is O(1)." }
{ $examples
{ $example
"USING: deques prettyprint unrolled-lists ;"
"<unrolled-list> deque-empty? ."
"t"
}
} ;
HELP: clear-deque
{ $values
@ -26,7 +33,14 @@ HELP: push-front
HELP: push-front*
{ $values { "obj" object } { "deque" deque } { "node" "a node" } }
{ $contract "Push the object onto the front of the deque and return the newly created node." }
{ $notes "This operation is O(1)." } ;
{ $notes "This operation is O(1)." }
{ $examples
{ $example
"USING: deques dlists kernel prettyprint ;"
"33 <hashed-dlist> push-front* node-value ."
"33"
}
} ;
HELP: push-back
{ $values { "obj" object } { "deque" deque } }
@ -111,7 +125,14 @@ HELP: node-value
HELP: slurp-deque
{ $values
{ "deque" deque } { "quot" quotation } }
{ $description "Pops off the back element of the deque and calls the quotation in a loop until the deque is empty." } ;
{ $description "Pops off the back element of the deque and calls the quotation in a loop until the deque is empty." }
{ $examples
{ $example
"USING: deques dlists io kernel ;"
"{ \"one\" \"two\" \"three\" } <hashed-dlist> [ push-all-front ] keep [ print ] slurp-deque"
"one\ntwo\nthree"
}
} ;
ARTICLE: "deques" "Deques"
"The " { $vocab-link "deques" } " vocabulary implements the deque data structure which has constant-time insertion and removal of elements at both ends."