Skip to main content

nominal_api/conjure/objects/scout/compute/api/
percentile.rs

1/// The value at the specified percentile.
2#[derive(
3    Debug,
4    Clone,
5    conjure_object::serde::Serialize,
6    conjure_object::serde::Deserialize,
7    conjure_object::private::DeriveWith
8)]
9#[serde(crate = "conjure_object::serde")]
10#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
11#[conjure_object::private::staged_builder::staged_builder]
12#[builder(crate = conjure_object::private::staged_builder, update, inline)]
13pub struct Percentile {
14    #[builder(custom(type = super::DoubleConstant, convert = Box::new))]
15    #[serde(rename = "percentile")]
16    percentile: Box<super::DoubleConstant>,
17}
18impl Percentile {
19    /// Constructs a new instance of the type.
20    #[inline]
21    pub fn new(percentile: super::DoubleConstant) -> Self {
22        Self::builder().percentile(percentile).build()
23    }
24    /// Percentile to compute, in range [0, 1]. E.g. 0.5 for median, 0.95 for p95.
25    #[inline]
26    pub fn percentile(&self) -> &super::DoubleConstant {
27        &*self.percentile
28    }
29}