Constraint

Struct Constraint 

Source
pub struct Constraint<T: RealField + Copy, P: ProjectMulti<T, N, H>, const N: usize, const H: usize> {
    pub max_prim_residual: T,
    pub max_dual_residual: T,
    /* private fields */
}
Expand description

A Constraint consists of a projection function and a set of associated slack and dual variables.

Fields§

§max_prim_residual: T§max_dual_residual: T

Implementations§

Source§

impl<T: RealField + Copy, const N: usize, const H: usize, P: ProjectMulti<T, N, H>> Constraint<T, P, N, H>

Source

pub fn new(projector: P) -> Self

Construct a new Constraint from the provided [Project] type.

Source

pub fn projector_mut(&mut self) -> &mut P

Get a mutable reference to the projector. Allows for modifying or completely swapping the projector at runtime.

Source

pub fn reset(&mut self)

Reset all internal state of this constraint

Source

pub fn constrain( &mut self, compute_residuals: bool, points: &SMatrix<T, N, H>, reference: Option<&SMatrix<T, N, H>>, scratch: &mut SMatrix<T, N, H>, )

Constrains the set of points, and if compute_residuals == true, computes the maximum primal and dual residuals

Auto Trait Implementations§

§

impl<T, P, const N: usize, const H: usize> Freeze for Constraint<T, P, N, H>
where T: Freeze, P: Freeze,

§

impl<T, P, const N: usize, const H: usize> RefUnwindSafe for Constraint<T, P, N, H>

§

impl<T, P, const N: usize, const H: usize> Send for Constraint<T, P, N, H>
where P: Send,

§

impl<T, P, const N: usize, const H: usize> Sync for Constraint<T, P, N, H>
where P: Sync,

§

impl<T, P, const N: usize, const H: usize> Unpin for Constraint<T, P, N, H>
where T: Unpin, P: Unpin,

§

impl<T, P, const N: usize, const H: usize> UnwindSafe for Constraint<T, P, N, H>
where T: UnwindSafe, P: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

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

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.