Struct ParameterUpdate 

pub struct ParameterUpdate {
    pub state: Option<ParamState>,
    pub initial: Option<InitialSpec>,
    pub bounds: Option<Bounds>,
    pub periodic: Option<bool>,
    pub scale: Option<Option<f64>>,
    pub unit: Option<Option<String>>,
    pub latex: Option<Option<String>>,
    pub description: Option<Option<String>>,
}

A partial, atomic update to a parameter definition.

An outer None preserves the current field. For metadata fields and the scale, Some(None) clears the current value.

use laddu_expr::{Expr, parameters::{ParamState, ParameterUpdate}};

let graph = Expr::from(laddu_expr::parameter!("mass")).to_graph();
let update = ParameterUpdate {
    state: Some(ParamState::Fixed(1.0)),
    ..Default::default()
};
let updated = graph.with_parameters([("mass", update)])?;

Fields

state: Option<ParamState>

Replacement state.

initial: Option<InitialSpec>

Replacement initialization rule.

bounds: Option<Bounds>

Replacement bounds; Bounds::default removes all bounds.

periodic: Option<bool>

Replacement periodicity flag.

scale: Option<Option<f64>>

Replacement optimizer scale, or Some(None) to clear it.

unit: Option<Option<String>>

Replacement unit label, or Some(None) to clear it.

latex: Option<Option<String>>

Replacement LaTeX label, or Some(None) to clear it.

description: Option<Option<String>>

Replacement description, or Some(None) to clear it.

Implementations

impl ParameterUpdate

pub fn validate(&self) -> ParamResult<()>

Validates values intrinsic to this patch.

Checks that fixed and scalar initial values are finite, uniform initial ranges are finite and ordered, and replacement scales are finite and positive. Relationships between fields are validated after applying the update to a complete Parameter.

Errors

Returns a field-specific ParamError when a fixed value, initial value or range, bounds, or scale is invalid.

Trait Implementations

impl Clone for ParameterUpdate

fn clone(&self) -> ParameterUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterUpdate

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

Formats the value using the given formatter.

impl Default for ParameterUpdate

fn default() -> ParameterUpdate

Returns the “default value” for a type.

impl PartialEq for ParameterUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ParameterUpdate