diff --git a/.gitignore b/.gitignore index fedd299ab..7fa5112b7 100644 --- a/.gitignore +++ b/.gitignore @@ -23,6 +23,7 @@ *.creator *.user *.orig +*.vscode *.cov diff --git a/src/dspbase.jl b/src/dspbase.jl index 0c4334946..11ea9db88 100644 --- a/src/dspbase.jl +++ b/src/dspbase.jl @@ -776,6 +776,18 @@ The size of the output depends on the padmode keyword argument: with padmode = With padmode = :longest the shorter of the arguments will be padded so they are equal length. This gives a result with length 2*max(length(u), length(v))-1, with the zero-lag condition at the center. + +# Examples + +```jldoctest +julia> xcorr([1,2,3],[1,2,3]) +5-element Vector{Int64}: + 3 + 8 + 14 + 8 + 3 +``` """ function xcorr( u::AbstractVector, v::AbstractVector; padmode::Symbol = :none