Struct Parameter 

pub struct Parameter { /* private fields */ }

Complete definition and user-facing metadata for one scalar parameter.

Implementations

impl Parameter

pub fn free(name: impl Into<Arc<str>>) -> Self

Creates an unbounded free parameter with a default initial value.

pub fn fixed(name: impl Into<Arc<str>>, value: f64) -> Self

Creates an unbounded parameter fixed at value.

pub fn with_fixed_value(self, value: f64) -> Self

Returns this parameter fixed at value.

pub fn with_free(self) -> Self

Returns this parameter marked as free.

pub fn with_initial(self, initial: impl Into<InitialSpec>) -> Self

Returns this parameter with the specified initialization rule.

pub fn with_bounds( self, min: impl Into<Option<f64>>, max: impl Into<Option<f64>>, ) -> Self

Returns this parameter with inclusive optional bounds.

pub fn with_periodic(self) -> Self

Mark this parameter as periodic over its finite two-sided bounds.

pub fn with_periodicity(self, periodic: bool) -> Self

Sets whether the parameter is periodic.

pub fn with_scale(self, scale: f64) -> Self

Set the characteristic optimizer scale for this parameter.

The scale is metadata: fit integrations may use it to condition the optimizer coordinate system, while direct model evaluation is unchanged.

pub fn with_unit(self, unit: impl Into<Arc<str>>) -> Self

Attaches a human-readable unit label.

pub fn with_latex(self, latex: impl Into<Arc<str>>) -> Self

Attaches a LaTeX-formatted label.

pub fn with_description(self, description: impl Into<Arc<str>>) -> Self

Attaches a longer human-readable description.

pub fn name(&self) -> &str

Returns the unique parameter name.

pub fn state(&self) -> &ParamState

Returns whether the parameter is free or fixed.

pub fn is_free(&self) -> bool

Returns whether the parameter is free.

pub fn is_fixed(&self) -> bool

Returns whether the parameter is fixed.

pub fn initial_spec(&self) -> &InitialSpec

Returns the initialization rule.

pub fn bounds_spec(&self) -> &Bounds

Returns the optional parameter bounds.

pub fn is_periodic(&self) -> bool

Returns whether the parameter is periodic over its bounds.

pub fn periodic_bounds(&self) -> Option<(f64, f64)>

Return the validated canonical half-open periodic interval.

pub fn scale(&self) -> Option<f64>

Returns the optional characteristic optimizer scale.

pub fn unit_label(&self) -> Option<&str>

Returns the optional human-readable unit label.

pub fn latex_label(&self) -> Option<&str>

Returns the optional LaTeX-formatted label.

pub fn description_text(&self) -> Option<&str>

Returns the optional longer description.

Trait Implementations

impl Add for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<&Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Complex64) -> Self::Output

Performs the + operation.

impl Add<&Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Complex64) -> Self::Output

Performs the + operation.

impl Add<&Expr> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Expr) -> Self::Output

Performs the + operation.

impl Add<&Expr> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Expr) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for &Expr

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for Expr

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for &f64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for f64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for &Complex64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for Complex64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&Parameter> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &Parameter) -> Self::Output

Performs the + operation.

impl Add<&f64> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &f64) -> Self::Output

Performs the + operation.

impl Add<&f64> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: &f64) -> Self::Output

Performs the + operation.

impl Add<Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Complex64) -> Self::Output

Performs the + operation.

impl Add<Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Complex64) -> Self::Output

Performs the + operation.

impl Add<Expr> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Expr) -> Self::Output

Performs the + operation.

impl Add<Expr> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Expr) -> Self::Output

Performs the + operation.

impl Add<Parameter> for &Expr

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<Parameter> for Expr

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<Parameter> for &f64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<Parameter> for f64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<Parameter> for &Complex64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<Parameter> for Complex64

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<Parameter> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: Parameter) -> Self::Output

Performs the + operation.

impl Add<f64> for &Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Self::Output

Performs the + operation.

impl Add<f64> for Parameter

type Output = Expr

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Self::Output

Performs the + operation.

impl AddAssign<&Parameter> for Expr

fn add_assign(&mut self, rhs: &Parameter)

Performs the += operation.

impl AddAssign<Parameter> for Expr

fn add_assign(&mut self, rhs: Parameter)

Performs the += operation.

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Parameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<&Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Complex64) -> Self::Output

Performs the / operation.

impl Div<&Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Complex64) -> Self::Output

Performs the / operation.

impl Div<&Expr> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Expr) -> Self::Output

Performs the / operation.

