pub struct ParameterSet { /* private fields */ }Expand description
Deterministically ordered immutable scalar specifications.
Implementations§
Source§impl ParameterSet
impl ParameterSet
Sourcepub fn new(specs: Vec<ParameterSpec>) -> Result<Self, ParameterError>
pub fn new(specs: Vec<ParameterSpec>) -> Result<Self, ParameterError>
Preserve input order while validating unique stable keys.
§Errors
Returns ParameterError::DuplicateKey for repeated identities.
Sourcepub fn specs(&self) -> &[ParameterSpec]
pub fn specs(&self) -> &[ParameterSpec]
Borrow specifications in stable packing order.
Sourcepub fn spec(&self, key: &ParameterKey) -> Option<&ParameterSpec>
pub fn spec(&self, key: &ParameterKey) -> Option<&ParameterSpec>
Return one specification by stable key.
Sourcepub fn index_of(&self, key: &ParameterKey) -> Option<usize>
pub fn index_of(&self, key: &ParameterKey) -> Option<usize>
Return the stable row index of one parameter.
Sourcepub fn values(&self) -> BTreeMap<ParameterKey, f64>
pub fn values(&self) -> BTreeMap<ParameterKey, f64>
Copy physical values into a key-addressed map.
Sourcepub fn replace_values(
&self,
values: &BTreeMap<ParameterKey, f64>,
) -> Result<Self, ParameterError>
pub fn replace_values( &self, values: &BTreeMap<ParameterKey, f64>, ) -> Result<Self, ParameterError>
Return a new ordered set with selected physical values replaced.
§Errors
Returns ParameterError for an unknown key or a replacement that is
non-finite or outside its existing bounds.
Trait Implementations§
Source§impl Clone for ParameterSet
impl Clone for ParameterSet
Source§fn clone(&self) -> ParameterSet
fn clone(&self) -> ParameterSet
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for ParameterSet
impl Debug for ParameterSet
Source§impl PartialEq for ParameterSet
impl PartialEq for ParameterSet
impl StructuralPartialEq for ParameterSet
Auto Trait Implementations§
impl Freeze for ParameterSet
impl RefUnwindSafe for ParameterSet
impl Send for ParameterSet
impl Sync for ParameterSet
impl Unpin for ParameterSet
impl UnsafeUnpin for ParameterSet
impl UnwindSafe for ParameterSet
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Scalar for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.