Struct Parameter 

pub struct Parameter(/* private fields */);

An enum containing either a named free parameter or a constant value.

Implementations

impl Parameter

pub fn new(name: impl Into<String>) -> Parameter

Create a free (floating) parameter with the given name.

pub fn new_fixed(name: impl Into<String>, value: f64) -> Parameter

Create a fixed parameter with the given name and value.

pub fn name(&self) -> String

Return the current parameter name.

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

Return the fixed value when the parameter is fixed.

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

Return the current initial value, if one is set.

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

Return the current lower and upper bounds.

pub fn unit(&self) -> Option<String>

Return the optional unit label.

pub fn latex(&self) -> Option<String>

Return the optional LaTeX label.

pub fn description(&self) -> Option<String>

Return the optional human-readable description.

pub fn set_fixed_value(&self, value: Option<f64>)

Helper method to set the fixed value of a parameter.

pub fn set_initial(&self, value: f64)

Helper method to set the initial value of a parameter.

Panics

This method panics if the parameter is fixed.

pub fn set_bounds<L, U>(&self, min: L, max: U)

where L: IntoBound, U: IntoBound,

Helper method to set the bounds of a parameter.

pub fn set_unit(&self, unit: impl Into<String>)

Helper method to set the unit of a parameter.

pub fn set_latex(&self, latex: impl Into<String>)

Helper method to set the LaTeX representation of a parameter.

pub fn set_description(&self, description: impl Into<String>)

Helper method to set the description of a parameter.

pub fn is_free(&self) -> bool

Is this parameter free?

pub fn is_fixed(&self) -> bool

Is this parameter fixed?

Trait Implementations

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<(), Error>

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Parameter, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Parameter

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Parameter

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Parameter

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Parameter