Skip to content

Commit

Permalink
doc: alias inverse_cdf as "quantile function" in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
YeungOnion committed Apr 17, 2024
1 parent 4166295 commit 4b90661
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/distribution/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ pub trait ContinuousCDF<K: Float, T: Float>: Min<K> + Max<K> {
/// Performs a binary search on the domain of `cdf` to obtain an approximation
/// of `F^-1(p) := inf { x | F(x) >= p }`. Needless to say, performance may
/// may be lacking.
#[doc(alias = "quantile function")]
#[doc(alias = "quantile")]
fn inverse_cdf(&self, p: T) -> K {
if p == T::zero() {
return self.min();
Expand Down

0 comments on commit 4b90661

Please sign in to comment.