pub struct ParameterSpec { /* private fields */ }Expand description
Value, unit, scale, bounds, and selection for one scalar.
Implementations§
Source§impl ParameterSpec
impl ParameterSpec
Sourcepub fn new(
key: ParameterKey,
value: f64,
unit: impl Into<String>,
bounds: ParameterBounds,
scale: f64,
refine: bool,
) -> Result<Self, ParameterError>
pub fn new( key: ParameterKey, value: f64, unit: impl Into<String>, bounds: ParameterBounds, scale: f64, refine: bool, ) -> Result<Self, ParameterError>
Validate and construct one scalar specification.
§Errors
Returns ParameterError for non-finite values, empty units,
out-of-bounds values, or non-positive/non-finite scales.
Sourcepub const fn key(&self) -> &ParameterKey
pub const fn key(&self) -> &ParameterKey
Borrow the stable parameter identity.
Sourcepub const fn bounds(&self) -> ParameterBounds
pub const fn bounds(&self) -> ParameterBounds
Return the physical bounds.
Trait Implementations§
Source§impl Clone for ParameterSpec
impl Clone for ParameterSpec
Source§fn clone(&self) -> ParameterSpec
fn clone(&self) -> ParameterSpec
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 ParameterSpec
impl Debug for ParameterSpec
Source§impl PartialEq for ParameterSpec
impl PartialEq for ParameterSpec
impl StructuralPartialEq for ParameterSpec
Auto Trait Implementations§
impl Freeze for ParameterSpec
impl RefUnwindSafe for ParameterSpec
impl Send for ParameterSpec
impl Sync for ParameterSpec
impl Unpin for ParameterSpec
impl UnsafeUnpin for ParameterSpec
impl UnwindSafe for ParameterSpec
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.