nominal-api-conjure 0.1368.1

Conjure HTTP 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

/// Removes discontinuities from a wrapping signal (e.g. phase or heading) by adding whole
/// multiples of `period` whenever the step between consecutive samples exceeds half the
/// period. Output length equals
/// input length.
#[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 PhaseUnwrapSeries {
    #[builder(custom(type = super::NumericSeries, convert = Box::new))]
    #[serde(rename = "input")]
    input: Box<super::NumericSeries>,
    #[builder(custom(type = super::DoubleConstant, convert = Box::new))]
    #[serde(rename = "period")]
    period: Box<super::DoubleConstant>,
}
impl PhaseUnwrapSeries {
    /// Constructs a new instance of the type.
    #[inline]
    pub fn new(input: super::NumericSeries, period: super::DoubleConstant) -> Self {
        Self::builder().input(input).period(period).build()
    }
    #[inline]
    pub fn input(&self) -> &super::NumericSeries {
        &*self.input
    }
    /// The wrapping period of the signal (e.g. 2*pi for radians, 360 for degrees). A jump
    /// between consecutive samples greater than `period/2` in magnitude is corrected by
    /// adding/subtracting a whole multiple of `period`.
    #[inline]
    pub fn period(&self) -> &super::DoubleConstant {
        &*self.period
    }
}