Skip to content

Commit

Permalink
fix documentation of vardim (JuliaLang#407)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesonquinn authored and matbesancon committed Oct 3, 2018
1 parent 1ccb352 commit a14f71d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/cov.jl
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ scattermat_zm(x::DenseMatrix, wv::AbstractWeights, vardim::Int) =
_symmetrize!(unscaled_covzm(x, _scalevars(x, values(wv), vardim), vardim))

"""
scattermat(X, [wv::AbstractWeights]; mean=nothing, vardim=1)
scattermat(X, [wv::AbstractWeights,] vardim=1; mean=nothing)
Compute the scatter matrix, which is an unnormalized covariance matrix.
A weighting vector `wv` can be specified to weight
Expand All @@ -49,7 +49,7 @@ function scattermat end


"""
cov(X, w::AbstractWeights; mean=nothing, vardim=1, corrected=false)
cov(X, w::AbstractWeights, vardim=1; mean=nothing, corrected=false)
Compute the weighted covariance matrix. Similar to `var` and `std` the biased covariance
matrix (`corrected=false`) is computed by multiplying `scattermat(X, w)` by
Expand All @@ -64,7 +64,7 @@ cov


"""
mean_and_cov(x, [wv::AbstractWeights]; vardim=1, corrected=false) -> (mean, cov)
mean_and_cov(x, [wv::AbstractWeights,] vardim=1; corrected=false) -> (mean, cov)
Return the mean and covariance matrix as a tuple. A weighting
vector `wv` can be specified. `vardim` that designates whether
Expand Down

0 comments on commit a14f71d

Please sign in to comment.