Skip to content

Commit

Permalink
Correct the documentation to reflect more general input type
Browse files Browse the repository at this point in the history
  • Loading branch information
kagalenko-m-b committed Dec 16, 2021
1 parent af9e1dc commit d3b92e8
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/signalcorr.jl
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ end
"""
crosscov!(r, x, y, lags; demean=true)
Compute the cross covariance function (CCF) between real-valued vectors or matrices
Compute the cross covariance function (CCF) between vectors or matrices
`x` and `y` at `lags` and store the result in `r`. `demean` specifies whether the
respective means of `x` and `y` should be subtracted from them before computing their
CCF.
Expand Down Expand Up @@ -343,7 +343,7 @@ end
"""
crosscov(x, y, [lags]; demean=true)
Compute the cross covariance function (CCF) between real-valued vectors or
Compute the cross covariance function (CCF) between vectors or
matrices `x` and `y`, optionally specifying the `lags`. `demean` specifies
whether the respective means of `x` and `y` should be subtracted from them
before computing their CCF.
Expand Down Expand Up @@ -384,7 +384,7 @@ crosscov(x::AbstractVecOrMat, y::AbstractVecOrMat; demean::Bool=true) =
"""
crosscor!(r, x, y, lags; demean=true)
Compute the cross correlation between real-valued vectors or matrices `x` and `y` at
Compute the cross correlation between vectors or matrices `x` and `y` at
`lags` and store the result in `r`. `demean` specifies whether the respective means of
`x` and `y` should be subtracted from them before computing their cross correlation.
Expand Down Expand Up @@ -504,7 +504,7 @@ end
"""
crosscor(x, y, [lags]; demean=true)
Compute the cross correlation between real-valued vectors or matrices `x` and `y`,
Compute the cross correlation between vectors or matrices `x` and `y`,
optionally specifying the `lags`. `demean` specifies whether the respective means of
`x` and `y` should be subtracted from them before computing their cross correlation.
Expand Down Expand Up @@ -613,7 +613,7 @@ end
"""
pacf(X, lags; method=:regression)
Compute the partial autocorrelation function (PACF) of a real-valued vector
Compute the partial autocorrelation function (PACF) of a vector
or matrix `X` at `lags`. `method` designates the estimation method. Recognized
values are `:regression`, which computes the partial autocorrelations via successive
regression models, and `:yulewalker`, which computes the partial autocorrelations
Expand Down

0 comments on commit d3b92e8

Please sign in to comment.