volume.ellipsoid

0th

Percentile

Compute the Volume (of an Ellipsoid)

Compute the volume of geometric R object. This is a generic function and has a method for ellipsoid objects (typically resulting from ellipsoidhull().

Keywords
utilities
Usage
volume(object, …)
# S3 method for ellipsoid
volume(object, log = FALSE, …)
Arguments
object

an R object the volume of which is wanted; for the ellipsoid method, an object of that class (see ellipsoidhull or the example below).

log

logical indicating if the volume should be returned in log scale. Maybe needed in largish dimensions.

potential further arguments of methods, e.g. log.

Value

a number, the volume \(V\) (or \(\log(V)\) if log = TRUE) of the given object.

See Also

ellipsoidhull for spanning ellipsoid computation.

Aliases
  • volume
  • volume.ellipsoid
Examples
# NOT RUN {
## example(ellipsoidhull) # which defines 'ellipsoid' object <namefoo>

myEl <- structure(list(cov = rbind(c(3,1),1:2), loc = c(0,0), d2 = 10),
                   class = "ellipsoid")
volume(myEl)# i.e. "area" here (d = 2)
myEl # also mentions the "volume"

set.seed(1)
d5 <- matrix(rt(500, df=3), 100,5)
e5 <- ellipsoidhull(d5)
# }
Documentation reproduced from package cluster, version 2.1.0, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.