Skip to main content

ConvexSet

oxiphysics_core::convex_analysis

Enum ConvexSet

pub enum ConvexSet {
    Hyperplane {
        a: Vec<f64>,
        b: f64,
    },
    Halfspace {
        a: Vec<f64>,
        b: f64,
    },
    Ball {
        center: Vec<f64>,
        radius: f64,
    },
    Polytope {
        a_rows: Vec<Vec<f64>>,
        b_vec: Vec<f64>,
    },
}

Expand description

A representation of a convex set in ℝⁿ.

Supports hyperplanes, halfspaces, Euclidean balls, and polytopes in H-representation (intersection of halfspaces).

Variants§

Hyperplane

Hyperplane {x : aᵀx = b}.

Fields

§a: Vec<f64>

Normal vector a.

§b: f64

Right-hand side b.

Halfspace

Halfspace {x : aᵀx ≤ b}.

Fields

§a: Vec<f64>

Normal vector a.

§b: f64

Right-hand side b.

Ball

Euclidean ball {x : ||x - c|| ≤ r}.

Fields

§center: Vec<f64>

Centre c.

§radius: f64

Radius r.

Polytope

Polytope in H-form: {x : A x ≤ b}.

a_rows[i] is the i-th row of A and b_vec[i] is b_i.

Fields

§a_rows: Vec<Vec<f64>>

Rows of the constraint matrix.

§b_vec: Vec<f64>

Right-hand side vector.

Implementations§

impl ConvexSet

pub fn contains(&self, x: &[f64]) -> bool

Check whether a point x belongs to this convex set.

Trait Implementations§

impl Clone for ConvexSet

fn clone(&self) -> ConvexSet

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 Debug for ConvexSet

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for ConvexSet

impl RefUnwindSafe for ConvexSet

impl Send for ConvexSet

impl Sync for ConvexSet

impl Unpin for ConvexSet

impl UnsafeUnpin for ConvexSet

impl UnwindSafe for ConvexSet

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