impl Div<&Expr> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Expr) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for &Expr

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for Expr

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for &f64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for f64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for &Complex64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for Complex64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&Parameter> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &Parameter) -> Self::Output

Performs the / operation.

impl Div<&f64> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &f64) -> Self::Output

Performs the / operation.

impl Div<&f64> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: &f64) -> Self::Output

Performs the / operation.

impl Div<Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Complex64) -> Self::Output

Performs the / operation.

impl Div<Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Complex64) -> Self::Output

Performs the / operation.

impl Div<Expr> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Expr) -> Self::Output

Performs the / operation.

impl Div<Expr> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Expr) -> Self::Output

Performs the / operation.

impl Div<Parameter> for &Expr

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<Parameter> for Expr

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<Parameter> for &f64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<Parameter> for f64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<Parameter> for &Complex64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<Parameter> for Complex64

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<Parameter> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: Parameter) -> Self::Output

Performs the / operation.

impl Div<f64> for &Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl Div<f64> for Parameter

type Output = Expr

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl DivAssign<&Parameter> for Expr

fn div_assign(&mut self, rhs: &Parameter)

Performs the /= operation.

impl DivAssign<Parameter> for Expr

fn div_assign(&mut self, rhs: Parameter)

Performs the /= operation.

impl From<&Parameter> for Expr

fn from(parameter: &Parameter) -> Self

Converts to this type from the input type.

impl From<Parameter> for Expr

fn from(parameter: Parameter) -> Self

Converts to this type from the input type.

impl Mul for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Complex64) -> Self::Output

Performs the * operation.

impl Mul<&Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Complex64) -> Self::Output

Performs the * operation.

impl Mul<&Expr> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Expr) -> Self::Output

Performs the * operation.

impl Mul<&Expr> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Expr) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for &Expr

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for Expr

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for &f64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for f64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for &Complex64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for Complex64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&Parameter> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &Parameter) -> Self::Output

Performs the * operation.

impl Mul<&f64> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &f64) -> Self::Output

Performs the * operation.

impl Mul<&f64> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: &f64) -> Self::Output

Performs the * operation.

impl Mul<Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Complex64) -> Self::Output

Performs the * operation.

impl Mul<Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Complex64) -> Self::Output

Performs the * operation.

impl Mul<Expr> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Expr) -> Self::Output

Performs the * operation.

impl Mul<Expr> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Expr) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for &Expr

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for Expr

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for &f64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for f64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for &Complex64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for Complex64

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<Parameter> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: Parameter) -> Self::Output

Performs the * operation.

impl Mul<f64> for &Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul<f64> for Parameter

type Output = Expr

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl MulAssign<&Parameter> for Expr

fn mul_assign(&mut self, rhs: &Parameter)

Performs the *= operation.

impl MulAssign<Parameter> for Expr

fn mul_assign(&mut self, rhs: Parameter)

Performs the *= operation.

impl Neg for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Parameter

fn eq(&self, other: &Parameter) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Parameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Parameter

impl Sub for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Complex64) -> Self::Output

Performs the - operation.

impl Sub<&Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Complex64) -> Self::Output

Performs the - operation.

impl Sub<&Expr> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Expr) -> Self::Output

Performs the - operation.

impl Sub<&Expr> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Expr) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for &Expr

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for Expr

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for &f64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for f64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for &Complex64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for Complex64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&Parameter> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &Parameter) -> Self::Output

Performs the - operation.

impl Sub<&f64> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &f64) -> Self::Output

Performs the - operation.

impl Sub<&f64> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: &f64) -> Self::Output

Performs the - operation.

impl Sub<Complex<f64>> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Complex64) -> Self::Output

Performs the - operation.

impl Sub<Complex<f64>> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Complex64) -> Self::Output

Performs the - operation.

impl Sub<Expr> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Expr) -> Self::Output

Performs the - operation.

impl Sub<Expr> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Expr) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for &Expr

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for Expr

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for &f64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for f64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for &Complex64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for Complex64

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<Parameter> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: Parameter) -> Self::Output

Performs the - operation.

impl Sub<f64> for &Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: f64) -> Self::Output

Performs the - operation.

impl Sub<f64> for Parameter

type Output = Expr

The resulting type after applying the - operator.

fn sub(self, rhs: f64) -> Self::Output

Performs the - operation.

impl SubAssign<&Parameter> for Expr

fn sub_assign(&mut self, rhs: &Parameter)

Performs the -= operation.

impl SubAssign<Parameter> for Expr

fn sub_assign(&mut self, rhs: Parameter)

Performs the -= operation.