pub struct AffineConstraint { /* private fields */ }Expand description
Define target = multiplier * source + offset.
Implementations§
Source§impl AffineConstraint
impl AffineConstraint
Sourcepub fn new(
target: ParameterKey,
source: ParameterKey,
multiplier: f64,
offset: f64,
) -> Result<Self, ConstraintError>
pub fn new( target: ParameterKey, source: ParameterKey, multiplier: f64, offset: f64, ) -> Result<Self, ConstraintError>
Validate distinct keys and finite coefficients.
§Errors
Returns ConstraintError for a self-reference or non-finite value.
Sourcepub const fn target(&self) -> &ParameterKey
pub const fn target(&self) -> &ParameterKey
Borrow the constrained parameter.
Sourcepub const fn source(&self) -> &ParameterKey
pub const fn source(&self) -> &ParameterKey
Borrow the already-resolved source.
Sourcepub const fn multiplier(&self) -> f64
pub const fn multiplier(&self) -> f64
Return the source multiplier.
Trait Implementations§
Source§impl Clone for AffineConstraint
impl Clone for AffineConstraint
Source§fn clone(&self) -> AffineConstraint
fn clone(&self) -> AffineConstraint
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 AffineConstraint
impl Debug for AffineConstraint
Source§impl PartialEq for AffineConstraint
impl PartialEq for AffineConstraint
impl StructuralPartialEq for AffineConstraint
Auto Trait Implementations§
impl Freeze for AffineConstraint
impl RefUnwindSafe for AffineConstraint
impl Send for AffineConstraint
impl Sync for AffineConstraint
impl Unpin for AffineConstraint
impl UnsafeUnpin for AffineConstraint
impl UnwindSafe for AffineConstraint
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.