nominal-api 0.1239.0

API bindings for the Nominal platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

/// Outputs a set of ranges where the input series is stable. For each point, the min and max are calculated over
/// the specified lookback window, including the current point. A point is considered stable if its value does
/// not deviate from the calculated min and the max by more than the threshold and the total number of points
/// within the window is at least the specified amount. The threshold can be either fixed values or percentages
/// of the value. The lookback window must be strictly positive. The minimum points threshold defaults to 2.
#[derive(
    Debug,
    Clone,
    conjure_object::serde::Serialize,
    conjure_object::serde::Deserialize,
    conjure_object::private::DeriveWith
)]
#[serde(crate = "conjure_object::serde")]
#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[conjure_object::private::staged_builder::staged_builder]
#[builder(crate = conjure_object::private::staged_builder, update, inline)]
pub struct StabilityDetectionRanges {
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::NumericSeries>,
    #[builder(custom(type = super::StabilityWindowConfiguration, convert = Box::new))]
    #[serde(rename = "windowConfiguration")]
    window_configuration: Box<super::StabilityWindowConfiguration>,
    #[builder(custom(type = super::Threshold, convert = Box::new))]
    #[serde(rename = "threshold")]
    threshold: Box<super::Threshold>,
}
impl StabilityDetectionRanges {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(
        input: super::NumericSeries,
        window_configuration: super::StabilityWindowConfiguration,
        threshold: super::Threshold,
    ) -> Self {
        Self::builder()
            .input(input)
            .window_configuration(window_configuration)
            .threshold(threshold)
            .build()
    }
    #[inline]
    pub fn input(&self) -> &super::NumericSeries {
        &*self.input
    }
    #[inline]
    pub fn window_configuration(&self) -> &super::StabilityWindowConfiguration {
        &*self.window_configuration
    }
    #[inline]
    pub fn threshold(&self) -> &super::Threshold {
        &*self.threshold
    }
}