Skip to main content

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

1/// Fits a curve to the scatter between two series.
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 ScatterCurveFit {
14    #[builder(custom(type = super::Scatter, convert = Box::new))]
15    #[serde(rename = "scatter")]
16    scatter: Box<super::Scatter>,
17    #[builder(custom(type = super::ScatterFitOptions, convert = Box::new))]
18    #[serde(rename = "options")]
19    options: Box<super::ScatterFitOptions>,
20}
21impl ScatterCurveFit {
22    /// Constructs a new instance of the type.
23    #[inline]
24    pub fn new(scatter: super::Scatter, options: super::ScatterFitOptions) -> Self {
25        Self::builder().scatter(scatter).options(options).build()
26    }
27    /// The x and y series to fit to.
28    #[inline]
29    pub fn scatter(&self) -> &super::Scatter {
30        &*self.scatter
31    }
32    #[inline]
33    pub fn options(&self) -> &super::ScatterFitOptions {
34        &*self.options
35    }
36}