Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix documentation of vardim #407

Merged
merged 1 commit into from
Oct 3, 2018
Merged

fix documentation of vardim #407

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/cov.jl
View file
Open in desktop
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