Skip to contents

Summarize fast transform

Source: R/ft_s3methods.R
summary.FastTransform.Rd

Provides a summary of a fast transform created by fort() with slightly more detail than the information provided by using print().

Usage

# S3 method for FastTransform
summary(object, ...)

Arguments

object

An object of class FastTransform, created using fort().

...

Extra parameters (ignored).

Value

The input object (invisibly).

See also

fort()

Examples

summary(fort(3, 17))
#> fort linear operation: R^3 -> [R^32 -> fft2 -> R^32] -> R^17
#>  ~ input: 3-dimensional column vector(s) (3 x N matrix)
#>  ~ output: 17-dimensional column vector(s) (17 x N matrix)
#>  ~ type: fft2/FastTransformFFT2 (with an internal blocksize of 32)
#>  ~ number of parameters: 145 (instead of 51)
#>  ~ apply transform to X via: W %*% X, if W is this object and X is a 3 x N matrix