1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
|
\name{SparseArray-misc-methods}
\alias{SparseArray-misc-methods}
\alias{SparseArray_misc_methods}
\alias{SparseArray-misc}
\alias{SparseArray_misc}
\alias{is.na}
\alias{is.na,COO_SparseArray-method}
\alias{is.na,SVT_SparseArray-method}
\alias{is.nan}
\alias{is.nan,COO_SparseArray-method}
\alias{is.nan,SVT_SparseArray-method}
\alias{is.infinite}
\alias{is.infinite,COO_SparseArray-method}
\alias{is.infinite,SVT_SparseArray-method}
\alias{tolower}
\alias{tolower,COO_SparseArray-method}
\alias{toupper}
\alias{toupper,COO_SparseArray-method}
\alias{nchar}
\alias{nchar,COO_SparseArray-method}
\alias{pmin}
\alias{pmin,SparseArray-method}
\alias{pmax}
\alias{pmax,SparseArray-method}
\title{Miscellaneous operations on a SparseArray object}
\description{
This man page documents various base array operations that are
supported by \link{SparseArray} derivatives, and that didn't belong
to any of the groups of operations documented in the other man pages
of the \pkg{SparseArray} package.
}
\usage{
# --- unary isometric array transformations ---
\S4method{is.na}{COO_SparseArray}(x)
\S4method{is.na}{SVT_SparseArray}(x)
\S4method{is.nan}{COO_SparseArray}(x)
\S4method{is.nan}{SVT_SparseArray}(x)
\S4method{is.infinite}{COO_SparseArray}(x)
\S4method{is.infinite}{SVT_SparseArray}(x)
\S4method{tolower}{COO_SparseArray}(x)
\S4method{toupper}{COO_SparseArray}(x)
\S4method{nchar}{COO_SparseArray}(x, type="chars", allowNA=FALSE, keepNA=NA)
# --- N-ary isometric array transformations ---
\S4method{pmin}{SparseArray}(..., na.rm=FALSE)
\S4method{pmax}{SparseArray}(..., na.rm=FALSE)
}
\arguments{
\item{x}{
A \link{SparseArray} derivative.
}
\item{type, allowNA, keepNA}{
See \code{?base::\link[base]{nchar}} for a description of
these arguments.
}
\item{...}{
\link{SparseArray} derivatives.
}
\item{na.rm}{
See \code{?base::\link[base]{pmin}} for a description of
this argument.
}
}
\details{
More operations will be added in the future.
}
\value{
See man pages of the corresponding base functions (e.g.
\code{?base::\link[base]{is.na}}, \code{?base::\link[base]{nchar}},
\code{?base::\link[base]{pmin}}, etc...) for the value returned by
these methods.
Note that, like the base functions, the methods documented in this man page
are \emph{endomorphisms} i.e. they return an array-like object of the same
class as the input.
}
\seealso{
\itemize{
\item \code{base::\link[base]{is.na}} and
\code{base::\link[base]{is.infinite}} in base R.
\item \code{base::\link[base]{tolower}} in base R.
\item \code{base::\link[base]{nchar}} in base R.
\item \code{base::\link[base]{pmin}} in base R.
\item \link{SparseArray} objects.
\item Ordinary \link[base]{array} objects in base R.
}
}
\examples{
a <- array(c(0, 2.77, NA, 0, NaN, -Inf), dim=5:3)
svt <- SparseArray(a) # SVT_SparseArray object
class(svt)
is.na(svt) # SVT_SparseArray object of type "logical"
is.nan(svt) # SVT_SparseArray object of type "logical"
is.infinite(svt) # SVT_SparseArray object of type "logical"
svt1 <- poissonSparseMatrix(500, 20, density=0.2)
svt2 <- poissonSparseMatrix(500, 20, density=0.25) * 0.77
pmin(svt1, svt2)
pmax(svt1, svt2)
## Sanity checks:
res <- is.na(svt)
stopifnot(is(res, "SVT_SparseArray"), type(res) == "logical",
identical(as.array(res), is.na(a)))
res <- is.nan(svt)
stopifnot(is(res, "SVT_SparseArray"), type(res) == "logical",
identical(as.array(res), is.nan(a)))
res <- is.infinite(svt)
stopifnot(is(res, "SVT_SparseArray"), type(res) == "logical",
identical(as.array(res), is.infinite(a)))
res <- pmin(svt1, svt2)
stopifnot(is(res, "SVT_SparseArray"),
identical(as.array(res), pmin(as.array(svt1), as.array(svt2))))
res <- pmax(svt1, svt2)
stopifnot(is(res, "SVT_SparseArray"),
identical(as.array(res), pmax(as.array(svt1), as.array(svt2))))
}
\keyword{array}
\keyword{methods}
|