Struct Parameter

pub struct Parameter<F: Field> {
    pub amplitude: String,
    pub name: String,
    pub index: Option<usize>,
    pub fixed_index: Option<usize>,
    pub initial: F,
    pub bounds: (F, F),
}

A single parameter within an Amplitude.

Fields

amplitude: String

Name of the parent Amplitude containing this parameter.

name: String

Name of the parameter.

index: Option<usize>

Index of the parameter with respect to the Model. This will be Option::None if the parameter is fixed.

fixed_index: Option<usize>

A separate index for fixed parameters to ensure they stay constrained properly if freed. This will be Option::None if the parameter is free in the Model.

initial: F

The initial value the parameter takes, or alternatively the value of the parameter if it is fixed in the fit.

bounds: (F, F)

Bounds for the given parameter (defaults to +/- infinity). This is mostly optional and isn’t used in any Rust code asside from being able to get and set it.

Implementations

impl<F: Field> Parameter<F>

pub fn new(amplitude: &str, name: &str, index: usize) -> Self

Creates a new Parameter within an Amplitude using the name of the Amplitude, the name of the Parameter, and the index of the parameter within the Model.

By default, new Parameters are free, have an initial value of 0.0, and their bounds are set to (Field::NEG_INFINITY, Field::INFINITY).

pub const fn is_free(&self) -> bool

Returns true if the Parameter is free, false otherwise.

pub const fn is_fixed(&self) -> bool

Returns true if the Parameter is fixed, false otherwise.

Trait Implementations

impl<F: Clone + Field> Clone for Parameter<F>

fn clone(&self) -> Parameter<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Field> Debug for Parameter<F>

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

Formats the value using the given formatter.

impl<F: Field> Display for Parameter<F>

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

Formats the value using the given formatter.