Skip to content

Commit

Permalink
Improve docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
n3vu0r committed Jan 20, 2025
1 parent c5f9390 commit 2963beb
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1403,8 +1403,14 @@ pub enum VariableError {
///
/// Requirements are:
///
/// * $`\nu\ge 0`$ for absolute covariance matrix, and
/// * $`\nu\ge 1`$ for relative covariance matrix.
/// * $`\nu\ge 0`$ for a fully known [`Covariance`],
/// * $`\nu\ge 1`$ for a [`Covariance::with_unknown_scale()`].
///
/// There must be at least one parameter to fit against a sample of at least one observation,
/// leading to the requirement $`\nu\ge 0`$. For a [`Covariance::with_unknown_scale()`], the
/// [`Parameter::covariance`] matrix is being multiplied by $`\chi_\nu^2\equiv\chi^2/\nu`$ which
/// would be infinite without another observation due to division by zero, leading to the
/// requirement $`\nu\ge 1`$.
#[display("insufficient degrees of freedom")]
InsufficientDegreesOfFreedom,
}
Expand Down Expand Up @@ -1464,7 +1470,7 @@ pub enum ParameterError {
CorrelationRequiresDeviation,
}

/// Algorithm displays.
/// Algorithm errors.
#[derive(Debug, Display, Error, PartialEq, Eq, Clone, Copy)]
#[non_exhaustive]
pub enum AlgorithmError {
Expand Down

0 comments on commit 2963beb

Please sign in to comment.