@@ -1,6 +1,7 @@

-\name{ConnectionProducer-classes}

+\name{ConnectionProducer}

 \Rdversion{1.1}

 \docType{class}

+\alias{ConnectionProducer}

 \alias{ConnectionProducer-classes}

 \alias{ConnectionProducer-class}

 \alias{close.ConnectionProducer}

@@ -1,4 +1,4 @@

-\name{Consumer-class}

+\name{Consumer}

 \Rdversion{1.1}

 \docType{class}

 \alias{Consumer}

@@ -1,4 +1,4 @@

-\name{DAGTeam-class}

+\name{DAGTeam}

 \Rdversion{1.1}

 \docType{class}

 \alias{DAGTeam-class}

@@ -1,4 +1,4 @@

-\name{Downsample-class}

+\name{Downsample}

 \Rdversion{1.1}

 \docType{class}

 \alias{Downsample}

@@ -1,7 +1,8 @@

-\name{FunctionProducerConsumer-classes}

+\name{Function*}

 \Rdversion{1.1}

 \docType{class}

+\alias{Function*}

 \alias{FunctionProducerConsumer-classes}

 \alias{FunctionProducer}

 \alias{FunctionProducer-class}

@@ -1,4 +1,4 @@

-\name{ParallelParam-class}

+\name{ParallelParam}

 \Rdversion{1.1}

 \docType{class}

 \alias{ParallelParam-class}

@@ -1,4 +1,4 @@

-\name{Producer-class}

+\name{Producer}

 \Rdversion{1.1}

 \docType{class}

 \alias{Producer-class}

@@ -1,4 +1,4 @@

-\name{RawInput-class}

+\name{RawInput}

 \Rdversion{1.1}

 \docType{class}

@@ -1,4 +1,4 @@

-\name{Reducer-class}

+\name{Reducer}

 \Rdversion{1.1}

 \docType{class}

 \alias{Reducer}

@@ -1,4 +1,4 @@

-\name{Seq-class}

+\name{Seq}

 \Rdversion{1.1}

 \docType{class}

 \alias{Seq-class}

@@ -1,7 +1,13 @@

-\name{Stream-class}

+\name{Stream}

 \Rdversion{1.1}

 \docType{class}

 \alias{Stream-class}

+

+\alias{Stream}

+\alias{Stream-methods}

+\alias{Stream,Consumer-method}

+\alias{Stream,Producer-method}

