Struct ParameterSpace 

pub struct ParameterSpace<T> {
    pub items: Vec<T>,
}

Ordered collection of parameters.

Use ParameterSpace<BoundedParameter> for non-parametric problems and ParameterSpace<UnboundedParameter> for parametric problems.

Fields

items: Vec<T>

Implementations

impl<T> ParameterSpace<T>

pub fn new() -> Self

pub fn push(&mut self, item: impl Into<T>)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> Iter<'_, T>

impl<T: ParameterMeta> ParameterSpace<T>

pub fn names(&self) -> Vec<String>

impl ParameterSpace<BoundedParameter>

Helpers for bounded parameter spaces.

pub fn bounded() -> Self

Creates an empty bounded parameter space (for non-parametric problems).

Prefer this over ParameterSpace::<BoundedParameter>::new() to avoid the turbofish:

let space = ParameterSpace::bounded()
    .add("ke", 0.1, 1.0)
    .add("v", 1.0, 20.0);

pub fn add(self, name: impl Into<String>, lower: f64, upper: f64) -> Self

Adds a bounded parameter with the given name, lower, and upper bounds.

pub fn finite_ranges(&self) -> Vec<(f64, f64)>

Returns (lower, upper) for each parameter.

impl ParameterSpace<UnboundedParameter>

Helpers for unbounded parameter spaces.

pub fn unbounded() -> Self

Creates an empty unbounded parameter space (for parametric problems).

Prefer this over ParameterSpace::<UnboundedParameter>::new() to avoid the turbofish.

pub fn add(self, parameter: impl Into<UnboundedParameter>) -> Self

Adds an unbounded parameter to the space.

Trait Implementations

impl<T: Clone> Clone for ParameterSpace<T>

fn clone(&self) -> ParameterSpace<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ParameterSpace<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for ParameterSpace<T>

fn default() -> ParameterSpace<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for ParameterSpace<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> FromIterator<T> for ParameterSpace<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a, T> IntoIterator for &'a ParameterSpace<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for ParameterSpace<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for ParameterSpace<T>

fn eq(&self, other: &ParameterSpace<T>) -> 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<T> Serialize for ParameterSpace<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for ParameterSpace<T>