Struct Params

pub struct Params {
    pub gain: Option<f64>,
    pub offset: Option<f64>,
    pub residuals: Option<f64>,
    pub power: Option<f64>,
    pub base: Option<f64>,
}

A structure to hold function parameters

Function examples:

• f(x) = gain * x + offset
• f(x) = gain * x ^ power
• f(x) = gain * base ^ x

Example

let params = big_o::Params::new().gain(2.0).offset(3.0).build();

assert_eq!(params.gain, Some(2.0));
assert_eq!(params.offset, Some(3.0));
assert_eq!(params.power, None);

Fields

gain: Option<f64>

offset: Option<f64>

residuals: Option<f64>

power: Option<f64>

base: Option<f64>

Implementations

impl Params

Params builder

pub fn new() -> Self

pub fn gain(&mut self, value: f64) -> &mut Self

pub fn offset(&mut self, value: f64) -> &mut Self

pub fn residuals(&mut self, value: f64) -> &mut Self

pub fn power(&mut self, value: f64) -> &mut Self

pub fn base(&mut self, value: f64) -> &mut Self

pub fn build(&mut self) -> Params

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Params

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Params

fn default() -> Self

Returns the “default value” for a type.