+

 \alias{[[,Stream,numeric-method}

 \alias{length,Stream-method}

 \alias{lapply,Stream-method}

@@ -21,6 +27,8 @@

 }

 \usage{

+Stream(x, ..., verbose=FALSE)

+

 \S4method{length}{Stream}(x)

 \S4method{[[}{Stream,numeric}(x, i, j, ...)

@@ -32,15 +40,17 @@

 \arguments{

-  \item{x, X}{An instance of class \code{Stream}.}

- 

+  \item{x, X}{For \code{Stream}, \code{x} is a \code{Producer}

+  instance. For other functions, an instance of class \code{Stream}.}

+

   \item{FUN}{A function to be applied to each successful \code{yield()}

     of \code{X}.}

   \item{i, j}{Numeric index of the ith stream element (\code{j} is

     ignored by this method).}

-  \item{...}{For \code{lapply}, \code{sapply}, additional arguments to

+  \item{...}{For \code{Stream}, zero or more \code{Consumer}

+    instances. For \code{lapply}, \code{sapply}, additional arguments to

     \code{FUN}.}

   \item{simplify}{See \code{?base::sapply}.}

@@ -48,11 +58,26 @@

   \item{USE.NAMES}{See \code{?base::sapply} but note that names do not

     usually make sense for instances of class \code{Producer}.}

+  \item{verbose}{A \code{logical(1)} indicating whether status

+    information should be reported.}

+

 }

 \section{Constructors}{

-  Instances from this class are constructed with calls to \code{Stream};

-  see \code{?Stream}

+

+  Arguments to \code{Stream} must consist of a single \code{Producer}

+  and zero or more \code{Consumer} components.

+

+  When invoked with the \code{Producer} as the first argument,

+  \code{Stream(P, C1, C2)} produces a stream in which the data is read

+  by \code{P}, then processed by \code{C1}, then processed by \code{C2}.

+

+  When invoked with the \code{Consumer} as the first argument, the

+  \code{...} must include a \code{Producer} as the \emph{last}

+  argument. \code{Stream(C1, C2, P)} produces a stream in which the data

+  is read by \code{P}, then processed by \code{C2}, then processed by

+  \code{C1}.

+

 }

 \section{Methods}{

@@ -101,6 +126,18 @@

 }

-\examples{showClass("Stream")}

+\examples{

+fl <- system.file("extdata", "s_1_sequence.txt", package="Streamer")

+b <- RawInput(fl, 100L, reader=rawReaderFactory(1e4))

+s <- Stream(b, Rev(), RawToChar())

+s

+yield(s)

+reset(s)

+while (length(yield(s))) cat("tick\n")

+

+strm <- Stream(Seq(to=10), FunctionConsumer(function(y) 1/y))

+sapply(strm, c)

+}

+

 \keyword{classes}

deleted file mode 100644

@@ -1,42 +0,0 @@

-\name{Streamer-class}

-\Rdversion{1.1}

-\docType{class}

-\alias{Streamer-class}

-

-\title{Class defining methods shared by all classes}

-\description{

-

-  A virtual base class from which all classes in the Streamer package

-  derive.

-

-}

-

-\section{Methods}{

-

-  See \code{Stream}, \code{Producer}, and \code{Consumer} Methods.

-

-}

-

-\section{Internal Class Fields and Methods}{

-

-  Internal fields of this class are are described with, e.g.,

-  \code{getRefClass("Streamer")$fields}.

-

-  Internal methods of this class are described with

-  \code{getRefClass("Streamer")$methods()} and

-  \code{getRefClass("Streamer")$help()}.

-

-}

-

-\author{Martin Morgan \url{mtmorgan@fhcrc.org}}

-

-\seealso{

-

-  \code{\link{Streamer-package}}, \code{\linkS4class{Consumer}-class},

-  \code{\linkS4class{Producer}-class}, \code{\linkS4class{Stream}-class}.

-

-}

-

-\examples{showClass("Streamer")}

-

-\keyword{classes}

@@ -1,6 +1,7 @@

 \name{Streamer-package}

 \alias{Streamer-package}

 \alias{Streamer}

+\alias{Streamer-class}

 \docType{package}

 \title{Package to enable stream (iterative) processing of large data}

 \description{

@@ -1,4 +1,4 @@

-\name{Team-class}

+\name{Team}

 \Rdversion{1.1}

 \docType{class}

 \alias{Team-class}

@@ -1,6 +1,7 @@

-\name{Utility-class}

+\name{Utility}

 \Rdversion{1.1}

 \docType{class}

+\alias{Utility}

 \alias{Utility-classes}

 \alias{Utility-class}

 \alias{RawToChar}

deleted file mode 100644

@@ -1,61 +0,0 @@

-\name{Stream}

-

-\alias{Stream}

-\alias{Stream-methods}

-\alias{Stream,Consumer-method}

-\alias{Stream,Producer-method}

-

-\title{Function to create a Stream from a Producer and zero or more Consumers}

-

-\description{

-

-  \code{Stream} is used to create a stream from a single \code{Producer}

-  and zero or more \code{Consumer} instances.

-

-}

-

-\usage{

-Stream(x, ..., verbose=FALSE)

-}

-

-\arguments{

-  \item{x}{An instance of a \code{Consumer} or \code{Producer}}

-  \item{\dots}{Additional \code{Consumer} or \code{Producer} instances.}

-  \item{verbose}{A \code{logical(1)} indicating whether status

-    information should be reported.}

-}

-

-\details{

-

-  Arguments to \code{Stream} must consist of a single \code{Producer}

-  and zero or more \code{Consumer} components.

-

-  When invoked with the \code{Producer} as the first argument,

-  \code{Stream(P, C1, C2)} produces a stream in which the data is read

-  by \code{P}, then processed by \code{C1}, then processed by \code{C2}.

-

-  When invoked with the \code{Consumer} as the first argument, the

-  \code{...} must include a \code{Producer} as the \emph{last}

-  argument. \code{Stream(C1, C2, P)} produces a stream in which the data

-  is read by \code{P}, then processed by \code{C2}, then processed by

-  \code{C1}.

-

-}

-

-\value{An instance of class \code{\linkS4class{Stream}}.}

-

-\author{Martin Morgan \url{mtmorgan@fhcrc.org}}

-

-\seealso{\code{\link{yield}}, \code{\linkS4class{Stream}-class}.}

-

-\examples{

-fl <- system.file("extdata", "s_1_sequence.txt", package="Streamer")

-b <- RawInput(fl, 100L, reader=rawReaderFactory(1e4))

-s <- Stream(b, Rev(), RawToChar())

-s

-yield(s)

-reset(s)

-while (length(yield(s))) cat("tick\n")

-}

-

-\keyword{manip}