Merge pull request #175 from dzoep/racket-list-deforestation

Racket list deforestation

Author: dzoep

qi-doc/scribblings/list-operations.scrbl

@@ -0,0 +1,118 @@
+#lang scribble/doc
+@require[scribble/manual
+	 (for-label racket/list
+	 	    racket/base)]
+
+@title{List Operations}
+
+@defmodule[qi/list]
+
+This module defines bindings that can leverage stream fusion /
+deforestation optimization when found in succession within a
+flow. When not part of optimized flow, their behavior is identical to
+the bindings of the same name from @racketmodname[racket/base] and
+@racketmodname[racket/list].
+
+The bindings are categorized based on their intended usage inside the
+deforested pipeline.
+
+@section{Producers}
+
+@defproc*[(((range (end real?)) list?)
+           ((range (start real?) (end real?) (step real? 1)) list?))]{
+
+Deforestable version of @racket[range] from @racketmodname[racket/list].
+
+}
+
+@section{Transformers}
+
+@defproc[(filter (pred procedure?) (lst list?)) list?]{
+
+Deforestable version of @racket[filter] from @racketmodname[racket/base].
+
+}
+
+@defproc[(map (proc procedure?) (lst list?) ...+) list?]{
+
+Deforestable version of @racket[map] from @racketmodname[racket/base].
+
+}
+
+@defproc[(filter-map (proc procedure?) (lst list?) ...+) list?]{
+
+Deforestable version of @racket[filter-map] from @racketmodname[racket/list].
+
+}
+
+@defproc*[(((take (lst list?) (pos exact-nonnegative-integer?)) list?)
+           ((take (lst any/c) (pos exact-nonnegative-integer?)) list?))]{
+
+Deforestable version of @racket[take] from @racketmodname[racket/list].
+
+}
+
+@section{Consumers}
+
+@defproc[(foldl (proc procedure?) (init any/c) (lst list?) ...+) any/c]{
+
+Deforestable version of @racket[foldl] from @racketmodname[racket/base].
+
+}
+
+@defproc[(foldr (proc procedure?) (init any/c) (lst list?) ...+) any/c]{
+
+Deforestable version of @racket[foldr] from @racketmodname[racket/base].
+
+}
+
+@defproc[(car (p pair?)) any/c]{
+
+Deforestable version of @racket[car] from @racketmodname[racket/base].
+
+}
+
+@defproc[(cadr (v (cons/c any/c pair?))) any/c]{
+
+Deforestable version of @racket[cadr] from @racketmodname[racket/base].
+
+}
+
+@defproc[(caddr (v (cons/c any/c (cons/c any/c pair?)))) any/c]{
+
+Deforestable version of @racket[caddr] from @racketmodname[racket/base].
+
+}
+
+@defproc[(cadddr (v (cons/c any/c (cons/c any/c (cons/c any/c pair?))))) any/c]{
+
+Deforestable version of @racket[cadddr] from @racketmodname[racket/base].
+
+}
+
+@defproc*[(((list-ref (lst list?) (pos exact-nonnegative-integer?)) any/c)
+ 	   ((list-ref (lst pair?) (pos exact-nonnegative-integer?)) any/c))]{
+
+Deforestable version of @racket[list-ref] from @racketmodname[racket/base].
+
+}
+
+@defproc[(length (lst list?)) exact-nonnegative-integer?]{
+
+Deforestable version of @racket[length] from @racketmodname[racket/base].
+
+}
+
+@defproc[(empty? (v any/c)) boolean?]{
+
+Deforestable version of @racket[empty?] from @racketmodname[racket/list].
+
+}
+
+@defproc[(null? (v any/c)) boolean?]{
+
+Deforestable version of @racket[null?] from @racketmodname[racket/base].
+
+}
+
+

qi-doc/scribblings/qi.scrbl

@@ -40,6 +40,7 @@ This site hosts @emph{user} documentation. If you are interested in contributing
 @include-section["tutorial.scrbl"]
 @include-section["interface.scrbl"]
 @include-section["forms.scrbl"]
+@include-section["list-operations.scrbl"]
 @include-section["macros.scrbl"]
 @include-section["field-guide.scrbl"]
 @include-section["principles.scrbl"]