We are hiring ! See our job offers.
https://github.com/cran/nacopula
Revision 161411bb86f97e5a8bd89091cd61d03a33c2761a authored by Martin Maechler on 06 February 2012, 00:00:00 UTC, committed by Gabor Csardi on 06 February 2012, 00:00:00 UTC
1 parent 5bc804b
Raw File
Tip revision: 161411bb86f97e5a8bd89091cd61d03a33c2761a authored by Martin Maechler on 06 February 2012, 00:00:00 UTC
version 0.8-0
Tip revision: 161411b
interval-class.Rd
\name{interval-class}
\Rdversion{1.1}
\docType{class}
\alias{interval-class}
\alias{maybeInterval-class}
%
\alias{format,interval-method}
\alias{show,interval-method}
\alias{\%in\%,numeric,interval-method}
\alias{Summary,interval-method}

\title{Class "interval" of simple Intervals}
\description{
  The S4 \code{\link{class}} \code{"interval"} is a simple class for numeric
  intervals.

  \code{"maybeInterval"} is a class union (see
  \code{\link{setClassUnion}}) of \code{"interval"} and \code{"NULL"}.
}
\section{Objects from the Class}{
  Objects can be created by calls of the form \code{new("interval", ...)},
  but typically they are built via \code{\link{interval}()}.
}
\section{Slots}{
  \describe{
    \item{\code{.Data}:}{numeric vector of length two, specifying the
      interval ranges.}
    \item{\code{open}:}{\code{\link{logical}} vector of length two,
      specifying if the interval is open or closed on the left and
      right, respectively.}
  }
}
\section{Extends}{
  Class \code{"interval"} extends \code{"\linkS4class{numeric}"}, from
  data part, and \code{"maybeInterval"}, directly.
}
\section{Methods}{
  \describe{
    \item{"\%in\%"}{\code{signature(x = "numeric", table = "interval")}:
      check if \code{x} is inside the interval, carefully differentiating
      open and closed intervals.}
    \item{format}{\code{signature(x = "interval")}: ... }
    \item{show}{\code{signature(object = "interval")}: ... }
    \item{Summary}{\code{signature(x = "interval")}: Group methods,
      notably \code{\link{range}()}, \code{\link{min}()}, etc.}
  }
}
\note{
  There are more sophisticated interval classes, functions and methods,
  notably in package \pkg{Intervals}.  We only use this as a simple
  interface in order to specify our copula functions consistently.
}
\author{Martin Maechler}
\seealso{
  \code{\link{interval}} constructs "interval" objects conveniently.
}
\examples{
-1:2 \%in\% interval("(0, Inf)")
## 0 is *not* inside
}
\keyword{classes}
back to top