hankel: Hankel matrices operations.

Description Usage Arguments Details References See Also Examples

View source: R/hankel.R

Description

A set of routines to operate on Hankel matrices stored in compact FFT-based form.

Usage

1
2
3
4
5
6
7
new.hmat(F, L = (N + 1)%/%2, circular = FALSE, wmask = NULL,
         fmask = NULL, weights = NULL, fft.plan = NULL)
is.hmat(h)
hcols(h)
hrows(h)
hmatmul(hmat, v, transposed = FALSE)
hankel(X, L)

Arguments

F

series to construct the trajectory matrix for.

fft.plan

internal hint argument, should be NULL in most cases

wmask, fmask, weights

special parameters for shaped SSA case (see ssa). wmask and fmask are logical vectors, window and factor masks respectively. weights is integer vector which denotes hankel weights for array elements. If 'NULL', parameters for simple 1D SSA case are used.

circular

logical vector of one element, describes series topology. 'TRUE' means circularity by time.

L

the window length.

h, hmat

matrix to operate on.

transposed

logical, if 'TRUE' the multiplication is performed with the transposed matrix.

v

vector to multiply with.

X

series to construct the trajectory matrix for or matrix for hankelization

Details

Fast Fourier Transform provides a very efficient matrix-vector multiplication routine for Hankel matrices. See the paper in 'References' for the details of the algorithm.

References

Korobeynikov, A. (2010) Computation- and space-efficient implementation of SSA. Statistics and Its Interface, Vol. 3, No. 3, Pp. 257-268

See Also

Rssa for an overview of the package, as well as, ssa, decompose,

Examples

1
2
3
4
5
# Construct the Hankel trajectory matrix for 'co2' series
h <- new.hmat(co2, L = 10)
# Print number of columns and rows
print(hrows(h))
print(hcols(h))

Rssa documentation built on May 29, 2017, 5:33 p.m.

Search within the Rssa package
Search all R packages, documentation and source code