Skip to content

Commit

Permalink
chore: comments on distribution
Browse files Browse the repository at this point in the history
  • Loading branch information
zeeshanlakhani committed Jun 19, 2024
1 parent 02c4048 commit 3fdfc39
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion oximeter/db/src/oxql/point.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1523,6 +1523,9 @@ impl DistributionSupport for f64 {}
/// A distribution is a sequence of bins and counts in those bins, and some
/// statistical information tracked to compute the mean, standard deviation, and
/// quantile estimates.
///
/// Min, max, and the p-* quantiles are treated as optional due to the
/// possibility of distribution operations, like subtraction.
#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
#[schemars(rename = "Distribution{T}")]
pub struct Distribution<T: DistributionSupport> {
Expand Down Expand Up @@ -1588,7 +1591,8 @@ where
/// Subtract two distributions, checking that they have the same bins.
///
/// Min and max values are returned as None, as they lose meaning
/// when subtracting distributions.
/// when subtracting distributions. The same is true for p50, p90, and p99
/// quantiles.
fn checked_sub(
&self,
rhs: &Distribution<T>,
Expand Down

0 comments on commit 3fdfc39

Please sign in to comment.