Skip to main content

Clip

Struct Clip 

Source
#[non_exhaustive]
pub struct Clip { pub pos: Vec<Vec<Q>>, pub neg: Vec<Vec<Q>>, pub on: Vec<Vec<Q>>, /* private fields */ }
Expand description

The result of Polytope::clip: the vertex sets of the two closed pieces of a polytope cut by a hyperplane, in no particular order.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§pos: Vec<Vec<Q>>

Vertices of P ∩ {h ≥ 0}.

§neg: Vec<Vec<Q>>

Vertices of P ∩ {h ≤ 0}.

§on: Vec<Vec<Q>>

Vertices on the hyperplane h = 0 — the edge crossings and the original vertices with h = 0 — which belong to both pieces.

Implementations§

Source§

impl Clip

Source

pub fn pos_is_full_dimensional(&self) -> bool

Does P ∩ {h ≥ 0} have dimension n? One exact rank on the vertex set, no LP; exact for a bounded parent (see Polytope::is_full_dimensional_from_vertices).

Source

pub fn neg_is_full_dimensional(&self) -> bool

Does P ∩ {h ≤ 0} have dimension n? As pos_is_full_dimensional.

Source

pub fn pos_polytope( &self, parent: &Polytope, h: &HalfSpace, ) -> Result<Polytope, SymplexError>

The piece P ∩ {h ≥ 0} as a polytope (parent with h appended) whose vertex cache is already filled from the clip, so a following volume, vertices or clip does no enumeration. parent and h must be the polytope and half-space the clip was taken from; only their shapes can be checked here.

§Errors

SymplexError::InvalidArgument if parent or h does not have the shape of the clip’s inputs (dimension, number of half-spaces, number of vertices).

Source

pub fn neg_polytope( &self, parent: &Polytope, h: &HalfSpace, ) -> Result<Polytope, SymplexError>

The piece P ∩ {h ≤ 0} as a polytope (parent with the flipped half-space appended), with its vertex cache filled; otherwise as pos_polytope.

§Errors

As pos_polytope.

Trait Implementations§

Source§

impl Clone for Clip

Source§

fn clone(&self) -> Self

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
Source§

impl Debug for Clip

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Clip

§

impl RefUnwindSafe for Clip

§

impl Send for Clip

§

impl Sync for Clip

§

impl Unpin for Clip

§

impl UnsafeUnpin for Clip

§

impl UnwindSafe for Clip

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more