man/push.Rd

   1 \name{stackqueue}
   2 \alias{stackqueue}
   3 \alias{push}
   4 \alias{pop}
   5 \alias{mpush}
   6 \alias{top}
   7 \alias{isEmpty}
   8
   9 %- Also NEED an '\alias' for EACH other topic documented here.
  10 \title{Operations on Stacks/Queues}
  11 \description{
  12   Functions for interacting with stack and queue data structures
  13   implemented using \code{filehash} databases.
  14 }
  15 \usage{
  16 push(db, val, ...)
  17 mpush(db, vals, ...)
  18 pop(db, ...)
  19 top(db, ...)
  20 isEmpty(db, ...)
  21 }
  22 %- maybe also 'usage' for other objects documented here.
  23 \arguments{
  24   \item{db}{an object of class \code{"stack"} or \code{"queue"}}
  25   \item{val}{an R object}
  26   \item{vals}{a list of R objects}
  27   \item{\dots}{arguments passed to other methods}
  28 }
  29 \details{
  30   Note that for \code{mpush}, if \code{vals} is not a list it will be
  31   coerced to a list via \code{as.list}.  Currently, \code{mpush} is only
  32   implemented for \code{"stack"}s.
  33 }
  34 \value{
  35   \code{push} and \code{mpush} return nothing useful; \code{pop} returns
  36   a value from the stack/queue and deletes that value from the
  37   stack/queue; \code{top} returns the "top" value from the stack/queue;
  38   \code{isEmpty} returns \code{TRUE}/\code{FALSE} depending on whether
  39   the stack/queue is empty or not.  Both \code{pop} and \code{top}
  40   signal an error if the stack/queue is empty.
  41 }
  42 \author{Roger D. Peng \email{rpeng@jhsph.edu}}
  43 \keyword{database}% __ONLY ONE__ keyword per line