basis/lists/lazy/lazy-docs.factor

   1 ! Copyright (C) 2006 Chris Double.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax sequences strings lists ;
   4 IN: lists.lazy
   5
   6 ABOUT: "lists.lazy"
   7
   8 ARTICLE: "lists.lazy" "Lazy lists"
   9 "The " { $vocab-link "lists.lazy" } " vocabulary implements lazy lists and standard operations to manipulate them."
  10 { $subsections
  11     { "lists.lazy" "construction" }
  12     { "lists.lazy" "manipulation" }
  13     { "lists.lazy" "combinators" }
  14     { "lists.lazy" "io" }
  15 } ;
  16
  17 ARTICLE: { "lists.lazy" "combinators" } "Combinators for manipulating lazy lists"
  18 "The following combinators create lazy lists from other lazy lists:"
  19 { $subsections
  20     lazy-map
  21     lfilter
  22     luntil
  23     lwhile
  24     lfrom-by
  25     lcomp
  26     lcomp*
  27 } ;
  28
  29 ARTICLE: { "lists.lazy" "io" } "Lazy list I/O"
  30 "Input from a stream can be read through a lazy list, using the following words:"
  31 { $subsections
  32     lcontents
  33     llines
  34 } ;
  35
  36 ARTICLE: { "lists.lazy" "construction" } "Constructing lazy lists"
  37 "Words for constructing lazy lists:"
  38 { $subsections
  39     lazy-cons
  40     1lazy-list
  41     2lazy-list
  42     3lazy-list
  43     sequence-tail>list
  44     >list
  45     lfrom
  46 } ;
  47
  48 ARTICLE: { "lists.lazy" "manipulation" } "Manipulating lazy lists"
  49 "To make new lazy lists from old ones:"
  50 { $subsections
  51     <memoized-cons>
  52     lappend
  53     lconcat
  54     lcartesian-product
  55     lcartesian-product*
  56     lmerge
  57     ltake
  58 } ;
  59
  60 HELP: lazy-cons
  61 { $values { "car" { $quotation "( -- elt )" } } { "cdr" { $quotation "( -- cons )" } } { "promise" "the resulting cons object" } }
  62 { $description "Constructs a cons object for a lazy list from two quotations. The " { $snippet "car" } " quotation should return the head of the list, and the " { $snippet "cons" } " quotation the tail when called. When " { $link cons } " or " { $link cdr } " are called on the lazy-cons object then the appropriate quotation is called." }
  63 { $see-also cons car cdr nil nil? } ;
  64
  65 { 1lazy-list 2lazy-list 3lazy-list } related-words
  66
  67 HELP: 1lazy-list
  68 { $values { "a" { $quotation "( -- X )" } } { "lazy-cons" "a lazy-cons object" } }
  69 { $description "Create a lazy list with 1 element. The element is the result of calling the quotation. The quotation is only called when the list element is requested." } ;
  70
  71 HELP: 2lazy-list
  72 { $values { "a" { $quotation "( -- X )" } } { "b" { $quotation "( -- X )" } } { "lazy-cons" "a lazy-cons object" } }
  73 { $description "Create a lazy list with 2 elements. The elements are the result of calling the quotations. The quotations are only called when the list elements are requested." } ;
  74
  75 HELP: 3lazy-list
  76 { $values { "a" { $quotation "( -- X )" } } { "b" { $quotation "( -- X )" } } { "c" { $quotation "( -- X )" } } { "lazy-cons" "a lazy-cons object" } }
  77 { $description "Create a lazy list with 3 elements. The elements are the result of calling the quotations. The quotations are only called when the list elements are requested." } ;
  78
  79 HELP: <memoized-cons>
  80 { $values { "cons" "a cons object" } { "memoized-cons" "the resulting memoized-cons object" } }
  81 { $description "Constructs a cons object that wraps an existing cons object. Requests for the car, cdr and nil? will be remembered after the first call, and the previous result returned on subsequent calls." }
  82 { $see-also cons car cdr nil nil? } ;
  83
  84 { lazy-map ltake lfilter lappend lfrom lfrom-by lconcat lcartesian-product lcartesian-product* lcomp lcomp* lmerge lwhile luntil } related-words
  85
  86 HELP: lazy-map
  87 { $values { "list" "a cons object" } { "quot" { $quotation "( obj -- X )" } } { "result" "resulting cons object" } }
  88 { $description "Perform a similar functionality to that of the " { $link map } " word, but in a lazy manner. No evaluation of the list elements occurs initially but a " { $link <lazy-map> } " object is returned which conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required." } ;
  89
  90 HELP: ltake
  91 { $values { "n" "a non negative integer" } { "list" "a cons object" } { "result" "resulting cons object" } }
  92 { $description "Outputs a lazy list containing the first n items in the list. This is done a lazy manner. No evaluation of the list elements occurs initially but a " { $link <lazy-take> } " object is returned which conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required." } ;
  93
  94 HELP: lfilter
  95 { $values { "list" "a cons object" } { "quot" { $quotation "( -- X )" } } { "result" "resulting cons object" } }
  96 { $description "Perform a similar functionality to that of the " { $link filter } " word, but in a lazy manner. No evaluation of the list elements occurs initially but a " { $link <lazy-filter> } " object is returned which conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required." } ;
  97
  98 HELP: lwhile
  99 { $values { "list" "a cons object" } { "quot" { $quotation "( X -- ? )" } } { "result" "resulting cons object" } }
 100 { $description "Outputs a lazy list containing the first items in the list as long as " { $snippet "quot" } " evaluates to t. No evaluation of the list elements occurs initially but a " { $link <lazy-while> } " object is returned with conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required." } ;
 101
 102 HELP: luntil
 103 { $values { "list" "a cons object" } { "quot" { $quotation "( X -- ? )" } } { "result" "resulting cons object" } }
 104 { $description "Outputs a lazy list containing the first items in the list until after " { $snippet "quot" } " evaluates to t. No evaluation of the list elements occurs initially but a " { $link <lazy-while> } " object is returned with conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required." } ;
 105
 106 HELP: lappend
 107 { $values { "list1" "a cons object" } { "list2" "a cons object" } { "result" "a lazy list of list2 appended to list1" } }
 108 { $description "Perform a similar functionality to that of the " { $link append } " word, but in a lazy manner. No evaluation of the list elements occurs initially but a " { $link <lazy-append> } " object is returned which conforms to the list protocol. Calling " { $link car } ", " { $link cdr } " or " { $link nil? } " on this will evaluate elements as required. Successive calls to " { $link cdr } " will iterate through list1, followed by list2." } ;
 109
 110 HELP: lfrom-by
 111 { $values { "n" "an integer" } { "quot" { $quotation "( -- n )" } } { "lazy-from-by" "a lazy list of integers" } }
 112 { $description "Return an infinite lazy list of values starting from n, with each successive value being the result of applying quot to n." } ;
 113
 114 HELP: lfrom
 115 { $values { "n" "an integer" } { "list" "a lazy list of integers" } }
 116 { $description "Return an infinite lazy list of incrementing integers starting from n." } ;
 117
 118 HELP: sequence-tail>list
 119 { $values { "index" "an integer 0 or greater" } { "seq" "a sequence" } { "list" "a list" } }
 120 { $description "Convert the sequence into a list, starting from " { $snippet "index" } "." }
 121 { $see-also >list } ;
 122
 123 HELP: >list
 124 { $values { "object" "an object" } { "list" "a list" } }
 125 { $description "Convert the object into a list. Existing lists are passed through intact, sequences are converted using " { $link sequence-tail>list } " and other objects cause an error to be thrown." }
 126 { $see-also sequence-tail>list } ;
 127
 128 { leach foldl lazy-map ltake lfilter lappend lfrom lfrom-by lconcat lcartesian-product lcartesian-product* lcomp lcomp* lmerge lwhile luntil } related-words
 129
 130 HELP: lconcat
 131 { $values { "list" "a list of lists" } { "result" "a list" } }
 132 { $description "Concatenates a list of lists together into one list." } ;
 133
 134 HELP: lcartesian-product
 135 { $values { "list1" "a list" } { "list2" "a list" } { "result" "list of cartesian products" } }
 136 { $description "Given two lists, return a list containing the cartesian product of those lists." } ;
 137
 138 HELP: lcartesian-product*
 139 { $values { "lists" "a list of lists" } { "result" "list of cartesian products" } }
 140 { $description "Given a list of lists, return a list containing the cartesian product of those lists." } ;
 141
 142 HELP: lcomp
 143 { $values { "list" "a list of lists" } { "quot" { $quotation "( seq -- X )" } } { "result" "the resulting list" } }
 144 { $description "Get the cartesian product of the lists in " { $snippet "list" } " and call " { $snippet "quot" } " call with each element from the cartesian product on the stack, the result of which is returned in the final " { $snippet "list" } "." } ;
 145
 146 HELP: lcomp*
 147 { $values { "list" "a list of lists" } { "guards" "a sequence of quotations with stack effect ( seq -- bool )" } { "quot" { $quotation "( seq -- X )" } } { "list" "the resulting list" } { "result" "a list" } }
 148 { $description "Get the cartesian product of the lists in " { $snippet "list" } ", filter it by applying each guard quotation to it and call " { $snippet "quot" } " call with each element from the remaining cartesian product items on the stack, the result of which is returned in the final " { $snippet "list" } "." }
 149 { $examples
 150   { $code "{ 1 2 3 } >list { 4 5 6 } >list 2list { [ first odd? ] } [ first2 + ] lcomp*" }
 151 } ;
 152
 153 HELP: lmerge
 154 { $values { "list1" "a list" } { "list2" "a list" } { "result" "lazy list merging list1 and list2" } }
 155 { $description "Return the result of merging the two lists in a lazy manner." }
 156 { $examples
 157   { $example "USING: lists lists.lazy prettyprint ;" "{ 1 2 3 } >list { 4 5 6 } >list lmerge list>array ." "{ 1 4 2 5 3 6 }" }
 158 } ;
 159
 160 HELP: lcontents
 161 { $values { "stream" "a stream" } { "result" string } }
 162 { $description "Returns a lazy list of all characters in the file. " { $link car } " returns the next character in the file, " { $link cdr } " returns the remaining characters as a lazy list. " { $link nil? } " indicates end of file." }
 163 { $see-also llines } ;
 164
 165 HELP: llines
 166 { $values { "stream" "a stream" } { "result" "a list" } }
 167 { $description "Returns a lazy list of all lines in the file. " { $link car } " returns the next lines in the file, " { $link cdr } " returns the remaining lines as a lazy list. " { $link nil? } " indicates end of file." }
 168 { $see-also lcontents } ;