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
|
\name{Math.fv}
\alias{Math.fv}
\alias{Ops.fv}
\alias{Complex.fv}
\alias{Summary.fv}
\title{S3 Group Generic Methods for Function Tables}
\description{
These are group generic methods for objects of class \code{"fv"}, which
allows for usual mathematical functions and operators to be applied
directly to function tables. See Details for a list of implemented functions.
}
\usage{
## S3 methods for group generics have prototypes:
\special{Math(x, \dots)}
\special{Ops(e1, e2)}
\special{Complex(z)}
\special{Summary(\dots, na.rm=FALSE, drop=TRUE)}
%NAMESPACE S3method("Math", "fv")
%NAMESPACE S3method("Ops", "fv")
%NAMESPACE S3method("Complex", "fv")
%NAMESPACE S3method("Summary", "fv")
}
\arguments{
\item{x, z, e1, e2}{objects of class \code{"fv"}.}
\item{\dots}{further arguments passed to methods.}
\item{na.rm}{
Logical value specifying whether missing values
should be removed.
}
}
\details{
Below is a list of mathematical functions and operators which are
defined for objects of class \code{"fv"}.
The methods are implemented using \code{\link{eval.fv}}, which tries
to harmonise the functions via \code{\link{harmonise.fv}} if they aren't
compatible to begin with.
\enumerate{
\item Group \code{"Math"}:
\itemize{
\item
\code{abs}, \code{sign}, \code{sqrt},\cr
\code{floor}, \code{ceiling}, \code{trunc},\cr
\code{round}, \code{signif}
\item
\code{exp}, \code{log}, \code{expm1}, \code{log1p},\cr
\code{cos}, \code{sin}, \code{tan},\cr
\code{cospi}, \code{sinpi}, \code{tanpi},\cr
\code{acos}, \code{asin}, \code{atan}
\code{cosh}, \code{sinh}, \code{tanh},\cr
\code{acosh}, \code{asinh}, \code{atanh}
\item
\code{lgamma}, \code{gamma}, \code{digamma}, \code{trigamma}
\item \code{cumsum}, \code{cumprod}, \code{cummax}, \code{cummin}
}
\item Group \code{"Ops"}:
\itemize{
\item
\code{"+"}, \code{"-"}, \code{"*"}, \code{"/"},
\code{"^"}, \code{"\%\%"}, \code{"\%/\%"}
\item \code{"&"}, \code{"|"}, \code{"!"}
\item \code{"=="}, \code{"!="},
\code{"<"}, \code{"<="}, \code{">="}, \code{">"}
}
\item Group \code{"Summary"}:
\itemize{
\item \code{all}, \code{any}
\item \code{sum}, \code{prod}
\item \code{min}, \code{max}
\item \code{range}
}
\item Group \code{"Complex"}:
\itemize{
\item \code{Arg}, \code{Conj}, \code{Im}, \code{Mod}, \code{Re}
}
}
For the \code{Ops} group, one of the arguments is permitted to be
a single atomic value instead of a function table.
}
\seealso{
\code{\link{eval.fv}} for evaluating expressions involving function tables.
}
\examples{
## Convert K function to L function
K <- Kest(cells)
L <- sqrt(K/pi)
## Manually calculate J function
FR <- Fest(redwood)
GR <- Gest(redwood)
suppressWarnings(JR <- (1-GR)/(1-FR))
}
\author{
\spatstatAuthors.
}
\keyword{spatial}
\keyword{methods}
|