dimforge / dimforge/nalgebra

Documentation does not specify if variance is population or sample

Open
#1,485 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
4.8k
Forks
565
PR merge metrics
No merged PRs in 30d

Description

Hello, just a small suggestion here to specify in the documentation that `Matrix::variance` is calculating the population variance and not the sample variance. Coming from an R background, I was surprised when `Matrix::row_variance` didn't return the same values as R's `var`.

Simply changing the doc comment from "The variance of all the elements of this matrix" to "The *population* variance of all the elements of this matrix" might have helped my confusion.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.