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

Fix several rustdoc warnings #271

Merged
merged 1 commit into from
Sep 6, 2024
Merged

Fix several rustdoc warnings #271

Show file tree
Hide file tree
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
10 changes: 3 additions & 7 deletions src/distribution/gamma.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,15 +365,11 @@ impl Continuous<f64, f64> for Gamma {
}
/// Samples from a gamma distribution with a shape of `shape` and a
/// rate of `rate` using `rng` as the source of randomness. Implementation from:
/// <br />
/// <div>
/// <i>"A Simple Method for Generating Gamma Variables"</i> - Marsaglia & Tsang
/// </div>
/// <div>
///
/// _"A Simple Method for Generating Gamma Variables"_ - Marsaglia & Tsang
///
/// ACM Transactions on Mathematical Software, Vol. 26, No. 3, September 2000,
/// Pages 363-372
/// </div>
/// <br />
pub fn sample_unchecked<R: Rng + ?Sized>(rng: &mut R, shape: f64, rate: f64) -> f64 {
let mut a = shape;
let mut afix = 1.0;
Expand Down
16 changes: 5 additions & 11 deletions src/distribution/hypergeometric.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ use std::f64;
/// Implements the
/// [Hypergeometric](http://en.wikipedia.org/wiki/Hypergeometric_distribution)
/// distribution
///
/// # Examples
///
/// ```
/// ```
// TODO: Add examples
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub struct Hypergeometric {
population: u64,
Expand Down Expand Up @@ -155,9 +151,8 @@ impl DiscreteCDF<u64, f64> for Hypergeometric {
/// ```
///
/// where `N` is population, `K` is successes, `n` is draws,
/// and `p_F_q` is the [generalized hypergeometric
/// function](https://en.wikipedia.
/// org/wiki/Generalized_hypergeometric_function)
/// and `p_F_q` is the
/// [generalized hypergeometric function](https://en.wikipedia.org/wiki/Generalized_hypergeometric_function)
///
/// Calculated as a discrete integral over the probability mass
/// function evaluated from 0..x+1
Expand Down Expand Up @@ -189,9 +184,8 @@ impl DiscreteCDF<u64, f64> for Hypergeometric {
/// ```
///
/// where `N` is population, `K` is successes, `n` is draws,
/// and `p_F_q` is the [generalized hypergeometric
/// function](https://en.wikipedia.
/// org/wiki/Generalized_hypergeometric_function)
/// and `p_F_q` is the
/// [generalized hypergeometric function](https://en.wikipedia.org/wiki/Generalized_hypergeometric_function)
///
/// Calculated as a discrete integral over the probability mass
/// function evaluated from (x+1)..max
Expand Down
26 changes: 9 additions & 17 deletions src/function/exponential.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,18 @@ use crate::{consts, Result, StatsError};
/// # Remarks
///
/// This implementation follows the derivation in
/// <br />
/// <div>
/// <i>"Handbook of Mathematical Functions, Applied Mathematics Series, Volume
/// 55"</i> - Abramowitz, M., and Stegun, I.A 1964
/// </div>
///
/// _"Handbook of Mathematical Functions, Applied Mathematics Series, Volume
/// 55"_ - Abramowitz, M., and Stegun, I.A 1964
///
/// AND
/// <br />
/// <div>
/// <i>"Advanced mathematical methods for scientists and engineers" - Bender,
/// Carl M.; Steven A. Orszag (1978). page 253
/// </div>
/// <br />
/// The continued fraction approac is used for `x > 1.0` while the taylor
/// series expansions
/// is used for `0.0 < x <= 1`
///
/// # Examples
/// _"Advanced mathematical methods for scientists and engineers"_ - Bender,
/// Carl M.; Steven A. Orszag (1978). page 253
///
/// ```
/// ```
/// The continued fraction approach is used for `x > 1.0` while the taylor
/// series expansions is used for `0.0 < x <= 1`.
// TODO: Add examples
pub fn integral(x: f64, n: u64) -> Result<f64> {
let eps = 0.00000000000000001;
let max_iter = 100;
Expand Down
4 changes: 2 additions & 2 deletions src/stats_tests/fisher.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ fn binary_search(
}

/// Perform a Fisher exact test on a 2x2 contingency table.
/// Based on scipy's fisher test: https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.fisher_exact.html#scipy-stats-fisher-exact
/// Based on scipy's fisher test: <https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.fisher_exact.html#scipy-stats-fisher-exact>
/// Expects a table in row-major order
/// Returns the [odds ratio](https://en.wikipedia.org/wiki/Odds_ratio) and p_value
/// # Examples
Expand Down Expand Up @@ -133,7 +133,7 @@ pub fn fishers_exact_with_odds_ratio(
}

/// Perform a Fisher exact test on a 2x2 contingency table.
/// Based on scipy's fisher test: https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.fisher_exact.html#scipy-stats-fisher-exact
/// Based on scipy's fisher test: <https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.fisher_exact.html#scipy-stats-fisher-exact>
/// Expects a table in row-major order
/// Returns only the p_value
/// # Examples
Expand Down