MINI MINI MANI MO

%
% Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
%
\name{ore.number-class}
\docType{class}
\alias{ore.number}
\alias{ore.number-class}
\alias{ore.integer}
\alias{ore.integer-class}
\alias{ore.numeric}
\alias{ore.numeric-class}
\alias{Arith,number,ore.number-method}
\alias{Arith,ore.number,missing-method}
\alias{Arith,ore.number,number-method}
\alias{Arith,ore.number,ore.number-method}
\alias{Math,ore.number-method}
\alias{atan2,ore.number,ore.number-method}
\alias{besselI,ore.number-method}
\alias{besselJ,ore.number-method}
\alias{besselK,ore.number-method}
\alias{besselY,ore.number-method}
\alias{cut,ore.number-method}
\alias{diff,ore.number-method}
\alias{factorial,ore.number-method}
\alias{is.finite,ore.number-method}
\alias{is.finite,ore.numeric-method}
\alias{is.infinite,ore.number-method}
\alias{is.infinite,ore.numeric-method}
\alias{is.na,ore.numeric-method}
\alias{is.nan,ore.number-method}
\alias{is.nan,ore.numeric-method}
\alias{lfactorial,ore.number-method}
\alias{log,ore.number-method}
\alias{logb,ore.number-method}
\alias{mean,ore.number-method}
\alias{round,ore.number-method}
\alias{scale,ore.number-method}
\alias{summary,ore.number-method}
\alias{tabulate,ore.number-method}
\alias{zapsmall,ore.number-method}
\title{Class \code{ore.number}}
\description{
  The \code{ore.number} subclasses \code{ore.integer} and
  \code{ore.numeric} represent \code{\link[base]{integer}} and
  \code{\link[base]{numeric}} data columns in Oracle R Enterprise.
}
\section{Group Generics}{
  \code{ore.number} objects have support for S4 group generic
  functionality:
  \describe{
    \item{\code{Arith}}{\code{"+"}, \code{"-"}, \code{"*"}, \code{"^"},
      \code{"\%\%"}, \code{"\%/\%"}, \code{"/"}}
    \item{\code{Compare}}{\code{"=="}, \code{">"}, \code{"<"}, \code{"!="}, 
      \code{"<="}, \code{">="}}
    \item{\code{Logic}}{\code{"&"}, \code{"|"}}
    \item{\code{Ops}}{\code{"Arith"}, \code{"Compare"}, \code{"Logic"}}
    \item{\code{Math}}{\code{"abs"}, \code{"sign"}, \code{"sqrt"},
      \code{"ceiling"}, \code{"floor"}, \code{"trunc"}, \code{"cummax"},
      \code{"cummin"}, \code{"cumprod"}, \code{"cumsum"}, \code{"log"},
      \code{"log10"}, \code{"log2"}, \code{"log1p"}, \code{"acos"},
      \code{"acosh"}, \code{"asin"}, \code{"asinh"}, \code{"atan"},
      \code{"atanh"}, \code{"exp"}, \code{"expm1"}, \code{"cos"},
      \code{"cosh"}, \code{"sin"}, \code{"sinh"}, \code{"tan"}, \code{"tanh"},
      \code{"gamma"}, \code{"lgamma"}, \code{"digamma"}, \code{"trigamma"}}
    \item{\code{Math2}}{\code{"round"}, \code{"signif"}}
    \item{\code{Summary}}{\code{"max"}, \code{"min"}, \code{"range"},
      \code{"prod"}, \code{"sum"}, \code{"any"}, \code{"all"}}
  }
  See \link[methods]{S4groupGeneric} for more details.
}
\section{Numerical Data Methods}{
  \describe{
    \item{}{
      \code{\link[base]{cut}(x, breaks, labels = NULL,
        include.lowest = FALSE, right = TRUE, dig.lab = 3L, ...)}:
      Returns an \code{ore.vector} object containing a categorical
      representation of \code{x}-based interval ranges. When
      \code{labels} is \code{FALSE}, the output is an \code{ore.integer}
      object; otherwise returns an \code{ore.factor} object.
      \describe{
         \item{\code{breaks}}{Either a numeric vector of two or more
           distinct cut points or an integer value greater than or equal
           to 2 that specifies the number of intervals to create.}
         \item{\code{labels}}{Either a character vector containing the
           labels for the resulting categories, the logical value
           \code{FALSE} to specify an integer coding for the intervals,
           or \code{NULL} to construct labels using \code{(a,b]} or
           \code{[a,b)} interval notation.}
         \item{\code{include.lowest}}{A logical value indicating if the
           lowest (when argument \code{right} is \code{TRUE}) or highest
           (when argument \code{right} is \code{FALSE}) interval should
           be closed, i.e. of the form \code{[a,b]}.}
         \item{\code{right}}{A logical value indicating if the half-open
           intervals should be closed on the right or left.}
         \item{\code{dig.lab}}{When argument \code{labels} is
           \code{NULL}, the number of digits to use in the formatting of
           the break numbers in the labels.}
      }
    }
    \item{}{
      \code{\link[base]{diff}(x, lag = 1, differences = 1)}:
      Returns suitably lagged and iterated differences of argument
      \code{x}.
      \describe{
         \item{\code{lag}}{An integer indicating which lag to use.}
         \item{\code{differences}}{An integer indicating the order of the
           difference.}
      }
    }
    \item{}{
      \code{\link[base]{is.finite}(x)}:
      Returns an \code{\linkS4class{ore.logical}} object indicating
      which values in argument \code{x} contain finite numbers.
    }
    \item{}{
      \code{\link[base]{is.infinite}(x)}:
      Returns an \code{\linkS4class{ore.logical}} object indicating
      which values in argument \code{x} contain infinite numbers.
    }
    \item{}{
      \code{\link[base]{is.nan}(x)}:
      Returns an \code{\linkS4class{ore.logical}} object indicating
      which values in argument \code{x} contain not-a-number values.
    }
    \item{}{
      \code{\link[base]{scale}(x, center = TRUE, scale = TRUE)}:
      Returns an \code{\linkS4class{ore.number}} object containing the
      possibly centered and scaled version of argument \code{x}.
    }
    \item{}{
      \code{\link[base]{tabulate}(bin, nbins = max(1, bin, na.rm = TRUE))}:
      Returns an \code{\link[base]{integer}} vector containing counts of
      the number of times each integer occurs in argument \code{bin}.
    }
    \item{}{
      \code{\link[base]{zapsmall}(x, digits = getOption("digits"))}:
      Returns an \code{ore.number} object where values close to 0 are
      replaced with 0.
    }
  }
}
\references{
  \href{http://www.oracle.com/technetwork/database/database-technologies/r/r-enterprise/documentation/index.html}{Oracle R Enterprise}
}
\author{
  Oracle \email{oracle-r-enterprise@oracle.com}
}
\note{
  See the corresponding \R documentation for the functions listed above.
}
\seealso{
  \code{\linkS4class{ore}},
  \code{\linkS4class{ore.character}},
  \code{\linkS4class{ore.datetime}},
  \code{\linkS4class{ore.factor}},
  \code{\linkS4class{ore.frame}},
  \code{\linkS4class{ore.logical}},
  \code{\linkS4class{ore.matrix}},
  \code{\linkS4class{ore.vector}}
}
\examples{
v <- c(2, 4, 4, 7, 7)
V <- ore.push(v)
V
log(V)
tabulate(V)
}
\keyword{classes}
\keyword{ORE}