Enum TOIStatus

pub enum TOIStatus {
    OutOfIterations,
    Converged,
    Failed,
    Penetrating,
}

The status of the time-of-impact computation algorithm.

Variants

OutOfIterations

The TOI algorithm ran out of iterations before achieving convergence.

If this happens, the content of the NonlinearTOI will still be a conservative approximation of the actual result so it is often fine to interpret this case as a success.

Converged

The TOI algorithm converged successfully.

Failed

Something went wrong during the TOI computation, likely due to numerical instabilities.

If this happens, the content of the NonlinearTOI will still be a conservative approximation of the actual result so it is often fine to interpret this case as a success.

Penetrating

The two shape already overlap at the time 0.

If this happens, the witness points provided by the NonlinearTOI will be invalid.

Trait Implementations

impl Clone for TOIStatus

fn clone(&self) -> TOIStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TOIStatus

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

Formats the value using the given formatter.

impl PartialEq for TOIStatus

fn eq(&self, other: &TOIStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TOIStatus

impl Eq for TOIStatus

impl StructuralPartialEq for TOIStatus