Skip to main content

ArcStopCriteria

carapace_core::analysis

Struct ArcStopCriteria

pub struct ArcStopCriteria<NId = NodeId> {
    pub displacement: Option<DisplacementTarget<NId>>,
    pub load_factor: Option<LoadFactorTarget>,
    pub load_factor_zero_crossing: bool,
    pub max_chord_length: Option<f64>,
    pub max_steps: Option<usize>,
}

Expand description

Optional stop criteria (docs/arclength.md §7). Any one that is met ends the phase after the step that met it is accepted; later step() calls return AnalysisError::ContinuationComplete.

Fields§

§displacement: Option<DisplacementTarget<NId>>§load_factor: Option<LoadFactorTarget>§load_factor_zero_crossing: bool

Stop at the first step on which lambda crosses zero.

§max_chord_length: Option<f64>§max_steps: Option<usize>

Trait Implementations§

impl<NId: Clone> Clone for ArcStopCriteria<NId>

fn clone(&self) -> ArcStopCriteria<NId>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<NId: Debug> Debug for ArcStopCriteria<NId>

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

Formats the value using the given formatter. Read more

impl<NId: Default> Default for ArcStopCriteria<NId>

fn default() -> ArcStopCriteria<NId>

Returns the “default value” for a type. Read more

impl<NId: PartialEq> PartialEq for ArcStopCriteria<NId>

fn eq(&self, other: &ArcStopCriteria<NId>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl<NId: PartialEq> StructuralPartialEq for ArcStopCriteria<NId>

Auto Trait Implementations§

impl<NId> Freeze for ArcStopCriteria<NId>
where NId: Freeze,

impl<NId> RefUnwindSafe for ArcStopCriteria<NId>
where NId: RefUnwindSafe,

impl<NId> Send for ArcStopCriteria<NId>
where NId: Send,

impl<NId> Sync for ArcStopCriteria<NId>
where NId: Sync,

impl<NId> Unpin for ArcStopCriteria<NId>
where NId: Unpin,

impl<NId> UnsafeUnpin for ArcStopCriteria<NId>
where NId: UnsafeUnpin,

impl<NId> UnwindSafe for ArcStopCriteria<NId>
where NId: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ByRef<T> for T

fn by_ref(&self) -> &T

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

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

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

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

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.